azure.mgmt.healthcareapis.models module¶
-
class
azure.mgmt.healthcareapis.models.
ActionType
(value)[source]¶ -
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:
azure.mgmt.healthcareapis._serialization.Model
Input values.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
CorsConfiguration
(*, 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:
azure.mgmt.healthcareapis._serialization.Model
The settings for the CORS configuration of the service instance.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
CreatedByType
(value)[source]¶ -
The type of identity that created the resource.
-
APPLICATION
= 'Application'¶
-
KEY
= 'Key'¶
-
MANAGED_IDENTITY
= 'ManagedIdentity'¶
-
USER
= 'User'¶
-
-
class
azure.mgmt.healthcareapis.models.
DicomService
(*, identity: Optional[_models.ServiceManagedIdentityIdentity] = None, etag: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, authentication_configuration: Optional[_models.DicomServiceAuthenticationConfiguration] = None, cors_configuration: Optional[_models.CorsConfiguration] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis.models._models_py3.TaggedResource
,azure.mgmt.healthcareapis.models._models_py3.ServiceManagedIdentity
The description of Dicom Service.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
name (str) – The resource name.
etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.
location (str) – The resource location.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
provisioning_state (str or ProvisioningState) – The provisioning state. Known values are: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, and “SystemMaintenance”.
authentication_configuration (DicomServiceAuthenticationConfiguration) – Dicom Service authentication configuration.
cors_configuration (CorsConfiguration) – Dicom Service Cors configuration.
service_url (str) – The url of the Dicom Services.
private_endpoint_connections (list[PrivateEndpointConnection]) – The list of private endpoint connections that are set up for this resource.
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: “Enabled” and “Disabled”.
- Keyword Arguments
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.
authentication_configuration (DicomServiceAuthenticationConfiguration) – Dicom Service authentication configuration.
cors_configuration (CorsConfiguration) – Dicom Service Cors configuration.
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: “Enabled” and “Disabled”.
-
class
azure.mgmt.healthcareapis.models.
DicomServiceAuthenticationConfiguration
(**kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Authentication configuration information.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.healthcareapis.models.
DicomServiceCollection
(*, next_link: Optional[str] = None, value: Optional[List[_models.DicomService]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
The collection of Dicom Services.
- Variables
next_link (str) – The link used to get the next page of Dicom Services.
value (list[DicomService]) – The list of Dicom Services.
- Keyword Arguments
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
(*, identity: Optional[_models.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
Dicom Service patch properties.
- Variables
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
- Keyword Arguments
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
-
class
azure.mgmt.healthcareapis.models.
Error
(*, error: Optional[_models.ErrorDetailsInternal] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Error details.
- Variables
error (ErrorDetailsInternal) – Error details.
- Keyword Arguments
error (ErrorDetailsInternal) – Error details.
-
class
azure.mgmt.healthcareapis.models.
ErrorDetails
(*, error: Optional[_models.ErrorDetailsInternal] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Error details.
- Variables
error (ErrorDetailsInternal) – Error details.
- Keyword Arguments
error (ErrorDetailsInternal) – Error details.
-
class
azure.mgmt.healthcareapis.models.
ErrorDetailsInternal
(**kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Error details.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.healthcareapis.models.
FhirResourceVersionPolicy
(value)[source]¶ -
Controls how resources are versioned on the FHIR service.
-
NO_VERSION
= 'no-version'¶
-
VERSIONED
= 'versioned'¶
-
VERSIONED_UPDATE
= 'versioned-update'¶
-
-
class
azure.mgmt.healthcareapis.models.
FhirService
(*, identity: Optional[_models.ServiceManagedIdentityIdentity] = None, etag: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, kind: Optional[Union[str, _models.FhirServiceKind]] = None, access_policies: Optional[List[_models.FhirServiceAccessPolicyEntry]] = None, acr_configuration: Optional[_models.FhirServiceAcrConfiguration] = None, authentication_configuration: Optional[_models.FhirServiceAuthenticationConfiguration] = None, cors_configuration: Optional[_models.FhirServiceCorsConfiguration] = None, export_configuration: Optional[_models.FhirServiceExportConfiguration] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, resource_version_policy_configuration: Optional[_models.ResourceVersionPolicyConfiguration] = None, import_configuration: Optional[_models.FhirServiceImportConfiguration] = 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.
- Variables
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
name (str) – The resource name.
etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.
location (str) – The resource location.
kind (str or FhirServiceKind) – The kind of the service. Known values are: “fhir-Stu3” and “fhir-R4”.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
provisioning_state (str or ProvisioningState) – The provisioning state. Known values are: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, and “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.
private_endpoint_connections (list[PrivateEndpointConnection]) – The list of private endpoint connections that are set up for this resource.
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: “Enabled” and “Disabled”.
event_state (str or ServiceEventState) – Fhir Service event support status. Known values are: “Disabled”, “Enabled”, and “Updating”.
resource_version_policy_configuration (ResourceVersionPolicyConfiguration) – Determines tracking of history for resources.
import_configuration (FhirServiceImportConfiguration) – Fhir Service import configuration.
- Keyword Arguments
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.
kind (str or FhirServiceKind) – The kind of the service. Known values are: “fhir-Stu3” and “fhir-R4”.
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.
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: “Enabled” and “Disabled”.
resource_version_policy_configuration (ResourceVersionPolicyConfiguration) – Determines tracking of history for resources.
import_configuration (FhirServiceImportConfiguration) – Fhir Service import configuration.
-
class
azure.mgmt.healthcareapis.models.
FhirServiceAccessPolicyEntry
(*, object_id: str, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
An access policy entry.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.healthcareapis.models.
FhirServiceAcrConfiguration
(*, login_servers: Optional[List[str]] = None, oci_artifacts: Optional[List[_models.ServiceOciArtifactEntry]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Azure container registry configuration information.
- Variables
login_servers (list[str]) – The list of the Azure container registry login servers.
oci_artifacts (list[ServiceOciArtifactEntry]) – The list of Open Container Initiative (OCI) artifacts.
- Keyword Arguments
login_servers (list[str]) – The list of the Azure container registry login servers.
oci_artifacts (list[ServiceOciArtifactEntry]) – The list of Open Container Initiative (OCI) artifacts.
-
class
azure.mgmt.healthcareapis.models.
FhirServiceAuthenticationConfiguration
(*, authority: Optional[str] = None, audience: Optional[str] = None, smart_proxy_enabled: Optional[bool] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Authentication configuration information.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
FhirServiceCollection
(*, next_link: Optional[str] = None, value: Optional[List[_models.FhirService]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
A collection of Fhir services.
- Variables
next_link (str) – The link used to get the next page of Fhir Services.
value (list[FhirService]) – The list of Fhir Services.
- Keyword Arguments
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:
azure.mgmt.healthcareapis._serialization.Model
The settings for the CORS configuration of the service instance.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
FhirServiceExportConfiguration
(*, storage_account_name: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Export operation configuration information.
-
class
azure.mgmt.healthcareapis.models.
FhirServiceImportConfiguration
(*, integration_data_store: Optional[str] = None, initial_import_mode: Optional[bool] = None, enabled: Optional[bool] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Import operation configuration information.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
FhirServiceKind
(value)[source]¶ -
The kind of the service.
-
FHIR_R4
= 'fhir-R4'¶
-
FHIR_STU3
= 'fhir-Stu3'¶
-
-
class
azure.mgmt.healthcareapis.models.
FhirServicePatchResource
(*, identity: Optional[_models.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.
- Variables
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
- Keyword Arguments
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
-
class
azure.mgmt.healthcareapis.models.
IotConnector
(*, identity: Optional[_models.ServiceManagedIdentityIdentity] = None, etag: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, ingestion_endpoint_configuration: Optional[_models.IotEventHubIngestionEndpointConfiguration] = None, device_mapping: Optional[_models.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.
- Variables
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
name (str) – The resource name.
etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.
location (str) – The resource location.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
provisioning_state (str or ProvisioningState) – The provisioning state. Known values are: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, and “SystemMaintenance”.
ingestion_endpoint_configuration (IotEventHubIngestionEndpointConfiguration) – Source configuration.
device_mapping (IotMappingProperties) – Device Mappings.
- Keyword Arguments
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.
ingestion_endpoint_configuration (IotEventHubIngestionEndpointConfiguration) – Source configuration.
device_mapping (IotMappingProperties) – Device Mappings.
-
class
azure.mgmt.healthcareapis.models.
IotConnectorCollection
(*, next_link: Optional[str] = None, value: Optional[List[_models.IotConnector]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
A collection of IoT Connectors.
- Variables
next_link (str) – The link used to get the next page of IoT Connectors.
value (list[IotConnector]) – The list of IoT Connectors.
- Keyword Arguments
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[_models.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.
- Variables
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
- Keyword Arguments
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
-
class
azure.mgmt.healthcareapis.models.
IotDestinationProperties
(**kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Common IoT Connector destination properties.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
provisioning_state (str or ProvisioningState) – The provisioning state. Known values are: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, and “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:
azure.mgmt.healthcareapis._serialization.Model
Event Hub ingestion endpoint configuration.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
IotFhirDestination
(*, resource_identity_resolution_type: Union[str, _models.IotIdentityResolutionType], fhir_service_resource_id: str, fhir_mapping: _models.IotMappingProperties, etag: Optional[str] = None, location: 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
name (str) – The resource name.
etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.
location (str) – The resource location.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
provisioning_state (str or ProvisioningState) – The provisioning state. Known values are: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, and “SystemMaintenance”.
resource_identity_resolution_type (str or IotIdentityResolutionType) – Determines how resource identity is resolved on the destination. Required. Known values are: “Create” and “Lookup”.
fhir_service_resource_id (str) – Fully qualified resource id of the FHIR service to connect to. Required.
fhir_mapping (IotMappingProperties) – FHIR Mappings. Required.
- Keyword Arguments
etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.
location (str) – The resource location.
resource_identity_resolution_type (str or IotIdentityResolutionType) – Determines how resource identity is resolved on the destination. Required. Known values are: “Create” and “Lookup”.
fhir_service_resource_id (str) – Fully qualified resource id of the FHIR service to connect to. Required.
fhir_mapping (IotMappingProperties) – FHIR Mappings. Required.
-
class
azure.mgmt.healthcareapis.models.
IotFhirDestinationCollection
(*, next_link: Optional[str] = None, value: Optional[List[_models.IotFhirDestination]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
A collection of IoT Connector FHIR destinations.
- Variables
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.
- Keyword Arguments
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: Union[str, _models.IotIdentityResolutionType], fhir_service_resource_id: str, fhir_mapping: _models.IotMappingProperties, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis.models._models_py3.IotDestinationProperties
IoT Connector destination properties for an Azure FHIR 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
provisioning_state (str or ProvisioningState) – The provisioning state. Known values are: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, and “SystemMaintenance”.
resource_identity_resolution_type (str or IotIdentityResolutionType) – Determines how resource identity is resolved on the destination. Required. Known values are: “Create” and “Lookup”.
fhir_service_resource_id (str) – Fully qualified resource id of the FHIR service to connect to. Required.
fhir_mapping (IotMappingProperties) – FHIR Mappings. Required.
- Keyword Arguments
resource_identity_resolution_type (str or IotIdentityResolutionType) – Determines how resource identity is resolved on the destination. Required. Known values are: “Create” and “Lookup”.
fhir_service_resource_id (str) – Fully qualified resource id of the FHIR service to connect to. Required.
fhir_mapping (IotMappingProperties) – FHIR Mappings. Required.
-
class
azure.mgmt.healthcareapis.models.
IotIdentityResolutionType
(value)[source]¶ -
The type of IoT identity resolution to use with the destination.
-
CREATE
= 'Create'¶
-
LOOKUP
= 'Lookup'¶
-
-
class
azure.mgmt.healthcareapis.models.
IotMappingProperties
(*, content: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
The mapping content.
- Variables
content (JSON) – The mapping.
- Keyword Arguments
content (JSON) – The mapping.
-
class
azure.mgmt.healthcareapis.models.
Kind
(value)[source]¶ -
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:
azure.mgmt.healthcareapis._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.
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.
- Keyword Arguments
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
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
LogSpecification
(*, name: Optional[str] = None, display_name: Optional[str] = None, blob_duration: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Specifications of the Log for Azure Monitoring.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
ManagedServiceIdentityType
(value)[source]¶ -
Type of identity being specified, currently SystemAssigned and None are allowed.
-
NONE
= 'None'¶
-
SYSTEM_ASSIGNED
= 'SystemAssigned'¶
-
-
class
azure.mgmt.healthcareapis.models.
MetricDimension
(*, name: Optional[str] = None, display_name: Optional[str] = None, to_be_exported_for_shoebox: Optional[bool] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Specifications of the Dimension of metrics.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
MetricSpecification
(*, name: Optional[str] = None, display_name: Optional[str] = None, display_description: Optional[str] = None, unit: Optional[str] = None, category: Optional[str] = None, aggregation_type: Optional[str] = None, supported_aggregation_types: Optional[List[str]] = None, supported_time_grain_types: Optional[List[str]] = None, fill_gap_with_zero: Optional[bool] = None, metric_filter_pattern: Optional[str] = None, dimensions: Optional[List[_models.MetricDimension]] = None, is_internal: Optional[bool] = None, source_mdm_account: Optional[str] = None, source_mdm_namespace: Optional[str] = None, enable_regional_mdm_account: Optional[bool] = None, resource_id_dimension_name_override: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Specifications of the Metrics for Azure Monitoring.
- Variables
name (str) – Name of the metric.
display_name (str) – Localized friendly display name of the metric.
display_description (str) – Localized friendly description of the metric.
unit (str) – Unit that makes sense for the metric.
category (str) – Name of the metric category that the metric belongs to. A metric can only belong to a single category.
aggregation_type (str) – Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.
supported_aggregation_types (list[str]) – Supported aggregation types.
supported_time_grain_types (list[str]) – Supported time grain types.
fill_gap_with_zero (bool) – Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.
metric_filter_pattern (str) – Pattern for the filter of the metric.
dimensions (list[MetricDimension]) – Dimensions of the metric.
is_internal (bool) – Whether the metric is internal.
source_mdm_account (str) – The source MDM account.
source_mdm_namespace (str) – The source MDM namespace.
enable_regional_mdm_account (bool) – Whether regional MDM account enabled.
resource_id_dimension_name_override (str) – The resource Id dimension name override.
- Keyword Arguments
name (str) – Name of the metric.
display_name (str) – Localized friendly display name of the metric.
display_description (str) – Localized friendly description of the metric.
unit (str) – Unit that makes sense for the metric.
category (str) – Name of the metric category that the metric belongs to. A metric can only belong to a single category.
aggregation_type (str) – Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.
supported_aggregation_types (list[str]) – Supported aggregation types.
supported_time_grain_types (list[str]) – Supported time grain types.
fill_gap_with_zero (bool) – Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published.
metric_filter_pattern (str) – Pattern for the filter of the metric.
dimensions (list[MetricDimension]) – Dimensions of the metric.
is_internal (bool) – Whether the metric is internal.
source_mdm_account (str) – The source MDM account.
source_mdm_namespace (str) – The source MDM namespace.
enable_regional_mdm_account (bool) – Whether regional MDM account enabled.
resource_id_dimension_name_override (str) – The resource Id dimension name override.
-
class
azure.mgmt.healthcareapis.models.
OperationDetail
(*, display: Optional[_models.OperationDisplay] = None, properties: Optional[_models.OperationProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._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.
display (OperationDisplay) – Display of the operation.
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. “Internal”
properties (OperationProperties) – Properties of the operation.
- Keyword Arguments
display (OperationDisplay) – Display of the operation.
properties (OperationProperties) – Properties of the operation.
-
class
azure.mgmt.healthcareapis.models.
OperationDisplay
(**kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
The object that represents the operation.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.healthcareapis.models.
OperationProperties
(*, service_specification: Optional[_models.ServiceSpecification] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Extra Operation properties.
- Variables
service_specification (ServiceSpecification) – Service specifications of the operation.
- Keyword Arguments
service_specification (ServiceSpecification) – Service specifications of the operation.
-
class
azure.mgmt.healthcareapis.models.
OperationResultStatus
(value)[source]¶ -
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[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._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
name (str) – The name of the operation result.
status (str or OperationResultStatus) – The status of the operation being performed. Known values are: “Canceled”, “Succeeded”, “Failed”, “Requested”, and “Running”.
start_time (str) – The time that the operation was started.
end_time (str) – The time that the operation finished.
properties (JSON) – Additional properties of the operation result.
- Keyword Arguments
properties (JSON) – Additional properties of the operation result.
-
class
azure.mgmt.healthcareapis.models.
PrivateEndpoint
(**kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
The Private Endpoint resource.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.healthcareapis.models.
PrivateEndpointConnection
(*, private_endpoint: Optional[_models.PrivateEndpoint] = None, private_link_service_connection_state: Optional[_models.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”.
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.
provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.
- Keyword Arguments
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[_models.PrivateEndpoint] = None, private_link_service_connection_state: Optional[_models.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”.
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.
provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
- Keyword Arguments
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.
PrivateEndpointConnectionListResult
(*, value: Optional[List[_models.PrivateEndpointConnection]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
List of private endpoint connection associated with the specified storage account.
- Variables
value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
- Keyword Arguments
value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
-
class
azure.mgmt.healthcareapis.models.
PrivateEndpointConnectionListResultDescription
(*, value: Optional[List[_models.PrivateEndpointConnectionDescription]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
List of private endpoint connection associated with the specified storage account.
- Variables
value (list[PrivateEndpointConnectionDescription]) – Array of private endpoint connections.
- Keyword Arguments
value (list[PrivateEndpointConnectionDescription]) – Array of private endpoint connections.
-
class
azure.mgmt.healthcareapis.models.
PrivateEndpointConnectionProvisioningState
(value)[source]¶ -
The current provisioning state.
-
CREATING
= 'Creating'¶
-
DELETING
= 'Deleting'¶
-
FAILED
= 'Failed'¶
-
SUCCEEDED
= 'Succeeded'¶
-
-
class
azure.mgmt.healthcareapis.models.
PrivateEndpointServiceConnectionStatus
(value)[source]¶ -
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.
required_zone_names (list[str]) – The private link resource Private link DNS zone name.
- Keyword Arguments
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.
required_zone_names (list[str]) – The private link resource Private link DNS zone name.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
- Keyword Arguments
required_zone_names (list[str]) – The private link resource Private link DNS zone name.
-
class
azure.mgmt.healthcareapis.models.
PrivateLinkResourceListResultDescription
(*, value: Optional[List[_models.PrivateLinkResourceDescription]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
A list of private link resources.
- Variables
value (list[PrivateLinkResourceDescription]) – Array of private link resources.
- Keyword Arguments
value (list[PrivateLinkResourceDescription]) – Array of private link resources.
-
class
azure.mgmt.healthcareapis.models.
PrivateLinkServiceConnectionState
(*, status: Optional[Union[str, _models.PrivateEndpointServiceConnectionStatus]] = None, description: Optional[str] = None, actions_required: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.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.
- Keyword Arguments
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.
-
class
azure.mgmt.healthcareapis.models.
ProvisioningState
(value)[source]¶ -
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]¶ -
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:
azure.mgmt.healthcareapis._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:
azure.mgmt.healthcareapis._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
- Keyword Arguments
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:
azure.mgmt.healthcareapis._serialization.Model
List of key value pairs that describe the resource. This will overwrite the existing tags.
-
class
azure.mgmt.healthcareapis.models.
ResourceVersionPolicyConfiguration
(*, default: Optional[Union[str, _models.FhirResourceVersionPolicy]] = None, resource_type_overrides: Optional[Dict[str, Union[str, _models.FhirResourceVersionPolicy]]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
The settings for history tracking for FHIR resources.
- Variables
default (str or FhirResourceVersionPolicy) – The default value for tracking history across all resources. Known values are: “no-version”, “versioned”, and “versioned-update”.
resource_type_overrides (dict[str, str or FhirResourceVersionPolicy]) – A list of FHIR Resources and their version policy overrides.
- Keyword Arguments
default (str or FhirResourceVersionPolicy) – The default value for tracking history across all resources. Known values are: “no-version”, “versioned”, and “versioned-update”.
resource_type_overrides (dict[str, str or FhirResourceVersionPolicy]) – A list of FHIR Resources and their version policy overrides.
-
class
azure.mgmt.healthcareapis.models.
ServiceAccessPolicyEntry
(*, object_id: str, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
An access policy entry.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.healthcareapis.models.
ServiceAcrConfigurationInfo
(*, login_servers: Optional[List[str]] = None, oci_artifacts: Optional[List[_models.ServiceOciArtifactEntry]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Azure container registry configuration information.
- Variables
login_servers (list[str]) – The list of the ACR login servers.
oci_artifacts (list[ServiceOciArtifactEntry]) – The list of Open Container Initiative (OCI) artifacts.
- Keyword Arguments
login_servers (list[str]) – The list of the ACR login servers.
oci_artifacts (list[ServiceOciArtifactEntry]) – The list of Open Container Initiative (OCI) artifacts.
-
class
azure.mgmt.healthcareapis.models.
ServiceAuthenticationConfigurationInfo
(*, authority: Optional[str] = None, audience: Optional[str] = None, smart_proxy_enabled: Optional[bool] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Authentication configuration information.
- Variables
- Keyword Arguments
-
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:
azure.mgmt.healthcareapis._serialization.Model
The settings for the CORS configuration of the service instance.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
ServiceCosmosDbConfigurationInfo
(*, offer_throughput: Optional[int] = None, key_vault_key_uri: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
The settings for the Cosmos DB database backing the service.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
ServiceEventState
(value)[source]¶ -
Indicates the current status of event support for the resource.
-
DISABLED
= 'Disabled'¶
-
ENABLED
= 'Enabled'¶
-
UPDATING
= 'Updating'¶
-
-
class
azure.mgmt.healthcareapis.models.
ServiceExportConfigurationInfo
(*, storage_account_name: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Export operation configuration information.
-
class
azure.mgmt.healthcareapis.models.
ServiceImportConfigurationInfo
(*, integration_data_store: Optional[str] = None, initial_import_mode: Optional[bool] = None, enabled: Optional[bool] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Import operation configuration information.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
ServiceManagedIdentity
(*, identity: Optional[_models.ServiceManagedIdentityIdentity] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Managed service identity (system assigned and/or user assigned identities).
- Variables
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
- Keyword Arguments
identity (ServiceManagedIdentityIdentity) – Setting indicating whether the service has a managed identity associated with it.
-
class
azure.mgmt.healthcareapis.models.
ServiceManagedIdentityIdentity
(*, type: Union[str, _models.ServiceManagedIdentityType], user_assigned_identities: Optional[Dict[str, _models.UserAssignedIdentity]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._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.
All required parameters must be populated in order to send to Azure.
- Variables
type (str or ServiceManagedIdentityType) – Type of identity being specified, currently SystemAssigned and None are allowed. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.
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.
user_assigned_identities (dict[str, UserAssignedIdentity]) – The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
- Keyword Arguments
type (str or ServiceManagedIdentityType) – Type of identity being specified, currently SystemAssigned and None are allowed. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.
user_assigned_identities (dict[str, UserAssignedIdentity]) – The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
-
class
azure.mgmt.healthcareapis.models.
ServiceManagedIdentityType
(value)[source]¶ -
Type of identity being specified, currently SystemAssigned and None are allowed.
-
NONE
= 'None'¶
-
SYSTEM_ASSIGNED
= 'SystemAssigned'¶
-
SYSTEM_ASSIGNED_USER_ASSIGNED
= 'SystemAssigned,UserAssigned'¶
-
USER_ASSIGNED
= 'UserAssigned'¶
-
-
class
azure.mgmt.healthcareapis.models.
ServiceOciArtifactEntry
(*, login_server: Optional[str] = None, image_name: Optional[str] = None, digest: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
An Open Container Initiative (OCI) artifact.
- Variables
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
ServiceSpecification
(*, log_specifications: Optional[List[_models.LogSpecification]] = None, metric_specifications: Optional[List[_models.MetricSpecification]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Service specification payload.
- Variables
log_specifications (list[LogSpecification]) – Specifications of the Log for Azure Monitoring.
metric_specifications (list[MetricSpecification]) – Specifications of the Metrics for Azure Monitoring.
- Keyword Arguments
log_specifications (list[LogSpecification]) – Specifications of the Log for Azure Monitoring.
metric_specifications (list[MetricSpecification]) – Specifications of the Metrics for Azure Monitoring.
-
class
azure.mgmt.healthcareapis.models.
ServicesDescription
(*, kind: Union[str, _models.Kind], location: str, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, identity: Optional[_models.ServicesResourceIdentity] = None, properties: Optional[_models.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
name (str) – The resource name.
kind (str or Kind) – The kind of the service. Required. Known values are: “fhir”, “fhir-Stu3”, and “fhir-R4”.
location (str) – The resource location. Required.
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.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
- Keyword Arguments
kind (str or Kind) – The kind of the service. Required. Known values are: “fhir”, “fhir-Stu3”, and “fhir-R4”.
location (str) – The resource location. Required.
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[_models.ServicesDescription]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
A list of service description objects with a next link.
- Variables
next_link (str) – The link used to get the next page of service description objects.
value (list[ServicesDescription]) – A list of service description objects.
- Keyword Arguments
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:
azure.mgmt.healthcareapis._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. Known values are: “Invalid” and “AlreadyExists”.
message (str) – The detailed reason message.
- Keyword Arguments
message (str) – The detailed reason message.
-
class
azure.mgmt.healthcareapis.models.
ServicesPatchDescription
(*, tags: Optional[Dict[str, str]] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
The description of the service.
- Variables
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: “Enabled” and “Disabled”.
- Keyword Arguments
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: “Enabled” and “Disabled”.
-
class
azure.mgmt.healthcareapis.models.
ServicesProperties
(*, access_policies: Optional[List[_models.ServiceAccessPolicyEntry]] = None, cosmos_db_configuration: Optional[_models.ServiceCosmosDbConfigurationInfo] = None, authentication_configuration: Optional[_models.ServiceAuthenticationConfigurationInfo] = None, cors_configuration: Optional[_models.ServiceCorsConfigurationInfo] = None, export_configuration: Optional[_models.ServiceExportConfigurationInfo] = None, private_endpoint_connections: Optional[List[_models.PrivateEndpointConnection]] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, acr_configuration: Optional[_models.ServiceAcrConfigurationInfo] = None, import_configuration: Optional[_models.ServiceImportConfigurationInfo] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._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. Known values are: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, and “SystemMaintenance”.
access_policies (list[ServiceAccessPolicyEntry]) – 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.
export_configuration (ServiceExportConfigurationInfo) – The settings for the export operation of the service instance.
private_endpoint_connections (list[PrivateEndpointConnection]) – The list of private endpoint connections that are set up for this resource.
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: “Enabled” and “Disabled”.
acr_configuration (ServiceAcrConfigurationInfo) – The azure container registry settings used for convert data operation of the service instance.
import_configuration (ServiceImportConfigurationInfo) – The settings for the import operation of the service instance.
- Keyword Arguments
access_policies (list[ServiceAccessPolicyEntry]) – 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.
export_configuration (ServiceExportConfigurationInfo) – The settings for the export operation of the service instance.
private_endpoint_connections (list[PrivateEndpointConnection]) – The list of private endpoint connections that are set up for this resource.
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: “Enabled” and “Disabled”.
acr_configuration (ServiceAcrConfigurationInfo) – The azure container registry settings used for convert data operation of the service instance.
import_configuration (ServiceImportConfigurationInfo) – The settings for the import operation of the service instance.
-
class
azure.mgmt.healthcareapis.models.
ServicesResource
(*, kind: Union[str, _models.Kind], location: str, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, identity: Optional[_models.ServicesResourceIdentity] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._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
name (str) – The resource name.
kind (str or Kind) – The kind of the service. Required. Known values are: “fhir”, “fhir-Stu3”, and “fhir-R4”.
location (str) – The resource location. Required.
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.
- Keyword Arguments
kind (str or Kind) – The kind of the service. Required. Known values are: “fhir”, “fhir-Stu3”, and “fhir-R4”.
location (str) – The resource location. Required.
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[Union[str, _models.ManagedServiceIdentityType]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._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.
type (str or ManagedServiceIdentityType) – Type of identity being specified, currently SystemAssigned and None are allowed. Known values are: “SystemAssigned” and “None”.
- Keyword Arguments
type (str or ManagedServiceIdentityType) – Type of identity being specified, currently SystemAssigned and None are allowed. Known values are: “SystemAssigned” and “None”.
-
class
azure.mgmt.healthcareapis.models.
SystemData
(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Metadata pertaining to creation and last modification of the resource.
- Variables
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).
- Keyword Arguments
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).
-
class
azure.mgmt.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
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
UserAssignedIdentity
(**kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
User assigned identity properties.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.healthcareapis.models.
Workspace
(*, etag: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, properties: Optional[_models.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
name (str) – The resource name.
etag (str) – An etag associated with the resource, used for optimistic concurrency when editing it.
location (str) – The resource location.
properties (WorkspaceProperties) – Workspaces resource specific properties.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
- Keyword Arguments
-
class
azure.mgmt.healthcareapis.models.
WorkspaceList
(*, next_link: Optional[str] = None, value: Optional[List[_models.Workspace]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Collection of workspace object with a next link.
-
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.
-
class
azure.mgmt.healthcareapis.models.
WorkspaceProperties
(*, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.healthcareapis._serialization.Model
Workspaces resource specific properties.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
provisioning_state (str or ProvisioningState) – The provisioning state. Known values are: “Deleting”, “Succeeded”, “Creating”, “Accepted”, “Verifying”, “Updating”, “Failed”, “Canceled”, “Deprovisioned”, “Moving”, “Suspended”, “Warned”, and “SystemMaintenance”.
private_endpoint_connections (list[PrivateEndpointConnection]) – The list of private endpoint connections that are set up for this resource.
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: “Enabled” and “Disabled”.
- Keyword Arguments
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Known values are: “Enabled” and “Disabled”.