azure.mgmt.healthdataaiservices.models module¶

class azure.mgmt.healthdataaiservices.models.ActionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.

INTERNAL = 'Internal'¶: Actions are for internal-only APIs.

class azure.mgmt.healthdataaiservices.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The kind of entity that created the resource.

APPLICATION = 'Application'¶: The entity was created by an application.

KEY = 'Key'¶: The entity was created by a key.

MANAGED_IDENTITY = 'ManagedIdentity'¶: The entity was created by a managed identity.

USER = 'User'¶: The entity was created by a user.

class azure.mgmt.healthdataaiservices.models.DeidPropertiesUpdate(*args: Any, **kwargs: Any)[source]¶

Bases: Model

The template for adding optional properties.

Variables:: public_network_access (str or PublicNetworkAccess) – Gets or sets allow or disallow public network access to resource. Known values are: “Enabled” and “Disabled”.

public_network_access: str | _models.PublicNetworkAccess | None¶

“Enabled” and “Disabled”.

Type:: Gets or sets allow or disallow public network access to resource. Known values are

class azure.mgmt.healthdataaiservices.models.DeidService(*args: Any, **kwargs: Any)[source]¶

Bases: TrackedResource

A HealthDataAIServicesProviderHub resource.

Readonly 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}. # pylint: disable=line-too-long
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.
properties (DeidServiceProperties) – The resource-specific properties for this resource.
identity (ManagedServiceIdentity) – The managed service identities assigned to this resource.

identity: _models.ManagedServiceIdentity | None¶: The managed service identities assigned to this resource.

properties: _models.DeidServiceProperties | None¶: The resource-specific properties for this resource.

class azure.mgmt.healthdataaiservices.models.DeidServiceProperties(*args: Any, **kwargs: Any)[source]¶

Bases: Model

Details of the HealthDataAIServices DeidService.

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

Variables:

