roles

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

Overview

Name	roles
Type	Resource
Id	azure.cosmosdb_for_postgresql.roles

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
externalIdentity	object
password	string	The password of the cluster role. If an identity is used, password will not be required.
provisioningState	string	Provisioning state of the role. Known values are: "Succeeded", "Canceled", "InProgress", and "Failed".
roleType	string	Known values are: "user" and "admin".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_cluster

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
externalIdentity	object
password	string	The password of the cluster role. If an identity is used, password will not be required.
provisioningState	string	Provisioning state of the role. Known values are: "Succeeded", "Canceled", "InProgress", and "Failed".
roleType	string	Known values are: "user" and "admin".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, role_name, subscription_id		Gets information about a cluster role.
list_by_cluster	select	resource_group_name, cluster_name, subscription_id		List all the roles in a given cluster.
create	insert	resource_group_name, cluster_name, role_name, subscription_id		Creates a new role or updates an existing role.
delete	delete	resource_group_name, cluster_name, role_name, subscription_id		Deletes a cluster role.

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
cluster_name	string	The name of the cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
role_name	string	The name of the cluster role. Required.
subscription_id	string

SELECT examples

get

Gets information about a cluster role.

SELECT
id,
name,
externalIdentity,
password,
provisioningState,
roleType,
systemData,
type
FROM azure.cosmosdb_for_postgresql.roles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND role_name = '{{ role_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_cluster

List all the roles in a given cluster.

SELECT
id,
name,
externalIdentity,
password,
provisioningState,
roleType,
systemData,
type
FROM azure.cosmosdb_for_postgresql.roles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a new role or updates an existing role.

INSERT INTO azure.cosmosdb_for_postgresql.roles (
properties,
resource_group_name,
cluster_name,
role_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ role_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: roles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the roles resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the roles resource.
  - name: role_name
    value: "{{ role_name }}"
    description: Required parameter for the roles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the roles resource.
  - name: properties
    value:
      roleType: "{{ roleType }}"
      password: "{{ password }}"
      externalIdentity:
        objectId: "{{ objectId }}"
        principalType: "{{ principalType }}"
        tenantId: "{{ tenantId }}"

DELETE examples

delete

Deletes a cluster role.

DELETE FROM azure.cosmosdb_for_postgresql.roles
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND role_name = '{{ role_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;