azure.mgmt.healthcareapis.models module

class azure.mgmt.healthcareapis.models.ActionType(value)[source]

Bases: str, enum.Enum

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

INTERNAL = 'Internal'
class azure.mgmt.healthcareapis.models.CheckNameAvailabilityParameters(*, name: str, type: str, **kwargs)[source]

Bases: msrest.serialization.Model

Input values.

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

Parameters

  • name (str) – Required. The name of the service instance to check.

  • type (str) – Required. The fully qualified resource type which includes provider namespace.

class azure.mgmt.healthcareapis.models.CreatedByType(value)[source]

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.healthcareapis.models.DicomService(*, etag: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, provisioning_state: Optional[str] = None, authentication_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.DicomServiceAuthenticationConfiguration] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.TaggedResource

The description of Dicom Service.

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

Variables

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

  • service_url (str) – The url of the Dicom Services.

Parameters

  • etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

  • location (str) – The resource location.

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

  • provisioning_state (str or ProvisioningState) – The provisioning state. Possible values include: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, “SystemMaintenance”.

  • authentication_configuration (DicomServiceAuthenticationConfiguration) – Dicom Service authentication configuration.

class azure.mgmt.healthcareapis.models.DicomServiceAuthenticationConfiguration(**kwargs)[source]

Bases: msrest.serialization.Model

Authentication configuration information.

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

Variables

  • authority (str) – The authority url for the service.

  • audiences (list[str]) – The audiences for the service.