provisioning_state (str or ProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Provisioning”, “Updating”, “Deleting”, and “Accepted”.
service_url (str) – Deid service url.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connections.
public_network_access (str or PublicNetworkAccess) – Gets or sets allow or disallow public network access to resource. Known values are: “Enabled” and “Disabled”.

private_endpoint_connections: List[_models.PrivateEndpointConnection] | None¶: List of private endpoint connections.

provisioning_state: str | _models.ProvisioningState | None¶

“Succeeded”, “Failed”, “Canceled”, “Provisioning”, “Updating”, “Deleting”, and “Accepted”.

Type:: The status of the last operation. Known values are

public_network_access: str | _models.PublicNetworkAccess | None¶

“Enabled” and “Disabled”.

Type:: Gets or sets allow or disallow public network access to resource. Known values are

service_url: str | None¶: Deid service url.

class azure.mgmt.healthdataaiservices.models.DeidUpdate(*args: Any, **kwargs: Any)[source]¶

Bases: Model

Patch request body for DeidService.

Variables:

tags (dict[str, str]) – Resource tags.
identity (ManagedServiceIdentityUpdate) – Updatable managed service identity.
properties (DeidPropertiesUpdate) – RP-specific properties.

identity: _models.ManagedServiceIdentityUpdate | None¶: Updatable managed service identity.

properties: _models.DeidPropertiesUpdate | None¶: RP-specific properties.

tags: Dict[str, str] | None¶: Resource tags.

class azure.mgmt.healthdataaiservices.models.ErrorAdditionalInfo(*args: Any, **kwargs: Any)[source]¶

Bases: Model

The resource management error additional info.

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

Variables:

type (str) – The additional info type.
info (any) – The additional info.

info: Any | None¶: The additional info.

type: str | None¶: The additional info type.

class azure.mgmt.healthdataaiservices.models.ErrorDetail(*args: Any, **kwargs: Any)[source]¶

Bases: Model

The error detail.

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

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

additional_info: List[_models.ErrorAdditionalInfo] | None¶: The error additional info.

code: str | None¶: The error code.

details: List[_models.ErrorDetail] | None¶: The error details.

message: str | None¶: The error message.

target: str | None¶: The error target.

class azure.mgmt.healthdataaiservices.models.ErrorResponse(*args: Any, **kwargs: Any)[source]¶

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Variables:: error (ErrorDetail) – The error object.

error: _models.ErrorDetail | None¶: The error object.

class azure.mgmt.healthdataaiservices.models.ManagedServiceIdentity(*args: Any, **kwargs: Any)[source]¶

Bases: Model

Managed service identity (system assigned and/or user assigned identities).

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

Variables:

principal_id (str) – The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type (str or ManagedServiceIdentityType) – The type of managed identity assigned to this resource. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.
user_assigned_identities (dict[str, UserAssignedIdentity]) – The identities assigned to this resource by the user.

principal_id: str | None¶: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

tenant_id: str | None¶: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

type: str | _models.ManagedServiceIdentityType¶

“None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

Type:: The type of managed identity assigned to this resource. Required. Known values are

user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None¶: The identities assigned to this resource by the user.

class azure.mgmt.healthdataaiservices.models.ManagedServiceIdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

NONE = 'None'¶: No managed identity.

SYSTEM_ASSIGNED = 'SystemAssigned'¶: System assigned managed identity.

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned,UserAssigned'¶: System and user assigned managed identity.

USER_ASSIGNED = 'UserAssigned'¶: User assigned managed identity.

class azure.mgmt.healthdataaiservices.models.ManagedServiceIdentityUpdate(*args: Any, **kwargs: Any)[source]¶

Bases: Model

The template for adding optional properties.

Variables:

type (str or ManagedServiceIdentityType) – The type of managed identity assigned to this resource. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.
user_assigned_identities (dict[str, UserAssignedIdentity]) – The identities assigned to this resource by the user.

type: str | _models.ManagedServiceIdentityType | None¶

“None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

Type:: The type of managed identity assigned to this resource. Known values are

user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None¶: The identities assigned to this resource by the user.

class azure.mgmt.healthdataaiservices.models.Operation(*args: Any, **kwargs: Any)[source]¶

Bases: Model

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

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

Variables:

name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.
is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.
display (OperationDisplay) – Localized display information for this particular operation.
origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.
action_type (str or ActionType) – Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

action_type: str | _models.ActionType | None¶: Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

display: _models.OperationDisplay | None¶: Localized display information for this particular operation.

is_data_action: bool | None¶: Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.

name: str | None¶: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.

origin: str | _models.Origin | None¶: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.

class azure.mgmt.healthdataaiservices.models.OperationDisplay(*args: Any, **kwargs: Any)[source]¶

Bases: Model

Localized display information for and operation.

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

Variables:

provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.
resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.
operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.

description: str | None¶: The short, localized friendly description of the operation; suitable for tool tips and detailed views.

operation: str | None¶: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.

provider: str | None¶: The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.

resource: str | None¶: The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.

class azure.mgmt.healthdataaiservices.models.Origin(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.

SYSTEM = 'system'¶: Indicates the operation is initiated by a system.

USER = 'user'¶: Indicates the operation is initiated by a user.

USER_SYSTEM = 'user,system'¶: Indicates the operation is initiated by a user or system.

class azure.mgmt.healthdataaiservices.models.PrivateEndpoint(*args: Any, **kwargs: Any)[source]¶

Bases: Model

The Private Endpoint resource.

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

Variables:: id (str) – The resource identifier for private endpoint.

id: str | None¶: The resource identifier for private endpoint.

class azure.mgmt.healthdataaiservices.models.PrivateEndpointConnection(*args: Any, **kwargs: Any)[source]¶

Bases: Resource

The private endpoint connection resource.

Readonly 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}. # pylint: disable=line-too-long
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.
properties (PrivateEndpointConnectionProperties) – The private endpoint connection properties.

properties: _models.PrivateEndpointConnectionProperties | None¶: The private endpoint connection properties.

class azure.mgmt.healthdataaiservices.models.PrivateEndpointConnectionProperties(*args: Any, **kwargs: Any)[source]¶

Bases: Model

Properties of the private endpoint connection.

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

Variables:

group_ids (list[str]) – The group ids for the private endpoint resource.
private_endpoint (PrivateEndpoint) – The private endpoint resource.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider. Required.
provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.

group_ids: List[str] | None¶: The group ids for the private endpoint resource.

private_endpoint: _models.PrivateEndpoint | None¶: The private endpoint resource.

private_link_service_connection_state: _models.PrivateLinkServiceConnectionState¶: A collection of information about the state of the connection between service consumer and provider. Required.

provisioning_state: str | _models.PrivateEndpointConnectionProvisioningState | None¶: The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.

class azure.mgmt.healthdataaiservices.models.PrivateEndpointConnectionProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The current provisioning state.

CREATING = 'Creating'¶: Connection is being created

DELETING = 'Deleting'¶: Connection is being deleted

FAILED = 'Failed'¶: Connection provisioning has failed

SUCCEEDED = 'Succeeded'¶: Connection has been provisioned

class azure.mgmt.healthdataaiservices.models.PrivateEndpointConnectionResource(*args: Any, **kwargs: Any)[source]¶

Bases: ProxyResource

Holder for private endpoint connections.

Readonly 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}. # pylint: disable=line-too-long
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.
properties (PrivateEndpointConnectionProperties) – The resource-specific properties for this resource.

