entitlements

Creates, updates, deletes, gets or lists an entitlements resource.

Overview

Name	entitlements
Type	Resource
Id	confluent.partner.entitlements

Fields

The following fields are returned by SELECT queries:

get_partner_v2_entitlement

Entitlement.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
name	string	The name of the entitlement (example: Acme Prod Entitlement)
external_id	string	The unique external ID of the entitlement (this should be unique to customer) (example: 1111-2222-3333-4444)
plan_id	string	The plan ID the entitlement (example: confluent-cloud-payg-prod)
product_id	string	The product ID of the entitlement (example: confluent-cloud-kafka-service-azure)
resource_id	string	The resource ID of the entitlement (example: 1111-2222-3333-4444)
usage_reporting_id	string	The usage reporting ID of the entitlement (if usage reporting uses a different ID, otherwise, same as external_id) (example: 1111-2222-3333-4444)
api_version	string	APIVersion defines the schema version of this representation of a resource. (partner/v2)
kind	string	Kind defines the object this REST resource represents. (Entitlement)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
organization	object	The organization associated with this object.

list_partner_v2_entitlements

Entitlement.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
name	string	The name of the entitlement (example: Acme Prod Entitlement)
external_id	string	The unique external ID of the entitlement (this should be unique to customer) (example: 1111-2222-3333-4444)
plan_id	string	The plan ID the entitlement (example: confluent-cloud-payg-prod)
product_id	string	The product ID of the entitlement (example: confluent-cloud-kafka-service-azure)
resource_id	string	The resource ID of the entitlement (example: 1111-2222-3333-4444)
usage_reporting_id	string	The usage reporting ID of the entitlement (if usage reporting uses a different ID, otherwise, same as external_id) (example: 1111-2222-3333-4444)
api_version	string	APIVersion defines the schema version of this representation of a resource. (partner/v2)
kind	string	Kind defines the object this REST resource represents. (Entitlement)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
organization	object	The organization associated with this object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_partner_v2_entitlement	select	id	organization.id	Make a request to read an entitlement.
list_partner_v2_entitlements	select		organization.id, page_size, page_token	Retrieve a sorted, filtered, paginated list of all entitlements.
create_partner_v2_entitlement	insert	external_id, name, plan_id, product_id		Make a request to create an entitlement.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The unique identifier for the entitlement.
organization.id	string	Filter the results by exact match for organization.id. (example: b3a17773-05cc-4431-9560-433fb4613da8)
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_partner_v2_entitlement

Make a request to read an entitlement.

SELECT
id,
name,
external_id,
plan_id,
product_id,
resource_id,
usage_reporting_id,
api_version,
kind,
metadata,
organization
FROM confluent.partner.entitlements
WHERE id = '{{ id }}' -- required
AND organization.id = '{{ organization.id }}'
;

list_partner_v2_entitlements

Retrieve a sorted, filtered, paginated list of all entitlements.

SELECT
id,
name,
external_id,
plan_id,
product_id,
resource_id,
usage_reporting_id,
api_version,
kind,
metadata,
organization
FROM confluent.partner.entitlements
WHERE organization.id = '{{ organization.id }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_partner_v2_entitlement

Make a request to create an entitlement.

INSERT INTO confluent.partner.entitlements (
external_id,
name,
plan_id,
product_id,
usage_reporting_id,
resource_id,
organization
)
SELECT 
'{{ external_id }}' /* required */,
'{{ name }}' /* required */,
'{{ plan_id }}' /* required */,
'{{ product_id }}' /* required */,
'{{ usage_reporting_id }}',
'{{ resource_id }}',
'{{ organization }}'
RETURNING
id,
name,
external_id,
plan_id,
product_id,
resource_id,
usage_reporting_id,
api_version,
kind,
metadata,
organization
;

Manifest

# Description fields are for documentation purposes
- name: entitlements
props:
  - name: external_id
    value: "{{ external_id }}"
    description: |
      The unique external ID of the entitlement (this should be unique to customer)
  - name: name
    value: "{{ name }}"
    description: |
      The name of the entitlement
  - name: plan_id
    value: "{{ plan_id }}"
    description: |
      The plan ID the entitlement
  - name: product_id
    value: "{{ product_id }}"
    description: |
      The product ID of the entitlement
  - name: usage_reporting_id
    value: "{{ usage_reporting_id }}"
    description: |
      The usage reporting ID of the entitlement (if usage reporting uses
      a different ID, otherwise, same as external_id)
  - name: resource_id
    value: "{{ resource_id }}"
    description: |
      The resource ID of the entitlement
  - name: organization
    description: |
      The organization associated with this object.
    value:
      id: "{{ id }}"
      environment: "{{ environment }}"
      related: "{{ related }}"
      resource_name: "{{ resource_name }}"
      api_version: "{{ api_version }}"
      kind: "{{ kind }}"