UserAssignedIdentitiesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ManagedServiceIdentityClient's

<xref:user_assigned_identities> attribute.

Inheritance

builtins.object

UserAssignedIdentitiesOperations

Constructor

UserAssignedIdentitiesOperations(*args, **kwargs)

Methods

create_or_update	Create or update an identity in the specified subscription and resource group.
delete	Deletes the identity.
get	Gets the identity.
list_by_resource_group	Lists all the userAssignedIdentities available under the specified ResourceGroup.
list_by_subscription	Lists all the userAssignedIdentities available under the specified subscription.
update	Update an identity in the specified subscription and resource group.

create_or_update

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

create_or_update(resource_group_name: str, resource_name: str, parameters: azure.mgmt.msi.v2018_11_30.models._models_py3.Identity, **kwargs: Any) -> azure.mgmt.msi.v2018_11_30.models._models_py3.Identity

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the identity belongs.

resource_name

str

Required

The name of the identity resource.

parameters

Identity

Required

Parameters to create or update the identity.

cls

callable

A custom type or function that will be passed the direct response

Returns

Identity, or the result of cls(response)

Return type

Identity

Exceptions

HttpResponseError

delete

Deletes the identity.

delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the identity belongs.

resource_name

str

Required

The name of the identity resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Gets the identity.

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.msi.v2018_11_30.models._models_py3.Identity

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the identity belongs.

resource_name

str

Required

The name of the identity resource.

cls

callable

A custom type or function that will be passed the direct response

Returns

Identity, or the result of cls(response)

Return type

Identity

Exceptions

HttpResponseError

list_by_resource_group

Lists all the userAssignedIdentities available under the specified ResourceGroup.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.msi.v2018_11_30.models._models_py3.UserAssignedIdentitiesListResult]

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the identity belongs.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UserAssignedIdentitiesListResult or the result of cls(response)

Return type

ItemPaged[UserAssignedIdentitiesListResult]

Exceptions

HttpResponseError

list_by_subscription

Lists all the userAssignedIdentities available under the specified subscription.

list_by_subscription(**kwargs: Any) -> Iterable[azure.mgmt.msi.v2018_11_30.models._models_py3.UserAssignedIdentitiesListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UserAssignedIdentitiesListResult or the result of cls(response)

Return type

ItemPaged[UserAssignedIdentitiesListResult]

Exceptions

HttpResponseError

update

Update an identity in the specified subscription and resource group.

update(resource_group_name: str, resource_name: str, parameters: azure.mgmt.msi.v2018_11_30.models._models_py3.IdentityUpdate, **kwargs: Any) -> azure.mgmt.msi.v2018_11_30.models._models_py3.Identity

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the identity belongs.

resource_name

str

Required

The name of the identity resource.

parameters

IdentityUpdate

Required

Parameters to update the identity.

cls

callable

A custom type or function that will be passed the direct response

Returns

Identity, or the result of cls(response)

Return type

Identity

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.msi.v2018_11_30.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\msi\\v2018_11_30\\models\\__init__.py'>