properties: _models.PrivateEndpointConnectionProperties | None¶: The resource-specific properties for this resource.

class azure.mgmt.healthdataaiservices.models.PrivateEndpointServiceConnectionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The private endpoint connection status.

APPROVED = 'Approved'¶: Connection approved

PENDING = 'Pending'¶: Connectionaiting for approval or rejection

REJECTED = 'Rejected'¶: Connection Rejected

class azure.mgmt.healthdataaiservices.models.PrivateLinkResource(*args: Any, **kwargs: Any)[source]¶

Bases: ProxyResource

Private Links for DeidService resource.

Readonly 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}. # pylint: disable=line-too-long
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.
properties (PrivateLinkResourceProperties) – The resource-specific properties for this resource.

properties: _models.PrivateLinkResourceProperties | None¶: The resource-specific properties for this resource.

class azure.mgmt.healthdataaiservices.models.PrivateLinkResourceProperties(*args: Any, **kwargs: Any)[source]¶

Bases: Model

Properties of a private link resource.

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

Variables:

group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource private link DNS zone name.

group_id: str | None¶: The private link resource group id.

required_members: List[str] | None¶: The private link resource required member names.

required_zone_names: List[str] | None¶: The private link resource private link DNS zone name.

class azure.mgmt.healthdataaiservices.models.PrivateLinkServiceConnectionState(*args: Any, **kwargs: Any)[source]¶

Bases: Model

A collection of information about the state of the connection between service consumer and provider.

Variables:

status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

actions_required: str | None¶: A message indicating if changes on the service provider require any updates on the consumer.

description: str | None¶: The reason for approval/rejection of the connection.

status: str | _models.PrivateEndpointServiceConnectionStatus | None¶: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.

class azure.mgmt.healthdataaiservices.models.ProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The status of the current operation.

ACCEPTED = 'Accepted'¶: The resource provisioning request has been accepted.

CANCELED = 'Canceled'¶: Resource creation was canceled.

DELETING = 'Deleting'¶: The resource is being deleted.

FAILED = 'Failed'¶: Resource creation failed.

PROVISIONING = 'Provisioning'¶: The resource is being provisioned.

SUCCEEDED = 'Succeeded'¶: Resource has been created.

UPDATING = 'Updating'¶: The resource is being updated.

class azure.mgmt.healthdataaiservices.models.ProxyResource(*args: Any, **kwargs: Any)[source]¶

Bases: Resource

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

Readonly 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}. # pylint: disable=line-too-long
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.healthdataaiservices.models.PublicNetworkAccess(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

State of the public network access.

DISABLED = 'Disabled'¶: The public network access is disabled

ENABLED = 'Enabled'¶: The public network access is enabled

class azure.mgmt.healthdataaiservices.models.Resource(*args: Any, **kwargs: Any)[source]¶

Bases: Model

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

Readonly 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}. # pylint: disable=line-too-long
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.

id: str | None¶: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

name: str | None¶: The name of the resource.

system_data: _models.SystemData | None¶: Azure Resource Manager metadata containing createdBy and modifiedBy information.

type: str | None¶: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.healthdataaiservices.models.SystemData(*args: Any, **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).

created_at: datetime | None¶: The timestamp of resource creation (UTC).

created_by: str | None¶: The identity that created the resource.

created_by_type: str | _models.CreatedByType | None¶

“User”, “Application”, “ManagedIdentity”, and “Key”.

Type:: The type of identity that created the resource. Known values are

last_modified_at: datetime | None¶: The timestamp of resource last modification (UTC).

last_modified_by: str | None¶: The identity that last modified the resource.

last_modified_by_type: str | _models.CreatedByType | None¶

“User”, “Application”, “ManagedIdentity”, and “Key”.

Type:: The type of identity that last modified the resource. Known values are

class azure.mgmt.healthdataaiservices.models.TrackedResource(*args: Any, **kwargs: Any)[source]¶

Bases: Resource

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

Readonly 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}. # pylint: disable=line-too-long
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.

location: str¶: The geo-location where the resource lives. Required.

tags: Dict[str, str] | None¶: Resource tags.

class azure.mgmt.healthdataaiservices.models.UserAssignedIdentity(*args: Any, **kwargs: Any)[source]¶

Bases: Model

User assigned identity properties.

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

Variables:

principal_id (str) – The principal ID of the assigned identity.
client_id (str) – The client ID of the assigned identity.

client_id: str | None¶: The client ID of the assigned identity.

principal_id: str | None¶: The principal ID of the assigned identity.