kafka_schema_registry_acls

Creates, updates, deletes, gets or lists a kafka_schema_registry_acls resource.

Overview

Name	kafka_schema_registry_acls
Type	Resource
Id	ovh.public_cloud_analytics.kafka_schema_registry_acls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the Schema Registry ACL entry
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
permission	string	Permission level granted by this ACL entry (READ, READ_WRITE, WRITE)
resource	string	Schema Registry resource pattern this ACL entry applies to. Supports wildcards (*).
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)
username	string	Username this ACL entry applies to

list

A Schema Registry ACL entry on a managed Kafka service

Name	Datatype	Description
id	string (uuid)	Unique identifier of the Schema Registry ACL entry
checksum	string	Hash of the resource used for concurrency control
created_at	string (date-time)	Date at which the resource was created (wire: createdAt)
permission	string	Permission level granted by this ACL entry (READ, READ_WRITE, WRITE)
resource	string	Schema Registry resource pattern this ACL entry applies to. Supports wildcards (*).
updated_at	string (date-time)	Date of the last update to the resource (wire: updatedAt)
username	string	Username this ACL entry applies to

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	schema_registry_acl_id, service_id, project_id		Returns the user, the resource pattern and the permission of the ACL entry. (Beta version)
list	select	service_id, project_id	x_pagination_cursor, x_pagination_size	Returns the Schema Registry ACL entries of the service, each granting a user a permission on a resource pattern. (Beta version)
create	insert	service_id, project_id, permission, resource, username		Grants a user a permission on the Schema Registry resources matching a pattern. Use * to match all subjects. (Beta version)
delete	delete	schema_registry_acl_id, service_id, project_id		Deletes the ACL entry and revokes the permission it granted. (Beta version)

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
schema_registry_acl_id	string (uuid)	Schema registry acl ID (wire: schemaRegistryAclId)
service_id	string (uuid)	Service ID (wire: serviceId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the user, the resource pattern and the permission of the ACL entry. (Beta version)

SELECT
id,
checksum,
created_at,
permission,
resource,
updated_at,
username
FROM ovh.public_cloud_analytics.kafka_schema_registry_acls
WHERE schema_registry_acl_id = '{{ schema_registry_acl_id }}' -- required
AND service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the Schema Registry ACL entries of the service, each granting a user a permission on a resource pattern. (Beta version)

SELECT
id,
checksum,
created_at,
permission,
resource,
updated_at,
username
FROM ovh.public_cloud_analytics.kafka_schema_registry_acls
WHERE service_id = '{{ service_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

INSERT examples

create

Grants a user a permission on the Schema Registry resources matching a pattern. Use * to match all subjects. (Beta version)

INSERT INTO ovh.public_cloud_analytics.kafka_schema_registry_acls (
permission,
resource,
username,
service_id,
project_id
)
SELECT 
'{{ permission }}' /* required */,
'{{ resource }}' /* required */,
'{{ username }}' /* required */,
'{{ service_id }}',
'{{ project_id }}'
RETURNING
id,
checksum,
created_at,
permission,
resource,
updated_at,
username
;

Manifest

# Description fields are for documentation purposes
- name: kafka_schema_registry_acls
props:
  - name: service_id
    value: "{{ service_id }}"
    description: Required parameter for the kafka_schema_registry_acls resource.
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the kafka_schema_registry_acls resource.
  - name: permission
    value: "{{ permission }}"
    description: |
      Permission level to grant on the Schema Registry resource
    valid_values: ['READ', 'READ_WRITE', 'WRITE']
  - name: resource
    value: "{{ resource }}"
    description: |
      Schema Registry resource pattern this ACL applies to. Use * to match all subjects.
  - name: username
    value: "{{ username }}"
    description: |
      Username to grant access to

DELETE examples

delete

Deletes the ACL entry and revokes the permission it granted. (Beta version)

DELETE FROM ovh.public_cloud_analytics.kafka_schema_registry_acls
WHERE schema_registry_acl_id = '{{ schema_registry_acl_id }}' --required
AND service_id = '{{ service_id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;