azure.mgmt.msi.v2021_09_30_preview.models module

class azure.mgmt.msi.v2021_09_30_preview.models.AssociatedResourcesListResult(**kwargs: Any)[source]

Bases: Model

Azure resources returned by the resource action to get a list of assigned resources.

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

Variables:
  • total_count (float) – Total number of Azure resources assigned to the identity.

  • value (list[AzureResource]) – The collection of Azure resources returned by the resource action to get a list of assigned resources.

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

class azure.mgmt.msi.v2021_09_30_preview.models.AzureResource(**kwargs: Any)[source]

Bases: Model

Describes an Azure resource that is attached to an identity.

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

Variables:
  • id (str) – The ID of this resource.

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

  • type (str) – The type of this resource.

  • resource_group (str) – The name of the resource group this resource belongs to.

  • subscription_id (str) – The ID of the subscription this resource belongs to.

  • subscription_display_name (str) – The name of the subscription this resource belongs to.

class azure.mgmt.msi.v2021_09_30_preview.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.v2021_09_30_preview.models.Identity(*, location: str, tags: Dict[str, str] | 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. Ex - /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”.

  • 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.

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

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

class azure.mgmt.msi.v2021_09_30_preview.models.IdentityUpdate(*, location: str | None = None, tags: Dict[str, str] | 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. Ex - /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”.

  • 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.

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

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

class azure.mgmt.msi.v2021_09_30_preview.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.v2021_09_30_preview.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.v2021_09_30_preview.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.v2021_09_30_preview.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. Ex - /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”.

class azure.mgmt.msi.v2021_09_30_preview.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. Ex - /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”.

class azure.mgmt.msi.v2021_09_30_preview.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. Ex - /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”.

  • 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.v2021_09_30_preview.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. Ex - /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”.

  • 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.v2021_09_30_preview.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.