roles

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

Overview

Name	roles
Type	Resource
Id	azure.postgresql_hsc.roles

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of a role.

list_by_cluster

Name	Datatype	Description
properties	object	The properties of a role.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, roleName		Gets information about a cluster role.
list_by_cluster	select	subscriptionId, resourceGroupName, clusterName		List all the roles in a given cluster.
create	insert	subscriptionId, resourceGroupName, clusterName, roleName, data__properties		Creates a new role or updates an existing role.
delete	delete	subscriptionId, resourceGroupName, clusterName, roleName		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
clusterName	string	The name of the cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
roleName	string	The name of the cluster role.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about a cluster role.

SELECT
properties
FROM azure.postgresql_hsc.roles
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND roleName = '{{ roleName }}' -- required
;

list_by_cluster

List all the roles in a given cluster.

SELECT
properties
FROM azure.postgresql_hsc.roles
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

INSERT examples

create

Creates a new role or updates an existing role.

INSERT INTO azure.postgresql_hsc.roles (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
roleName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ roleName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: roles
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the roles resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the roles resource.
    - name: clusterName
      value: string
      description: Required parameter for the roles resource.
    - name: roleName
      value: string
      description: Required parameter for the roles resource.
    - name: properties
      value: object
      description: |
        The properties of a role.

DELETE examples

delete

Deletes a cluster role.

DELETE FROM azure.postgresql_hsc.roles
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND roleName = '{{ roleName }}' --required
;