class azure.mgmt.healthcareapis.models.DicomServiceCollection(*, next_link: Optional[str] = None, value: Optional[List[azure.mgmt.healthcareapis.models._models_py3.DicomService]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The collection of Dicom Services.

Parameters

  • next_link (str) – The link used to get the next page of Dicom Services.

  • value (list[DicomService]) – The list of Dicom Services.

class azure.mgmt.healthcareapis.models.DicomServicePatchResource(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.ResourceTags

Dicom Service patch properties.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.

class azure.mgmt.healthcareapis.models.Error(*, error: Optional[azure.mgmt.healthcareapis.models._models_py3.ErrorDetailsInternal] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Error details.

Parameters

error (ErrorDetailsInternal) – Error details.

class azure.mgmt.healthcareapis.models.ErrorDetails(*, error: Optional[azure.mgmt.healthcareapis.models._models_py3.ErrorDetailsInternal] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Error details.

Parameters

error (ErrorDetailsInternal) – Error details.

class azure.mgmt.healthcareapis.models.ErrorDetailsInternal(**kwargs)[source]

Bases: msrest.serialization.Model

Error details.

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 target of the particular error.

class azure.mgmt.healthcareapis.models.FhirService(*, identity: Optional[azure.mgmt.healthcareapis.models._models_py3.ServiceManagedIdentityIdentity] = None, etag: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, kind: Optional[str] = None, provisioning_state: Optional[str] = None, access_policies: Optional[List[azure.mgmt.healthcareapis.models._models_py3.FhirServiceAccessPolicyEntry]] = None, acr_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.FhirServiceAcrConfiguration] = None, authentication_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.FhirServiceAuthenticationConfiguration] = None, cors_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.FhirServiceCorsConfiguration] = None, export_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.FhirServiceExportConfiguration] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.TaggedResource, azure.mgmt.healthcareapis.models._models_py3.ServiceManagedIdentity

The description of Fhir Service.

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

Parameters

  • identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.

  • etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

  • location (str) – The resource location.

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

  • kind (str or FhirServiceKind) – The kind of the service. Possible values include: “fhir-Stu3”, “fhir-R4”.

  • provisioning_state (str or ProvisioningState) – The provisioning state. Possible values include: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, “SystemMaintenance”.

  • access_policies (list[FhirServiceAccessPolicyEntry]) – Fhir Service access policies.

  • acr_configuration (FhirServiceAcrConfiguration) – Fhir Service Azure container registry configuration.

  • authentication_configuration (FhirServiceAuthenticationConfiguration) – Fhir Service authentication configuration.

  • cors_configuration (FhirServiceCorsConfiguration) – Fhir Service Cors configuration.

  • export_configuration (FhirServiceExportConfiguration) – Fhir Service export configuration.

Variables

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

class azure.mgmt.healthcareapis.models.FhirServiceAccessPolicyEntry(*, object_id: str, **kwargs)[source]

Bases: msrest.serialization.Model

An access policy entry.

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

Parameters

object_id (str) – Required. An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.

class azure.mgmt.healthcareapis.models.FhirServiceAcrConfiguration(*, login_servers: Optional[List[str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Azure container registry configuration information.

Parameters

login_servers (list[str]) – The list of the Azure container registry login servers.

class azure.mgmt.healthcareapis.models.FhirServiceAuthenticationConfiguration(*, authority: Optional[str] = None, audience: Optional[str] = None, smart_proxy_enabled: Optional[bool] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Authentication configuration information.

Parameters

  • authority (str) – The authority url for the service.

  • audience (str) – The audience url for the service.

  • smart_proxy_enabled (bool) – If the SMART on FHIR proxy is enabled.

class azure.mgmt.healthcareapis.models.FhirServiceCollection(*, next_link: Optional[str] = None, value: Optional[List[azure.mgmt.healthcareapis.models._models_py3.FhirService]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A collection of Fhir services.

Parameters

  • next_link (str) – The link used to get the next page of Fhir Services.

  • value (list[FhirService]) – The list of Fhir Services.

class azure.mgmt.healthcareapis.models.FhirServiceCorsConfiguration(*, origins: Optional[List[str]] = None, headers: Optional[List[str]] = None, methods: Optional[List[str]] = None, max_age: Optional[int] = None, allow_credentials: Optional[bool] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The settings for the CORS configuration of the service instance.

Parameters

  • origins (list[str]) – The origins to be allowed via CORS.

  • headers (list[str]) – The headers to be allowed via CORS.

  • methods (list[str]) – The methods to be allowed via CORS.

  • max_age (int) – The max age to be allowed via CORS.

  • allow_credentials (bool) – If credentials are allowed via CORS.

class azure.mgmt.healthcareapis.models.FhirServiceExportConfiguration(*, storage_account_name: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Export operation configuration information.

Parameters

storage_account_name (str) – The name of the default export storage account.

class azure.mgmt.healthcareapis.models.FhirServiceKind(value)[source]

Bases: str, enum.Enum

The kind of the service.

FHIR_R4 = 'fhir-R4'
FHIR_STU3 = 'fhir-Stu3'
class azure.mgmt.healthcareapis.models.FhirServicePatchResource(*, identity: Optional[azure.mgmt.healthcareapis.models._models_py3.ServiceManagedIdentityIdentity] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.ResourceTags, azure.mgmt.healthcareapis.models._models_py3.ServiceManagedIdentity

FhirService patch properties.

Parameters
class azure.mgmt.healthcareapis.models.IotConnector(*, identity: Optional[azure.mgmt.healthcareapis.models._models_py3.ServiceManagedIdentityIdentity] = None, etag: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, provisioning_state: Optional[str] = None, ingestion_endpoint_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.IotEventHubIngestionEndpointConfiguration] = None, device_mapping: Optional[azure.mgmt.healthcareapis.models._models_py3.IotMappingProperties] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.TaggedResource, azure.mgmt.healthcareapis.models._models_py3.ServiceManagedIdentity

IoT Connector definition.

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

Parameters

  • identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.

  • etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

  • location (str) – The resource location.

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

  • provisioning_state (str or ProvisioningState) – The provisioning state. Possible values include: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, “SystemMaintenance”.

  • ingestion_endpoint_configuration (IotEventHubIngestionEndpointConfiguration) – Source configuration.

  • device_mapping (IotMappingProperties) – Device Mappings.

Variables

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

class azure.mgmt.healthcareapis.models.IotConnectorCollection(*, next_link: Optional[str] = None, value: Optional[List[azure.mgmt.healthcareapis.models._models_py3.IotConnector]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A collection of IoT Connectors.

Parameters

  • next_link (str) – The link used to get the next page of IoT Connectors.

  • value (list[IotConnector]) – The list of IoT Connectors.

class azure.mgmt.healthcareapis.models.IotConnectorPatchResource(*, identity: Optional[azure.mgmt.healthcareapis.models._models_py3.ServiceManagedIdentityIdentity] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.ResourceTags, azure.mgmt.healthcareapis.models._models_py3.ServiceManagedIdentity

Iot Connector patch properties.

Parameters
class azure.mgmt.healthcareapis.models.IotDestinationProperties(*, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Common IoT Connector destination properties.

Parameters

provisioning_state (str or ProvisioningState) – The provisioning state. Possible values include: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, “SystemMaintenance”.

class azure.mgmt.healthcareapis.models.IotEventHubIngestionEndpointConfiguration(*, event_hub_name: Optional[str] = None, consumer_group: Optional[str] = None, fully_qualified_event_hub_namespace: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Event Hub ingestion endpoint configuration.

Parameters

  • event_hub_name (str) – Event Hub name to connect to.

  • consumer_group (str) – Consumer group of the event hub to connected to.

  • fully_qualified_event_hub_namespace (str) – Fully qualified namespace of the Event Hub to connect to.

class azure.mgmt.healthcareapis.models.IotFhirDestination(*, resource_identity_resolution_type: str, fhir_service_resource_id: str, fhir_mapping: azure.mgmt.healthcareapis.models._models_py3.IotMappingProperties, etag: Optional[str] = None, location: Optional[str] = None, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.LocationBasedResource

IoT Connector FHIR destination definition.

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

Variables

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Parameters

  • etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

  • location (str) – The resource location.

  • provisioning_state (str or ProvisioningState) – The provisioning state. Possible values include: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, “SystemMaintenance”.

  • resource_identity_resolution_type (str or IotIdentityResolutionType) – Required. Determines how resource identity is resolved on the destination. Possible values include: “Create”, “Lookup”.

  • fhir_service_resource_id (str) – Required. Fully qualified resource id of the FHIR service to connect to.

  • fhir_mapping (IotMappingProperties) – Required. FHIR Mappings.

class azure.mgmt.healthcareapis.models.IotFhirDestinationCollection(*, next_link: Optional[str] = None, value: Optional[List[azure.mgmt.healthcareapis.models._models_py3.IotFhirDestination]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A collection of IoT Connector FHIR destinations.

Parameters

  • next_link (str) – The link used to get the next page of IoT FHIR destinations.

  • value (list[IotFhirDestination]) – The list of IoT Connector FHIR destinations.

class azure.mgmt.healthcareapis.models.IotFhirDestinationProperties(*, resource_identity_resolution_type: str, fhir_service_resource_id: str, fhir_mapping: azure.mgmt.healthcareapis.models._models_py3.IotMappingProperties, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.IotDestinationProperties

IoT Connector destination properties for an Azure FHIR service.

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

Parameters

  • provisioning_state (str or ProvisioningState) – The provisioning state. Possible values include: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, “SystemMaintenance”.

  • resource_identity_resolution_type (str or IotIdentityResolutionType) – Required. Determines how resource identity is resolved on the destination. Possible values include: “Create”, “Lookup”.

  • fhir_service_resource_id (str) – Required. Fully qualified resource id of the FHIR service to connect to.

  • fhir_mapping (IotMappingProperties) – Required. FHIR Mappings.

class azure.mgmt.healthcareapis.models.IotIdentityResolutionType(value)[source]

Bases: str, enum.Enum

The type of IoT identity resolution to use with the destination.

CREATE = 'Create'
LOOKUP = 'Lookup'
class azure.mgmt.healthcareapis.models.IotMappingProperties(*, content: Optional[Any] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The mapping content.

Parameters

content (any) – The mapping.

class azure.mgmt.healthcareapis.models.Kind(value)[source]

Bases: str, enum.Enum

The kind of the service.

FHIR = 'fhir'
FHIR_R4 = 'fhir-R4'
FHIR_STU3 = 'fhir-Stu3'
class azure.mgmt.healthcareapis.models.ListOperations(*, next_link: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Available operations of the service.

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

Variables

value (list[OperationDetail]) – Collection of available operation details.

Parameters

next_link (str) – URL client should use to fetch the next page (per server side paging). It’s null for now, added for future use.

class azure.mgmt.healthcareapis.models.LocationBasedResource(*, etag: Optional[str] = None, location: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.ResourceCore

The common properties for any location based resource, tracked or proxy.

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

Variables

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

Parameters

  • etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

  • location (str) – The resource location.

class azure.mgmt.healthcareapis.models.ManagedServiceIdentityType(value)[source]

Bases: str, enum.Enum

Type of identity being specified, currently SystemAssigned and None are allowed.

NONE = 'None'
SYSTEM_ASSIGNED = 'SystemAssigned'
class azure.mgmt.healthcareapis.models.OperationDetail(*, display: Optional[azure.mgmt.healthcareapis.models._models_py3.OperationDisplay] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Service REST API operation.

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

Variables

  • name (str) – Name of the operation.

  • is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for ARM/control-plane operations.

  • origin (str) – Default value is ‘user,system’.

  • action_type (str or ActionType) – Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. Possible values include: “Internal”.

Parameters

display (OperationDisplay) – Display of the operation.

class azure.mgmt.healthcareapis.models.OperationDisplay(**kwargs)[source]

Bases: msrest.serialization.Model

The object that represents the operation.

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

Variables

  • provider (str) – Service provider: Microsoft.HealthcareApis.

  • resource (str) – Resource Type: Services.

  • operation (str) – Name of the operation.

  • description (str) – Friendly description for the operation,.

class azure.mgmt.healthcareapis.models.OperationResultStatus(value)[source]

Bases: str, enum.Enum

The status of the operation being performed.

CANCELED = 'Canceled'
FAILED = 'Failed'
REQUESTED = 'Requested'
RUNNING = 'Running'
SUCCEEDED = 'Succeeded'
class azure.mgmt.healthcareapis.models.OperationResultsDescription(*, properties: Optional[Any] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The properties indicating the operation result of an operation on a service.

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

Variables

  • id (str) – The ID of the operation returned.

  • name (str) – The name of the operation result.

  • status (str or OperationResultStatus) – The status of the operation being performed. Possible values include: “Canceled”, “Succeeded”, “Failed”, “Requested”, “Running”.

  • start_time (str) – The time that the operation was started.

Parameters

properties (any) – Additional properties of the operation result.

class azure.mgmt.healthcareapis.models.PrivateEndpoint(**kwargs)[source]

Bases: msrest.serialization.Model

The Private Endpoint resource.

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

Variables

id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.healthcareapis.models.PrivateEndpointConnection(*, private_endpoint: Optional[azure.mgmt.healthcareapis.models._models_py3.PrivateEndpoint] = None, private_link_service_connection_state: Optional[azure.mgmt.healthcareapis.models._models_py3.PrivateLinkServiceConnectionState] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.Resource

The Private Endpoint Connection 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”.

  • provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Possible values include: “Succeeded”, “Creating”, “Deleting”, “Failed”.

Parameters

  • private_endpoint (PrivateEndpoint) – The resource of private end point.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.healthcareapis.models.PrivateEndpointConnectionDescription(*, private_endpoint: Optional[azure.mgmt.healthcareapis.models._models_py3.PrivateEndpoint] = None, private_link_service_connection_state: Optional[azure.mgmt.healthcareapis.models._models_py3.PrivateLinkServiceConnectionState] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.PrivateEndpointConnection

The Private Endpoint Connection 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”.

  • provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Possible values include: “Succeeded”, “Creating”, “Deleting”, “Failed”.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Parameters

  • private_endpoint (PrivateEndpoint) – The resource of private end point.

  • private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.healthcareapis.models.PrivateEndpointConnectionListResultDescription(*, value: Optional[List[azure.mgmt.healthcareapis.models._models_py3.PrivateEndpointConnectionDescription]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

List of private endpoint connection associated with the specified storage account.

Parameters

value (list[PrivateEndpointConnectionDescription]) – Array of private endpoint connections.

class azure.mgmt.healthcareapis.models.PrivateEndpointConnectionProvisioningState(value)[source]

Bases: str, enum.Enum

The current provisioning state.

CREATING = 'Creating'
DELETING = 'Deleting'
FAILED = 'Failed'
SUCCEEDED = 'Succeeded'
class azure.mgmt.healthcareapis.models.PrivateEndpointServiceConnectionStatus(value)[source]

Bases: str, enum.Enum

The private endpoint connection status.

APPROVED = 'Approved'
PENDING = 'Pending'
REJECTED = 'Rejected'
class azure.mgmt.healthcareapis.models.PrivateLinkResource(*, required_zone_names: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.Resource

A private link 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”.

  • group_id (str) – The private link resource group id.

  • required_members (list[str]) – The private link resource required member names.

Parameters

required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.healthcareapis.models.PrivateLinkResourceDescription(*, required_zone_names: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.PrivateLinkResource

The Private Endpoint Connection 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”.

  • group_id (str) – The private link resource group id.

  • required_members (list[str]) – The private link resource required member names.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Parameters

required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.healthcareapis.models.PrivateLinkResourceListResultDescription(*, value: Optional[List[azure.mgmt.healthcareapis.models._models_py3.PrivateLinkResourceDescription]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A list of private link resources.

Parameters

value (list[PrivateLinkResourceDescription]) – Array of private link resources.

class azure.mgmt.healthcareapis.models.PrivateLinkServiceConnectionState(*, status: Optional[str] = None, description: Optional[str] = None, actions_required: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

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

Parameters

  • status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: “Pending”, “Approved”, “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.

class azure.mgmt.healthcareapis.models.ProvisioningState(value)[source]

Bases: str, enum.Enum

The provisioning state.

ACCEPTED = 'Accepted'
CANCELED = 'Canceled'
CREATING = 'Creating'
DELETING = 'Deleting'
DEPROVISIONED = 'Deprovisioned'
FAILED = 'Failed'
MOVING = 'Moving'
SUCCEEDED = 'Succeeded'
SUSPENDED = 'Suspended'
SYSTEM_MAINTENANCE = 'SystemMaintenance'
UPDATING = 'Updating'
VERIFYING = 'Verifying'
WARNED = 'Warned'
class azure.mgmt.healthcareapis.models.PublicNetworkAccess(value)[source]

Bases: str, enum.Enum

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

DISABLED = 'Disabled'
ENABLED = 'Enabled'
class azure.mgmt.healthcareapis.models.Resource(**kwargs)[source]

Bases: msrest.serialization.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.healthcareapis.models.ResourceCore(*, etag: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The common properties for any resource, tracked or proxy.

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

Variables

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

Parameters

etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

class azure.mgmt.healthcareapis.models.ResourceTags(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

List of key value pairs that describe the resource. This will overwrite the existing tags.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.

class azure.mgmt.healthcareapis.models.ServiceAccessPolicyEntry(*, object_id: str, **kwargs)[source]

Bases: msrest.serialization.Model

An access policy entry.

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

Parameters

object_id (str) – Required. An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.

class azure.mgmt.healthcareapis.models.ServiceAcrConfigurationInfo(*, login_servers: Optional[List[str]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Azure container registry configuration information.

Parameters

login_servers (list[str]) – The list of the ACR login servers.

class azure.mgmt.healthcareapis.models.ServiceAuthenticationConfigurationInfo(*, authority: Optional[str] = None, audience: Optional[str] = None, smart_proxy_enabled: Optional[bool] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Authentication configuration information.

Parameters

  • authority (str) – The authority url for the service.

  • audience (str) – The audience url for the service.

  • smart_proxy_enabled (bool) – If the SMART on FHIR proxy is enabled.

class azure.mgmt.healthcareapis.models.ServiceCorsConfigurationInfo(*, origins: Optional[List[str]] = None, headers: Optional[List[str]] = None, methods: Optional[List[str]] = None, max_age: Optional[int] = None, allow_credentials: Optional[bool] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The settings for the CORS configuration of the service instance.

Parameters

  • origins (list[str]) – The origins to be allowed via CORS.

  • headers (list[str]) – The headers to be allowed via CORS.

  • methods (list[str]) – The methods to be allowed via CORS.

  • max_age (int) – The max age to be allowed via CORS.

  • allow_credentials (bool) – If credentials are allowed via CORS.

class azure.mgmt.healthcareapis.models.ServiceCosmosDbConfigurationInfo(*, offer_throughput: Optional[int] = None, key_vault_key_uri: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The settings for the Cosmos DB database backing the service.

Parameters

  • offer_throughput (int) – The provisioned throughput for the backing database.

  • key_vault_key_uri (str) – The URI of the customer-managed key for the backing database.

class azure.mgmt.healthcareapis.models.ServiceExportConfigurationInfo(*, storage_account_name: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Export operation configuration information.

Parameters

storage_account_name (str) – The name of the default export storage account.

class azure.mgmt.healthcareapis.models.ServiceManagedIdentity(*, identity: Optional[azure.mgmt.healthcareapis.models._models_py3.ServiceManagedIdentityIdentity] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The managed identity of a service.

Parameters

identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.

class azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity(*, type: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Setting indicating whether the service has a managed identity associated with it.

Parameters

type (str or ManagedServiceIdentityType) – Type of identity being specified, currently SystemAssigned and None are allowed. Possible values include: “SystemAssigned”, “None”.

class azure.mgmt.healthcareapis.models.ServiceNameUnavailabilityReason(value)[source]

Bases: str, enum.Enum

The reason for unavailability.

ALREADY_EXISTS = 'AlreadyExists'
INVALID = 'Invalid'
class azure.mgmt.healthcareapis.models.ServicesDescription(*, kind: str, location: str, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, identity: Optional[azure.mgmt.healthcareapis.models._models_py3.ServicesResourceIdentity] = None, properties: Optional[azure.mgmt.healthcareapis.models._models_py3.ServicesProperties] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.ServicesResource

The description of the service.

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

Variables

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Parameters

  • kind (str or Kind) – Required. The kind of the service. Possible values include: “fhir”, “fhir-Stu3”, “fhir-R4”.

  • location (str) – Required. The resource location.

  • tags (dict[str, str]) – A set of tags. The resource tags.

  • etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

  • identity (ServicesResourceIdentity) – Setting indicating whether the service has a managed identity associated with it.

  • properties (ServicesProperties) – The common properties of a service.

class azure.mgmt.healthcareapis.models.ServicesDescriptionListResult(*, next_link: Optional[str] = None, value: Optional[List[azure.mgmt.healthcareapis.models._models_py3.ServicesDescription]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

A list of service description objects with a next link.

Parameters

  • next_link (str) – The link used to get the next page of service description objects.

  • value (list[ServicesDescription]) – A list of service description objects.

class azure.mgmt.healthcareapis.models.ServicesNameAvailabilityInfo(*, message: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The properties indicating whether a given service name is available.

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

Variables

  • name_available (bool) – The value which indicates whether the provided name is available.

  • reason (str or ServiceNameUnavailabilityReason) – The reason for unavailability. Possible values include: “Invalid”, “AlreadyExists”.

Parameters

message (str) – The detailed reason message.

class azure.mgmt.healthcareapis.models.ServicesPatchDescription(*, tags: Optional[Dict[str, str]] = None, public_network_access: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The description of the service.

Parameters

  • tags (dict[str, str]) – A set of tags. Instance tags.

  • public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.healthcareapis.models.ServicesProperties(*, access_policies: Optional[List[azure.mgmt.healthcareapis.models._models_py3.ServiceAccessPolicyEntry]] = None, cosmos_db_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.ServiceCosmosDbConfigurationInfo] = None, authentication_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.ServiceAuthenticationConfigurationInfo] = None, cors_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.ServiceCorsConfigurationInfo] = None, export_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.ServiceExportConfigurationInfo] = None, private_endpoint_connections: Optional[List[azure.mgmt.healthcareapis.models._models_py3.PrivateEndpointConnection]] = None, public_network_access: Optional[str] = None, acr_configuration: Optional[azure.mgmt.healthcareapis.models._models_py3.ServiceAcrConfigurationInfo] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The properties of a service instance.

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

Variables

provisioning_state (str or ProvisioningState) – The provisioning state. Possible values include: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, “SystemMaintenance”.

Parameters
class azure.mgmt.healthcareapis.models.ServicesResource(*, kind: str, location: str, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, identity: Optional[azure.mgmt.healthcareapis.models._models_py3.ServicesResourceIdentity] = None, **kwargs)[source]

Bases: msrest.serialization.Model

The common properties of a service.

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

Variables

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

Parameters

  • kind (str or Kind) – Required. The kind of the service. Possible values include: “fhir”, “fhir-Stu3”, “fhir-R4”.

  • location (str) – Required. The resource location.

  • tags (dict[str, str]) – A set of tags. The resource tags.

  • etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

  • identity (ServicesResourceIdentity) – Setting indicating whether the service has a managed identity associated with it.

class azure.mgmt.healthcareapis.models.ServicesResourceIdentity(*, type: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Setting indicating whether the service has a managed identity associated with it.

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

Variables

  • principal_id (str) – The principal ID of the resource identity.

  • tenant_id (str) – The tenant ID of the resource.

Parameters

type (str or ManagedServiceIdentityType) – Type of identity being specified, currently SystemAssigned and None are allowed. Possible values include: “SystemAssigned”, “None”.

class azure.mgmt.healthcareapis.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[str] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[str] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Metadata pertaining to creation and last modification of the resource.

Parameters

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

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “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. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.

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

class azure.mgmt.healthcareapis.models.TaggedResource(*, etag: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.ResourceTags, azure.mgmt.healthcareapis.models._models_py3.LocationBasedResource

The common properties of tracked resources in the service.

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

Variables

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

Parameters

  • etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

  • location (str) – The resource location.

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

class azure.mgmt.healthcareapis.models.Workspace(*, etag: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, properties: Optional[azure.mgmt.healthcareapis.models._models_py3.WorkspaceProperties] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.TaggedResource

Workspace resource.

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

Variables

  • id (str) – The resource identifier.

  • name (str) – The resource name.

  • type (str) – The resource type.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Parameters

  • etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

  • location (str) – The resource location.

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

  • properties (WorkspaceProperties) – Workspaces resource specific properties.

class azure.mgmt.healthcareapis.models.WorkspaceList(*, next_link: Optional[str] = None, value: Optional[List[azure.mgmt.healthcareapis.models._models_py3.Workspace]] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Collection of workspace object with a next link.

Parameters

  • next_link (str) – The link used to get the next page.

  • value (list[Workspace]) – Collection of resources.

class azure.mgmt.healthcareapis.models.WorkspacePatchResource(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.healthcareapis.models._models_py3.ResourceTags

Workspace patch properties.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.

class azure.mgmt.healthcareapis.models.WorkspaceProperties(*, provisioning_state: Optional[str] = None, **kwargs)[source]

Bases: msrest.serialization.Model

Workspaces resource specific properties.

Parameters

provisioning_state (str or ProvisioningState) – The provisioning state. Possible values include: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, “SystemMaintenance”.