Share via

UserAssignedIdentities interface

  • Reference
Package:
@azure/arm-msi

Interface representing a UserAssignedIdentities.

Methods

createOrUpdate(string, string, Identity, UserAssignedIdentitiesCreateOrUpdateOptionalParams)

Create or update an identity in the specified subscription and resource group.
delete(string, string, UserAssignedIdentitiesDeleteOptionalParams)

Deletes the identity.
get(string, string, UserAssignedIdentitiesGetOptionalParams)

Gets the identity.
listByResourceGroup(string, UserAssignedIdentitiesListByResourceGroupOptionalParams)

Lists all the userAssignedIdentities available under the specified ResourceGroup.
listBySubscription(UserAssignedIdentitiesListBySubscriptionOptionalParams)

Lists all the userAssignedIdentities available under the specified subscription.
update(string, string, IdentityUpdate, UserAssignedIdentitiesUpdateOptionalParams)

Update an identity in the specified subscription and resource group.

Method Details

createOrUpdate(string, string, Identity, UserAssignedIdentitiesCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, resourceName: string, parameters: Identity, options?: UserAssignedIdentitiesCreateOrUpdateOptionalParams): Promise<Identity>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the identity resource.

parameters
Identity

Parameters to create or update the identity

options
UserAssignedIdentitiesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Identity>

delete(string, string, UserAssignedIdentitiesDeleteOptionalParams)

Deletes the identity.

function delete(resourceGroupName: string, resourceName: string, options?: UserAssignedIdentitiesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the identity resource.

options
UserAssignedIdentitiesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, UserAssignedIdentitiesGetOptionalParams)

Gets the identity.

function get(resourceGroupName: string, resourceName: string, options?: UserAssignedIdentitiesGetOptionalParams): Promise<Identity>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the identity resource.

options
UserAssignedIdentitiesGetOptionalParams

The options parameters.

Returns

Promise<Identity>

listByResourceGroup(string, UserAssignedIdentitiesListByResourceGroupOptionalParams)

Lists all the userAssignedIdentities available under the specified ResourceGroup.

function listByResourceGroup(resourceGroupName: string, options?: UserAssignedIdentitiesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Identity, Identity[], PageSettings>

Parameters

resourceGroupName

string

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

options
UserAssignedIdentitiesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Identity, Identity[], PageSettings>

listBySubscription(UserAssignedIdentitiesListBySubscriptionOptionalParams)

Lists all the userAssignedIdentities available under the specified subscription.

function listBySubscription(options?: UserAssignedIdentitiesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Identity, Identity[], PageSettings>

Parameters

options
UserAssignedIdentitiesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Identity, Identity[], PageSettings>

update(string, string, IdentityUpdate, UserAssignedIdentitiesUpdateOptionalParams)

Update an identity in the specified subscription and resource group.

function update(resourceGroupName: string, resourceName: string, parameters: IdentityUpdate, options?: UserAssignedIdentitiesUpdateOptionalParams): Promise<Identity>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the identity resource.

parameters
IdentityUpdate

Parameters to update the identity

options
UserAssignedIdentitiesUpdateOptionalParams

The options parameters.

Returns

Promise<Identity>