azure.mgmt.healthcareapis.models module¶

exception azure.mgmt.healthcareapis.models.ErrorDetailsException(deserialize, response, *args)[source]¶

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorDetails’.

Parameters

deserialize – A deserializer
response – Server response to be deserialized.

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.ErrorDetails(*, error=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Error details.

Parameters: error (ErrorDetailsInternal) – Object containing 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.Operation(*, display=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) – Operation name: {provider}/{resource}/{read | write | action | delete}
origin (str) – Default value is ‘user,system’.

Parameters

display (OperationDisplay) – The information displayed about 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.OperationResultsDescription(*, properties=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 (object) – Additional properties of the operation result.

class azure.mgmt.healthcareapis.models.Resource(*, kind, location: str, tags=None, etag: str = 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. Valid values are: fhir, fhir-Stu3 and fhir-R4. Possible values include: ‘fhir’, ‘fhir-Stu3’, ‘fhir-R4’
location (str) – Required. The resource location.
tags (dict[str, str]) – The resource tags.
etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.

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 object ID that is allowed access to the FHIR service.

class azure.mgmt.healthcareapis.models.ServiceAuthenticationConfigurationInfo(*, authority: str = None, audience: str = None, smart_proxy_enabled: 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=None, headers=None, methods=None, max_age: int = None, allow_credentials: 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: int = 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.

class azure.mgmt.healthcareapis.models.ServicesDescription(*, kind, location: str, tags=None, etag: str = None, properties=None, **kwargs)[source]¶

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

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.

Parameters

kind (str or Kind) – Required. The kind of the service. Valid values are: fhir, fhir-Stu3 and fhir-R4. Possible values include: ‘fhir’, ‘fhir-Stu3’, ‘fhir-R4’
location (str) – Required. The resource location.
tags (dict[str, str]) – The resource tags.
etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.
properties (ServicesProperties) – The common properties of a service.

class azure.mgmt.healthcareapis.models.ServicesNameAvailabilityInfo(*, message: 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=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The description of the service.

Parameters: tags (dict[str, str]) – Instance tags

class azure.mgmt.healthcareapis.models.ServicesProperties(*, access_policies, cosmos_db_configuration=None, authentication_configuration=None, cors_configuration=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.

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

Variables

provisioning_state (str or ProvisioningState) – The provisioning state. Possible values include: ‘Deleting’, ‘Succeeded’, ‘Creating’, ‘Accepted’, ‘Verifying’, ‘Updating’, ‘Failed’, ‘Canceled’, ‘Deprovisioned’

Parameters

access_policies (list[ServiceAccessPolicyEntry]) – Required. The access policies of the service instance.
cosmos_db_configuration (ServiceCosmosDbConfigurationInfo) – The settings for the Cosmos DB database backing the service.
authentication_configuration (ServiceAuthenticationConfigurationInfo) – The authentication configuration for the service instance.
cors_configuration (ServiceCorsConfigurationInfo) – The settings for the CORS configuration of the service instance.

class azure.mgmt.healthcareapis.models.ServicesDescriptionPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of ServicesDescription object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.healthcareapis.models.OperationPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.healthcareapis.models.ProvisioningState[source]¶

Bases: str, enum.Enum

An enumeration.

accepted = 'Accepted'¶

canceled = 'Canceled'¶

creating = 'Creating'¶

deleting = 'Deleting'¶

deprovisioned = 'Deprovisioned'¶

failed = 'Failed'¶

succeeded = 'Succeeded'¶

updating = 'Updating'¶

verifying = 'Verifying'¶

class azure.mgmt.healthcareapis.models.Kind[source]¶

Bases: str, enum.Enum

An enumeration.

fhir = 'fhir'¶

fhir_r4 = 'fhir-R4'¶

fhir_stu3 = 'fhir-Stu3'¶

class azure.mgmt.healthcareapis.models.ServiceNameUnavailabilityReason[source]¶

Bases: str, enum.Enum

An enumeration.

already_exists = 'AlreadyExists'¶

invalid = 'Invalid'¶

class azure.mgmt.healthcareapis.models.OperationResultStatus[source]¶

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'¶

failed = 'Failed'¶

requested = 'Requested'¶

running = 'Running'¶

succeeded = 'Succeeded'¶