trusted_access_role_bindings

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

Overview

Name	trusted_access_role_bindings
Type	Resource
Id	azure.container_service.trusted_access_role_bindings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	The current provisioning state of trusted access role binding. Known values are: "Canceled", "Deleting", "Failed", "Succeeded", and "Updating". (Canceled, Deleting, Failed, Succeeded, Updating)
roles	array	A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'. Required.
sourceResourceId	string	The ARM resource ID of source resource that trusted access is configured for. Required.
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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
provisioningState	string	The current provisioning state of trusted access role binding. Known values are: "Canceled", "Deleting", "Failed", "Succeeded", and "Updating". (Canceled, Deleting, Failed, Succeeded, Updating)
roles	array	A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'. Required.
sourceResourceId	string	The ARM resource ID of source resource that trusted access is configured for. Required.
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, resource_name, trusted_access_role_binding_name, subscription_id		Get a trusted access role binding.
list	select	resource_group_name, resource_name, subscription_id		List trusted access role bindings.
create_or_update	insert	resource_group_name, resource_name, trusted_access_role_binding_name, subscription_id, properties		Create or update a trusted access role binding.
create_or_update	replace	resource_group_name, resource_name, trusted_access_role_binding_name, subscription_id, properties		Create or update a trusted access role binding.
delete	delete	resource_group_name, resource_name, trusted_access_role_binding_name, subscription_id		Delete a trusted access role binding.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the managed cluster resource. Required.
subscription_id	string
trusted_access_role_binding_name	string	The name of trusted access role binding. Required.

SELECT examples

get

Get a trusted access role binding.

SELECT
id,
name,
provisioningState,
roles,
sourceResourceId,
systemData,
type
FROM azure.container_service.trusted_access_role_bindings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND trusted_access_role_binding_name = '{{ trusted_access_role_binding_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List trusted access role bindings.

SELECT
id,
name,
provisioningState,
roles,
sourceResourceId,
systemData,
type
FROM azure.container_service.trusted_access_role_bindings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a trusted access role binding.

INSERT INTO azure.container_service.trusted_access_role_bindings (
properties,
resource_group_name,
resource_name,
trusted_access_role_binding_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ trusted_access_role_binding_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: trusted_access_role_bindings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the trusted_access_role_bindings resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the trusted_access_role_bindings resource.
  - name: trusted_access_role_binding_name
    value: "{{ trusted_access_role_binding_name }}"
    description: Required parameter for the trusted_access_role_bindings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the trusted_access_role_bindings resource.
  - name: properties
    description: |
      Properties for trusted access role binding. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      sourceResourceId: "{{ sourceResourceId }}"
      roles:
        - "{{ roles }}"

REPLACE examples

create_or_update

Create or update a trusted access role binding.

REPLACE azure.container_service.trusted_access_role_bindings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND trusted_access_role_binding_name = '{{ trusted_access_role_binding_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a trusted access role binding.

DELETE FROM azure.container_service.trusted_access_role_bindings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND trusted_access_role_binding_name = '{{ trusted_access_role_binding_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;