@azure/arm-msi package

Interfaces

AssignmentRestrictions

Configuration to restrict identity assignment to specific resource providers or resource types.

ClaimsMatchingExpression

Object for defining the allowed identifiers of external identities. Introduced in 2025-01-31-preview.

CloudError

An error response from the ManagedServiceIdentity service.

CloudErrorBody

An error response from the ManagedServiceIdentity service.

ExtensionResource

The base extension resource.

FederatedIdentityCredential

Describes a federated identity credential.

FederatedIdentityCredentialProperties

The properties associated with a federated identity credential.

FederatedIdentityCredentialsCreateOrUpdateOptionalParams

Optional parameters.

FederatedIdentityCredentialsDeleteOptionalParams

Optional parameters.

FederatedIdentityCredentialsGetOptionalParams

Optional parameters.

FederatedIdentityCredentialsListOptionalParams

Optional parameters.

FederatedIdentityCredentialsOperations

Interface representing a FederatedIdentityCredentials operations.

Identity

Describes an identity resource.

IdentityUpdate

Describes an identity resource.

ManagedServiceIdentityClientOptionalParams

Optional parameters for the client.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for and operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

SystemAssignedIdentitiesGetByScopeOptionalParams

Optional parameters.

SystemAssignedIdentitiesOperations

Interface representing a SystemAssignedIdentities operations.

SystemAssignedIdentity

Describes a system assigned identity resource.

SystemAssignedIdentityProperties

The properties associated with the system assigned identity.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

UserAssignedIdentitiesCreateOrUpdateOptionalParams

Optional parameters.

UserAssignedIdentitiesDeleteOptionalParams

Optional parameters.

UserAssignedIdentitiesGetOptionalParams

Optional parameters.

UserAssignedIdentitiesListByResourceGroupOptionalParams

Optional parameters.

UserAssignedIdentitiesListBySubscriptionOptionalParams

Optional parameters.

UserAssignedIdentitiesOperations

Interface representing a UserAssignedIdentities operations.

UserAssignedIdentitiesUpdateOptionalParams

Optional parameters.

UserAssignedIdentityProperties

The properties associated with the user assigned identity.

Type Aliases

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

IsolationScope

Enum to configure regional restrictions on identity assignment, as necessary.
KnownIsolationScope can be used interchangeably with IsolationScope, this enum contains the known values that the service supports.

Known values supported by the service

None
Regional

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownCreatedByType

The kind of entity that created the resource.

KnownIsolationScope

Enum to configure regional restrictions on identity assignment, as necessary.

KnownVersions

The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type