identity_bindings

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

Overview

Name	identity_bindings
Type	Resource
Id	azure.container_service.identity_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.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
managedIdentity	object	Managed identity profile for the identity binding. Required.
oidcIssuer	object	The OIDC issuer URL of the IdentityBinding.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
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_managed_cluster

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.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
managedIdentity	object	Managed identity profile for the identity binding. Required.
oidcIssuer	object	The OIDC issuer URL of the IdentityBinding.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
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, identity_binding_name, subscription_id		Gets the specified Identity Binding.
list_by_managed_cluster	select	resource_group_name, resource_name, subscription_id		Gets a list of identity bindings in the specified managed cluster.
create_or_update	insert	resource_group_name, resource_name, identity_binding_name, subscription_id		Creates or updates an identity binding in the specified managed cluster.
create_or_update	replace	resource_group_name, resource_name, identity_binding_name, subscription_id		Creates or updates an identity binding in the specified managed cluster.
delete	delete	resource_group_name, resource_name, identity_binding_name, subscription_id		Deletes an identity binding in the specified managed cluster.

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
identity_binding_name	string	The name of the identity binding. Required.
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

SELECT examples

get

Gets the specified Identity Binding.

SELECT
id,
name,
eTag,
managedIdentity,
oidcIssuer,
provisioningState,
systemData,
type
FROM azure.container_service.identity_bindings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND identity_binding_name = '{{ identity_binding_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_managed_cluster

Gets a list of identity bindings in the specified managed cluster.

SELECT
id,
name,
eTag,
managedIdentity,
oidcIssuer,
provisioningState,
systemData,
type
FROM azure.container_service.identity_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

Creates or updates an identity binding in the specified managed cluster.

INSERT INTO azure.container_service.identity_bindings (
properties,
resource_group_name,
resource_name,
identity_binding_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ identity_binding_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: identity_bindings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the identity_bindings resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the identity_bindings resource.
  - name: identity_binding_name
    value: "{{ identity_binding_name }}"
    description: Required parameter for the identity_bindings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the identity_bindings resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      managedIdentity:
        resourceId: "{{ resourceId }}"
        objectId: "{{ objectId }}"
        clientId: "{{ clientId }}"
        tenantId: "{{ tenantId }}"
      oidcIssuer:
        oidcIssuerUrl: "{{ oidcIssuerUrl }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates an identity binding in the specified managed cluster.

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

DELETE examples

delete

Deletes an identity binding in the specified managed cluster.

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