user_assigned_identities

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

Overview

Name	user_assigned_identities
Type	Resource
Id	azure.managed_identity.user_assigned_identities

Fields

The following fields are returned by SELECT queries:

get

OK. The requested identity.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The properties associated with the identity. (title: User Assigned Identity properties.)
tags	object	Resource tags.

list_by_resource_group

OK. The list of userAssignedIdentities was retrieved and returned successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The properties associated with the identity. (title: User Assigned Identity properties.)
tags	object	Resource tags.

list_by_subscription

OK. The list of userAssignedIdentities was retrieved and returned successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The properties associated with the identity. (title: User Assigned Identity properties.)
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName		Gets the identity.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the userAssignedIdentities available under the specified ResourceGroup.
list_by_subscription	select	subscriptionId		Lists all the userAssignedIdentities available under the specified subscription.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName		Create or update an identity in the specified subscription and resource group.
update	update	subscriptionId, resourceGroupName, resourceName		Update an identity in the specified subscription and resource group.
delete	delete	subscriptionId, resourceGroupName, resourceName		Deletes the identity.

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
resourceGroupName	string	The name of the Resource Group to which the identity belongs.
resourceName	string	The name of the identity resource.
subscriptionId	string	The Id of the Subscription to which the identity belongs.

SELECT examples

get

Gets the identity.

SELECT
location,
properties,
tags
FROM azure.managed_identity.user_assigned_identities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

Lists all the userAssignedIdentities available under the specified ResourceGroup.

SELECT
location,
properties,
tags
FROM azure.managed_identity.user_assigned_identities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all the userAssignedIdentities available under the specified subscription.

SELECT
location,
properties,
tags
FROM azure.managed_identity.user_assigned_identities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update an identity in the specified subscription and resource group.

INSERT INTO azure.managed_identity.user_assigned_identities (
data__tags,
data__location,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: user_assigned_identities
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the user_assigned_identities resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the user_assigned_identities resource.
    - name: resourceName
      value: string
      description: Required parameter for the user_assigned_identities resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update an identity in the specified subscription and resource group.

UPDATE azure.managed_identity.user_assigned_identities
SET 
data__location = '{{ location }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes the identity.

DELETE FROM azure.managed_identity.user_assigned_identities
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;