azure.mgmt.msi.v2024_11_30.models module

class azure.mgmt.msi.v2024_11_30.models.CloudErrorBody(*, code: str | None = None, message: str | None = None, target: str | None = None, details: List[_models.CloudErrorBody] | None = None, **kwargs: Any)[source]

Bases: Model

An error response from the ManagedServiceIdentity service.

Variables:

  • code (str) – An identifier for the error.

  • message (str) – A message describing the error, intended to be suitable for display in a user interface.

  • target (str) – The target of the particular error. For example, the name of the property in error.

  • details (list[CloudErrorBody]) – A list of additional details about the error.

Keyword Arguments:

  • code (str) – An identifier for the error.

  • message (str) – A message describing the error, intended to be suitable for display in a user interface.

  • target (str) – The target of the particular error. For example, the name of the property in error.

  • details (list[CloudErrorBody]) – A list of additional details about the error.

class azure.mgmt.msi.v2024_11_30.models.CreatedByType(*values)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.msi.v2024_11_30.models.FederatedIdentityCredential(*, issuer: str | None = None, subject: str | None = None, audiences: List[str] | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Describes a federated identity credential.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • issuer (str) – The URL of the issuer to be trusted.

  • subject (str) – The identifier of the external identity.

  • audiences (list[str]) – The list of audiences that can appear in the issued token.

Keyword Arguments:

  • issuer (str) – The URL of the issuer to be trusted.

  • subject (str) – The identifier of the external identity.

  • audiences (list[str]) – The list of audiences that can appear in the issued token.

class azure.mgmt.msi.v2024_11_30.models.FederatedIdentityCredentialsListResult(*, value: List[_models.FederatedIdentityCredential] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Values returned by the List operation for federated identity credentials.

Variables:

  • value (list[FederatedIdentityCredential]) – The collection of federated identity credentials returned by the listing operation.

  • next_link (str) – The url to get the next page of results, if any.

Keyword Arguments:

  • value (list[FederatedIdentityCredential]) – The collection of federated identity credentials returned by the listing operation.

  • next_link (str) – The url to get the next page of results, if any.

class azure.mgmt.msi.v2024_11_30.models.Identity(*, location: str, tags: Dict[str, str] | None = None, isolation_scope: str | _models.IsolationScope | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Describes an identity resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • tenant_id (str) – The id of the tenant which the identity belongs to.

  • principal_id (str) – The id of the service principal object associated with the created identity.

  • client_id (str) – The id of the app associated with the identity. This is a random generated UUID by MSI.

  • isolation_scope (str or IsolationScope) – Enum to configure regional restrictions on identity assignment, as necessary. Known values are: “None” and “Regional”.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • isolation_scope (str or IsolationScope) – Enum to configure regional restrictions on identity assignment, as necessary. Known values are: “None” and “Regional”.

class azure.mgmt.msi.v2024_11_30.models.IdentityUpdate(*, location: str | None = None, tags: Dict[str, str] | None = None, isolation_scope: str | _models.IsolationScope | None = None, **kwargs: Any)[source]

Bases: Resource

Describes an identity resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • location (str) – The geo-location where the resource lives.

  • tags (dict[str, str]) – Resource tags.

  • tenant_id (str) – The id of the tenant which the identity belongs to.

  • principal_id (str) – The id of the service principal object associated with the created identity.

  • client_id (str) – The id of the app associated with the identity. This is a random generated UUID by MSI.

  • isolation_scope (str or IsolationScope) – Enum to configure regional restrictions on identity assignment, as necessary. Known values are: “None” and “Regional”.

Keyword Arguments:

  • location (str) – The geo-location where the resource lives.

  • tags (dict[str, str]) – Resource tags.

  • isolation_scope (str or IsolationScope) – Enum to configure regional restrictions on identity assignment, as necessary. Known values are: “None” and “Regional”.

class azure.mgmt.msi.v2024_11_30.models.IsolationScope(*values)[source]

Bases: str, Enum

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

NONE = 'None'
REGIONAL = 'Regional'
class azure.mgmt.msi.v2024_11_30.models.Operation(*, name: str | None = None, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]

Bases: Model

Operation supported by the Microsoft.ManagedIdentity REST API.

Variables:

  • name (str) – The name of the REST Operation. This is of the format {provider}/{resource}/{operation}.

  • display (OperationDisplay) – The object that describes the operation.

Keyword Arguments:

  • name (str) – The name of the REST Operation. This is of the format {provider}/{resource}/{operation}.

  • display (OperationDisplay) – The object that describes the operation.

class azure.mgmt.msi.v2024_11_30.models.OperationDisplay(*, provider: str | None = None, operation: str | None = None, resource: str | None = None, description: str | None = None, **kwargs: Any)[source]

Bases: Model

The object that describes the operation.

Variables:

  • provider (str) – Friendly name of the resource provider.

  • operation (str) – The type of operation. For example: read, write, delete.

  • resource (str) – The resource type on which the operation is performed.

  • description (str) – A description of the operation.

Keyword Arguments:

  • provider (str) – Friendly name of the resource provider.

  • operation (str) – The type of operation. For example: read, write, delete.

  • resource (str) – The resource type on which the operation is performed.

  • description (str) – A description of the operation.

class azure.mgmt.msi.v2024_11_30.models.OperationListResult(*, value: List[_models.Operation] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

A list of operations supported by Microsoft.ManagedIdentity Resource Provider.

Variables:

  • value (list[Operation]) – A list of operations supported by Microsoft.ManagedIdentity Resource Provider.

  • next_link (str) – The url to get the next page of results, if any.

Keyword Arguments:

  • value (list[Operation]) – A list of operations supported by Microsoft.ManagedIdentity Resource Provider.

  • next_link (str) – The url to get the next page of results, if any.

class azure.mgmt.msi.v2024_11_30.models.ProxyResource(**kwargs: Any)[source]

Bases: Resource

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.msi.v2024_11_30.models.Resource(**kwargs: Any)[source]

Bases: Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.msi.v2024_11_30.models.SystemAssignedIdentity(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Describes a system assigned identity resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • location (str) – The geo-location where the resource lives. Required.

  • tags (dict[str, str]) – Resource tags.

  • tenant_id (str) – The id of the tenant which the identity belongs to.

  • principal_id (str) – The id of the service principal object associated with the created identity.

  • client_id (str) – The id of the app associated with the identity. This is a random generated UUID by MSI.

  • client_secret_url (str) – The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials.

Keyword Arguments:

  • location (str) – The geo-location where the resource lives. Required.

  • tags (dict[str, str]) – Resource tags.

class azure.mgmt.msi.v2024_11_30.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)[source]

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.msi.v2024_11_30.models.TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Resource

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

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.msi.v2024_11_30.models.UserAssignedIdentitiesListResult(*, value: List[_models.Identity] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Values returned by the List operation.

Variables:

  • value (list[Identity]) – The collection of userAssignedIdentities returned by the listing operation.

  • next_link (str) – The url to get the next page of results, if any.

Keyword Arguments:

  • value (list[Identity]) – The collection of userAssignedIdentities returned by the listing operation.

  • next_link (str) – The url to get the next page of results, if any.