# coding=utf-8
# pylint: disable=too-many-lines
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
import datetime
import sys
from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union
from .. import _serialization
if sys.version_info >= (3, 9):
from collections.abc import MutableMapping
else:
from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports
if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from .. import models as _models
JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object
[docs]class CheckNameAvailabilityParameters(_serialization.Model):
"""Input values.
All required parameters must be populated in order to send to Azure.
:ivar name: The name of the service instance to check. Required.
:vartype name: str
:ivar type: The fully qualified resource type which includes provider namespace. Required.
:vartype type: str
"""
_validation = {
"name": {"required": True},
"type": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
}
def __init__(self, *, name: str, type: str, **kwargs):
"""
:keyword name: The name of the service instance to check. Required.
:paramtype name: str
:keyword type: The fully qualified resource type which includes provider namespace. Required.
:paramtype type: str
"""
super().__init__(**kwargs)
self.name = name
self.type = type
[docs]class CorsConfiguration(_serialization.Model):
"""The settings for the CORS configuration of the service instance.
:ivar origins: The origins to be allowed via CORS.
:vartype origins: list[str]
:ivar headers: The headers to be allowed via CORS.
:vartype headers: list[str]
:ivar methods: The methods to be allowed via CORS.
:vartype methods: list[str]
:ivar max_age: The max age to be allowed via CORS.
:vartype max_age: int
:ivar allow_credentials: If credentials are allowed via CORS.
:vartype allow_credentials: bool
"""
_validation = {
"max_age": {"maximum": 99999, "minimum": 0},
}
_attribute_map = {
"origins": {"key": "origins", "type": "[str]"},
"headers": {"key": "headers", "type": "[str]"},
"methods": {"key": "methods", "type": "[str]"},
"max_age": {"key": "maxAge", "type": "int"},
"allow_credentials": {"key": "allowCredentials", "type": "bool"},
}
def __init__(
self,
*,
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
):
"""
:keyword origins: The origins to be allowed via CORS.
:paramtype origins: list[str]
:keyword headers: The headers to be allowed via CORS.
:paramtype headers: list[str]
:keyword methods: The methods to be allowed via CORS.
:paramtype methods: list[str]
:keyword max_age: The max age to be allowed via CORS.
:paramtype max_age: int
:keyword allow_credentials: If credentials are allowed via CORS.
:paramtype allow_credentials: bool
"""
super().__init__(**kwargs)
self.origins = origins
self.headers = headers
self.methods = methods
self.max_age = max_age
self.allow_credentials = allow_credentials
[docs]class ServiceManagedIdentity(_serialization.Model):
"""Managed service identity (system assigned and/or user assigned identities).
:ivar identity: Setting indicating whether the service has a managed identity associated with
it.
:vartype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
"""
_attribute_map = {
"identity": {"key": "identity", "type": "ServiceManagedIdentityIdentity"},
}
def __init__(self, *, identity: Optional["_models.ServiceManagedIdentityIdentity"] = None, **kwargs):
"""
:keyword identity: Setting indicating whether the service has a managed identity associated
with it.
:paramtype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
"""
super().__init__(**kwargs)
self.identity = identity
[docs]class ResourceCore(_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.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar etag: An etag associated with the resource, used for optimistic concurrency when editing
it.
:vartype etag: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$"},
"type": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"etag": {"key": "etag", "type": "str"},
}
def __init__(self, *, etag: Optional[str] = None, **kwargs):
"""
:keyword etag: An etag associated with the resource, used for optimistic concurrency when
editing it.
:paramtype etag: str
"""
super().__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.etag = etag
[docs]class LocationBasedResource(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.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar etag: An etag associated with the resource, used for optimistic concurrency when editing
it.
:vartype etag: str
:ivar location: The resource location.
:vartype location: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$"},
"type": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"etag": {"key": "etag", "type": "str"},
"location": {"key": "location", "type": "str"},
}
def __init__(self, *, etag: Optional[str] = None, location: Optional[str] = None, **kwargs):
"""
:keyword etag: An etag associated with the resource, used for optimistic concurrency when
editing it.
:paramtype etag: str
:keyword location: The resource location.
:paramtype location: str
"""
super().__init__(etag=etag, **kwargs)
self.location = location
[docs]class TaggedResource(ResourceTags, 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.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar etag: An etag associated with the resource, used for optimistic concurrency when editing
it.
:vartype etag: str
:ivar location: The resource location.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$"},
"type": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"etag": {"key": "etag", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
"""
:keyword etag: An etag associated with the resource, used for optimistic concurrency when
editing it.
:paramtype etag: str
:keyword location: The resource location.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(tags=tags, etag=etag, location=location, **kwargs)
self.id = None
self.name = None
self.type = None
self.etag = etag
self.location = location
self.tags = tags
[docs]class DicomService(TaggedResource, ServiceManagedIdentity): # pylint: disable=too-many-instance-attributes
"""The description of Dicom Service.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar identity: Setting indicating whether the service has a managed identity associated with
it.
:vartype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar etag: An etag associated with the resource, used for optimistic concurrency when editing
it.
:vartype etag: str
:ivar location: The resource location.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar system_data: Metadata pertaining to creation and last modification of the resource.
:vartype system_data: ~azure.mgmt.healthcareapis.models.SystemData
:ivar provisioning_state: The provisioning state. Known values are: "Deleting", "Succeeded",
"Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned",
"Moving", "Suspended", "Warned", and "SystemMaintenance".
:vartype provisioning_state: str or ~azure.mgmt.healthcareapis.models.ProvisioningState
:ivar authentication_configuration: Dicom Service authentication configuration.
:vartype authentication_configuration:
~azure.mgmt.healthcareapis.models.DicomServiceAuthenticationConfiguration
:ivar cors_configuration: Dicom Service Cors configuration.
:vartype cors_configuration: ~azure.mgmt.healthcareapis.models.CorsConfiguration
:ivar service_url: The url of the Dicom Services.
:vartype service_url: str
:ivar private_endpoint_connections: The list of private endpoint connections that are set up
for this resource.
:vartype private_endpoint_connections:
list[~azure.mgmt.healthcareapis.models.PrivateEndpointConnection]
:ivar public_network_access: Control permission for data plane traffic coming from public
networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled".
:vartype public_network_access: str or ~azure.mgmt.healthcareapis.models.PublicNetworkAccess
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$"},
"type": {"readonly": True},
"system_data": {"readonly": True},
"provisioning_state": {"readonly": True},
"service_url": {"readonly": True},
"private_endpoint_connections": {"readonly": True},
}
_attribute_map = {
"identity": {"key": "identity", "type": "ServiceManagedIdentityIdentity"},
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"etag": {"key": "etag", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"system_data": {"key": "systemData", "type": "SystemData"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"authentication_configuration": {
"key": "properties.authenticationConfiguration",
"type": "DicomServiceAuthenticationConfiguration",
},
"cors_configuration": {"key": "properties.corsConfiguration", "type": "CorsConfiguration"},
"service_url": {"key": "properties.serviceUrl", "type": "str"},
"private_endpoint_connections": {
"key": "properties.privateEndpointConnections",
"type": "[PrivateEndpointConnection]",
},
"public_network_access": {"key": "properties.publicNetworkAccess", "type": "str"},
}
def __init__(
self,
*,
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
):
"""
:keyword identity: Setting indicating whether the service has a managed identity associated
with it.
:paramtype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:keyword etag: An etag associated with the resource, used for optimistic concurrency when
editing it.
:paramtype etag: str
:keyword location: The resource location.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword authentication_configuration: Dicom Service authentication configuration.
:paramtype authentication_configuration:
~azure.mgmt.healthcareapis.models.DicomServiceAuthenticationConfiguration
:keyword cors_configuration: Dicom Service Cors configuration.
:paramtype cors_configuration: ~azure.mgmt.healthcareapis.models.CorsConfiguration
:keyword public_network_access: Control permission for data plane traffic coming from public
networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled".
:paramtype public_network_access: str or ~azure.mgmt.healthcareapis.models.PublicNetworkAccess
"""
super().__init__(etag=etag, location=location, tags=tags, identity=identity, **kwargs)
self.identity = identity
self.system_data = None
self.provisioning_state = None
self.authentication_configuration = authentication_configuration
self.cors_configuration = cors_configuration
self.service_url = None
self.private_endpoint_connections = None
self.public_network_access = public_network_access
self.id = None
self.name = None
self.type = None
self.etag = etag
self.location = location
self.tags = tags
[docs]class DicomServiceAuthenticationConfiguration(_serialization.Model):
"""Authentication configuration information.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar authority: The authority url for the service.
:vartype authority: str
:ivar audiences: The audiences for the service.
:vartype audiences: list[str]
"""
_validation = {
"authority": {"readonly": True},
"audiences": {"readonly": True},
}
_attribute_map = {
"authority": {"key": "authority", "type": "str"},
"audiences": {"key": "audiences", "type": "[str]"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.authority = None
self.audiences = None
[docs]class DicomServiceCollection(_serialization.Model):
"""The collection of Dicom Services.
:ivar next_link: The link used to get the next page of Dicom Services.
:vartype next_link: str
:ivar value: The list of Dicom Services.
:vartype value: list[~azure.mgmt.healthcareapis.models.DicomService]
"""
_attribute_map = {
"next_link": {"key": "nextLink", "type": "str"},
"value": {"key": "value", "type": "[DicomService]"},
}
def __init__(
self, *, next_link: Optional[str] = None, value: Optional[List["_models.DicomService"]] = None, **kwargs
):
"""
:keyword next_link: The link used to get the next page of Dicom Services.
:paramtype next_link: str
:keyword value: The list of Dicom Services.
:paramtype value: list[~azure.mgmt.healthcareapis.models.DicomService]
"""
super().__init__(**kwargs)
self.next_link = next_link
self.value = value
[docs]class DicomServicePatchResource(ResourceTags, ServiceManagedIdentity):
"""Dicom Service patch properties.
:ivar identity: Setting indicating whether the service has a managed identity associated with
it.
:vartype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
"""
_attribute_map = {
"identity": {"key": "identity", "type": "ServiceManagedIdentityIdentity"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(
self,
*,
identity: Optional["_models.ServiceManagedIdentityIdentity"] = None,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
"""
:keyword identity: Setting indicating whether the service has a managed identity associated
with it.
:paramtype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(tags=tags, identity=identity, **kwargs)
self.identity = identity
self.tags = tags
[docs]class Error(_serialization.Model):
"""Error details.
:ivar error: Error details.
:vartype error: ~azure.mgmt.healthcareapis.models.ErrorDetailsInternal
"""
_attribute_map = {
"error": {"key": "error", "type": "ErrorDetailsInternal"},
}
def __init__(self, *, error: Optional["_models.ErrorDetailsInternal"] = None, **kwargs):
"""
:keyword error: Error details.
:paramtype error: ~azure.mgmt.healthcareapis.models.ErrorDetailsInternal
"""
super().__init__(**kwargs)
self.error = error
[docs]class ErrorDetails(_serialization.Model):
"""Error details.
:ivar error: Error details.
:vartype error: ~azure.mgmt.healthcareapis.models.ErrorDetailsInternal
"""
_attribute_map = {
"error": {"key": "error", "type": "ErrorDetailsInternal"},
}
def __init__(self, *, error: Optional["_models.ErrorDetailsInternal"] = None, **kwargs):
"""
:keyword error: Error details.
:paramtype error: ~azure.mgmt.healthcareapis.models.ErrorDetailsInternal
"""
super().__init__(**kwargs)
self.error = error
[docs]class ErrorDetailsInternal(_serialization.Model):
"""Error details.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar code: The error code.
:vartype code: str
:ivar message: The error message.
:vartype message: str
:ivar target: The target of the particular error.
:vartype target: str
"""
_validation = {
"code": {"readonly": True},
"message": {"readonly": True},
"target": {"readonly": True},
}
_attribute_map = {
"code": {"key": "code", "type": "str"},
"message": {"key": "message", "type": "str"},
"target": {"key": "target", "type": "str"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.code = None
self.message = None
self.target = None
[docs]class FhirService(TaggedResource, ServiceManagedIdentity): # pylint: disable=too-many-instance-attributes
"""The description of Fhir Service.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar identity: Setting indicating whether the service has a managed identity associated with
it.
:vartype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar etag: An etag associated with the resource, used for optimistic concurrency when editing
it.
:vartype etag: str
:ivar location: The resource location.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar kind: The kind of the service. Known values are: "fhir-Stu3" and "fhir-R4".
:vartype kind: str or ~azure.mgmt.healthcareapis.models.FhirServiceKind
:ivar system_data: Metadata pertaining to creation and last modification of the resource.
:vartype system_data: ~azure.mgmt.healthcareapis.models.SystemData
:ivar provisioning_state: The provisioning state. Known values are: "Deleting", "Succeeded",
"Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned",
"Moving", "Suspended", "Warned", and "SystemMaintenance".
:vartype provisioning_state: str or ~azure.mgmt.healthcareapis.models.ProvisioningState
:ivar access_policies: Fhir Service access policies.
:vartype access_policies: list[~azure.mgmt.healthcareapis.models.FhirServiceAccessPolicyEntry]
:ivar acr_configuration: Fhir Service Azure container registry configuration.
:vartype acr_configuration: ~azure.mgmt.healthcareapis.models.FhirServiceAcrConfiguration
:ivar authentication_configuration: Fhir Service authentication configuration.
:vartype authentication_configuration:
~azure.mgmt.healthcareapis.models.FhirServiceAuthenticationConfiguration
:ivar cors_configuration: Fhir Service Cors configuration.
:vartype cors_configuration: ~azure.mgmt.healthcareapis.models.FhirServiceCorsConfiguration
:ivar export_configuration: Fhir Service export configuration.
:vartype export_configuration: ~azure.mgmt.healthcareapis.models.FhirServiceExportConfiguration
:ivar private_endpoint_connections: The list of private endpoint connections that are set up
for this resource.
:vartype private_endpoint_connections:
list[~azure.mgmt.healthcareapis.models.PrivateEndpointConnection]
:ivar public_network_access: Control permission for data plane traffic coming from public
networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled".
:vartype public_network_access: str or ~azure.mgmt.healthcareapis.models.PublicNetworkAccess
:ivar event_state: Fhir Service event support status. Known values are: "Disabled", "Enabled",
and "Updating".
:vartype event_state: str or ~azure.mgmt.healthcareapis.models.ServiceEventState
:ivar resource_version_policy_configuration: Determines tracking of history for resources.
:vartype resource_version_policy_configuration:
~azure.mgmt.healthcareapis.models.ResourceVersionPolicyConfiguration
:ivar import_configuration: Fhir Service import configuration.
:vartype import_configuration: ~azure.mgmt.healthcareapis.models.FhirServiceImportConfiguration
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$"},
"type": {"readonly": True},
"system_data": {"readonly": True},
"provisioning_state": {"readonly": True},
"private_endpoint_connections": {"readonly": True},
"event_state": {"readonly": True},
}
_attribute_map = {
"identity": {"key": "identity", "type": "ServiceManagedIdentityIdentity"},
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"etag": {"key": "etag", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"kind": {"key": "kind", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"access_policies": {"key": "properties.accessPolicies", "type": "[FhirServiceAccessPolicyEntry]"},
"acr_configuration": {"key": "properties.acrConfiguration", "type": "FhirServiceAcrConfiguration"},
"authentication_configuration": {
"key": "properties.authenticationConfiguration",
"type": "FhirServiceAuthenticationConfiguration",
},
"cors_configuration": {"key": "properties.corsConfiguration", "type": "FhirServiceCorsConfiguration"},
"export_configuration": {"key": "properties.exportConfiguration", "type": "FhirServiceExportConfiguration"},
"private_endpoint_connections": {
"key": "properties.privateEndpointConnections",
"type": "[PrivateEndpointConnection]",
},
"public_network_access": {"key": "properties.publicNetworkAccess", "type": "str"},
"event_state": {"key": "properties.eventState", "type": "str"},
"resource_version_policy_configuration": {
"key": "properties.resourceVersionPolicyConfiguration",
"type": "ResourceVersionPolicyConfiguration",
},
"import_configuration": {"key": "properties.importConfiguration", "type": "FhirServiceImportConfiguration"},
}
def __init__(
self,
*,
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
):
"""
:keyword identity: Setting indicating whether the service has a managed identity associated
with it.
:paramtype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:keyword etag: An etag associated with the resource, used for optimistic concurrency when
editing it.
:paramtype etag: str
:keyword location: The resource location.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword kind: The kind of the service. Known values are: "fhir-Stu3" and "fhir-R4".
:paramtype kind: str or ~azure.mgmt.healthcareapis.models.FhirServiceKind
:keyword access_policies: Fhir Service access policies.
:paramtype access_policies:
list[~azure.mgmt.healthcareapis.models.FhirServiceAccessPolicyEntry]
:keyword acr_configuration: Fhir Service Azure container registry configuration.
:paramtype acr_configuration: ~azure.mgmt.healthcareapis.models.FhirServiceAcrConfiguration
:keyword authentication_configuration: Fhir Service authentication configuration.
:paramtype authentication_configuration:
~azure.mgmt.healthcareapis.models.FhirServiceAuthenticationConfiguration
:keyword cors_configuration: Fhir Service Cors configuration.
:paramtype cors_configuration: ~azure.mgmt.healthcareapis.models.FhirServiceCorsConfiguration
:keyword export_configuration: Fhir Service export configuration.
:paramtype export_configuration:
~azure.mgmt.healthcareapis.models.FhirServiceExportConfiguration
:keyword public_network_access: Control permission for data plane traffic coming from public
networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled".
:paramtype public_network_access: str or ~azure.mgmt.healthcareapis.models.PublicNetworkAccess
:keyword resource_version_policy_configuration: Determines tracking of history for resources.
:paramtype resource_version_policy_configuration:
~azure.mgmt.healthcareapis.models.ResourceVersionPolicyConfiguration
:keyword import_configuration: Fhir Service import configuration.
:paramtype import_configuration:
~azure.mgmt.healthcareapis.models.FhirServiceImportConfiguration
"""
super().__init__(etag=etag, location=location, tags=tags, identity=identity, **kwargs)
self.identity = identity
self.kind = kind
self.system_data = None
self.provisioning_state = None
self.access_policies = access_policies
self.acr_configuration = acr_configuration
self.authentication_configuration = authentication_configuration
self.cors_configuration = cors_configuration
self.export_configuration = export_configuration
self.private_endpoint_connections = None
self.public_network_access = public_network_access
self.event_state = None
self.resource_version_policy_configuration = resource_version_policy_configuration
self.import_configuration = import_configuration
self.id = None
self.name = None
self.type = None
self.etag = etag
self.location = location
self.tags = tags
[docs]class FhirServiceAccessPolicyEntry(_serialization.Model):
"""An access policy entry.
All required parameters must be populated in order to send to Azure.
:ivar object_id: An Azure AD object ID (User or Apps) that is allowed access to the FHIR
service. Required.
:vartype object_id: str
"""
_validation = {
"object_id": {
"required": True,
"pattern": r"^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$",
},
}
_attribute_map = {
"object_id": {"key": "objectId", "type": "str"},
}
def __init__(self, *, object_id: str, **kwargs):
"""
:keyword object_id: An Azure AD object ID (User or Apps) that is allowed access to the FHIR
service. Required.
:paramtype object_id: str
"""
super().__init__(**kwargs)
self.object_id = object_id
[docs]class FhirServiceAcrConfiguration(_serialization.Model):
"""Azure container registry configuration information.
:ivar login_servers: The list of the Azure container registry login servers.
:vartype login_servers: list[str]
:ivar oci_artifacts: The list of Open Container Initiative (OCI) artifacts.
:vartype oci_artifacts: list[~azure.mgmt.healthcareapis.models.ServiceOciArtifactEntry]
"""
_attribute_map = {
"login_servers": {"key": "loginServers", "type": "[str]"},
"oci_artifacts": {"key": "ociArtifacts", "type": "[ServiceOciArtifactEntry]"},
}
def __init__(
self,
*,
login_servers: Optional[List[str]] = None,
oci_artifacts: Optional[List["_models.ServiceOciArtifactEntry"]] = None,
**kwargs
):
"""
:keyword login_servers: The list of the Azure container registry login servers.
:paramtype login_servers: list[str]
:keyword oci_artifacts: The list of Open Container Initiative (OCI) artifacts.
:paramtype oci_artifacts: list[~azure.mgmt.healthcareapis.models.ServiceOciArtifactEntry]
"""
super().__init__(**kwargs)
self.login_servers = login_servers
self.oci_artifacts = oci_artifacts
[docs]class FhirServiceAuthenticationConfiguration(_serialization.Model):
"""Authentication configuration information.
:ivar authority: The authority url for the service.
:vartype authority: str
:ivar audience: The audience url for the service.
:vartype audience: str
:ivar smart_proxy_enabled: If the SMART on FHIR proxy is enabled.
:vartype smart_proxy_enabled: bool
"""
_attribute_map = {
"authority": {"key": "authority", "type": "str"},
"audience": {"key": "audience", "type": "str"},
"smart_proxy_enabled": {"key": "smartProxyEnabled", "type": "bool"},
}
def __init__(
self,
*,
authority: Optional[str] = None,
audience: Optional[str] = None,
smart_proxy_enabled: Optional[bool] = None,
**kwargs
):
"""
:keyword authority: The authority url for the service.
:paramtype authority: str
:keyword audience: The audience url for the service.
:paramtype audience: str
:keyword smart_proxy_enabled: If the SMART on FHIR proxy is enabled.
:paramtype smart_proxy_enabled: bool
"""
super().__init__(**kwargs)
self.authority = authority
self.audience = audience
self.smart_proxy_enabled = smart_proxy_enabled
[docs]class FhirServiceCollection(_serialization.Model):
"""A collection of Fhir services.
:ivar next_link: The link used to get the next page of Fhir Services.
:vartype next_link: str
:ivar value: The list of Fhir Services.
:vartype value: list[~azure.mgmt.healthcareapis.models.FhirService]
"""
_attribute_map = {
"next_link": {"key": "nextLink", "type": "str"},
"value": {"key": "value", "type": "[FhirService]"},
}
def __init__(
self, *, next_link: Optional[str] = None, value: Optional[List["_models.FhirService"]] = None, **kwargs
):
"""
:keyword next_link: The link used to get the next page of Fhir Services.
:paramtype next_link: str
:keyword value: The list of Fhir Services.
:paramtype value: list[~azure.mgmt.healthcareapis.models.FhirService]
"""
super().__init__(**kwargs)
self.next_link = next_link
self.value = value
[docs]class FhirServiceCorsConfiguration(_serialization.Model):
"""The settings for the CORS configuration of the service instance.
:ivar origins: The origins to be allowed via CORS.
:vartype origins: list[str]
:ivar headers: The headers to be allowed via CORS.
:vartype headers: list[str]
:ivar methods: The methods to be allowed via CORS.
:vartype methods: list[str]
:ivar max_age: The max age to be allowed via CORS.
:vartype max_age: int
:ivar allow_credentials: If credentials are allowed via CORS.
:vartype allow_credentials: bool
"""
_validation = {
"max_age": {"maximum": 99999, "minimum": 0},
}
_attribute_map = {
"origins": {"key": "origins", "type": "[str]"},
"headers": {"key": "headers", "type": "[str]"},
"methods": {"key": "methods", "type": "[str]"},
"max_age": {"key": "maxAge", "type": "int"},
"allow_credentials": {"key": "allowCredentials", "type": "bool"},
}
def __init__(
self,
*,
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
):
"""
:keyword origins: The origins to be allowed via CORS.
:paramtype origins: list[str]
:keyword headers: The headers to be allowed via CORS.
:paramtype headers: list[str]
:keyword methods: The methods to be allowed via CORS.
:paramtype methods: list[str]
:keyword max_age: The max age to be allowed via CORS.
:paramtype max_age: int
:keyword allow_credentials: If credentials are allowed via CORS.
:paramtype allow_credentials: bool
"""
super().__init__(**kwargs)
self.origins = origins
self.headers = headers
self.methods = methods
self.max_age = max_age
self.allow_credentials = allow_credentials
[docs]class FhirServiceExportConfiguration(_serialization.Model):
"""Export operation configuration information.
:ivar storage_account_name: The name of the default export storage account.
:vartype storage_account_name: str
"""
_attribute_map = {
"storage_account_name": {"key": "storageAccountName", "type": "str"},
}
def __init__(self, *, storage_account_name: Optional[str] = None, **kwargs):
"""
:keyword storage_account_name: The name of the default export storage account.
:paramtype storage_account_name: str
"""
super().__init__(**kwargs)
self.storage_account_name = storage_account_name
[docs]class FhirServiceImportConfiguration(_serialization.Model):
"""Import operation configuration information.
:ivar integration_data_store: The name of the default integration storage account.
:vartype integration_data_store: str
:ivar initial_import_mode: If the FHIR service is in InitialImportMode.
:vartype initial_import_mode: bool
:ivar enabled: If the import operation is enabled.
:vartype enabled: bool
"""
_attribute_map = {
"integration_data_store": {"key": "integrationDataStore", "type": "str"},
"initial_import_mode": {"key": "initialImportMode", "type": "bool"},
"enabled": {"key": "enabled", "type": "bool"},
}
def __init__(
self,
*,
integration_data_store: Optional[str] = None,
initial_import_mode: Optional[bool] = None,
enabled: Optional[bool] = None,
**kwargs
):
"""
:keyword integration_data_store: The name of the default integration storage account.
:paramtype integration_data_store: str
:keyword initial_import_mode: If the FHIR service is in InitialImportMode.
:paramtype initial_import_mode: bool
:keyword enabled: If the import operation is enabled.
:paramtype enabled: bool
"""
super().__init__(**kwargs)
self.integration_data_store = integration_data_store
self.initial_import_mode = initial_import_mode
self.enabled = enabled
[docs]class FhirServicePatchResource(ResourceTags, ServiceManagedIdentity):
"""FhirService patch properties.
:ivar identity: Setting indicating whether the service has a managed identity associated with
it.
:vartype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
"""
_attribute_map = {
"identity": {"key": "identity", "type": "ServiceManagedIdentityIdentity"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(
self,
*,
identity: Optional["_models.ServiceManagedIdentityIdentity"] = None,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
"""
:keyword identity: Setting indicating whether the service has a managed identity associated
with it.
:paramtype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(tags=tags, identity=identity, **kwargs)
self.identity = identity
self.tags = tags
[docs]class IotConnector(TaggedResource, ServiceManagedIdentity): # pylint: disable=too-many-instance-attributes
"""IoT Connector definition.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar identity: Setting indicating whether the service has a managed identity associated with
it.
:vartype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar etag: An etag associated with the resource, used for optimistic concurrency when editing
it.
:vartype etag: str
:ivar location: The resource location.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar system_data: Metadata pertaining to creation and last modification of the resource.
:vartype system_data: ~azure.mgmt.healthcareapis.models.SystemData
:ivar provisioning_state: The provisioning state. Known values are: "Deleting", "Succeeded",
"Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned",
"Moving", "Suspended", "Warned", and "SystemMaintenance".
:vartype provisioning_state: str or ~azure.mgmt.healthcareapis.models.ProvisioningState
:ivar ingestion_endpoint_configuration: Source configuration.
:vartype ingestion_endpoint_configuration:
~azure.mgmt.healthcareapis.models.IotEventHubIngestionEndpointConfiguration
:ivar device_mapping: Device Mappings.
:vartype device_mapping: ~azure.mgmt.healthcareapis.models.IotMappingProperties
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$"},
"type": {"readonly": True},
"system_data": {"readonly": True},
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"identity": {"key": "identity", "type": "ServiceManagedIdentityIdentity"},
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"etag": {"key": "etag", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"system_data": {"key": "systemData", "type": "SystemData"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"ingestion_endpoint_configuration": {
"key": "properties.ingestionEndpointConfiguration",
"type": "IotEventHubIngestionEndpointConfiguration",
},
"device_mapping": {"key": "properties.deviceMapping", "type": "IotMappingProperties"},
}
def __init__(
self,
*,
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
):
"""
:keyword identity: Setting indicating whether the service has a managed identity associated
with it.
:paramtype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:keyword etag: An etag associated with the resource, used for optimistic concurrency when
editing it.
:paramtype etag: str
:keyword location: The resource location.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword ingestion_endpoint_configuration: Source configuration.
:paramtype ingestion_endpoint_configuration:
~azure.mgmt.healthcareapis.models.IotEventHubIngestionEndpointConfiguration
:keyword device_mapping: Device Mappings.
:paramtype device_mapping: ~azure.mgmt.healthcareapis.models.IotMappingProperties
"""
super().__init__(etag=etag, location=location, tags=tags, identity=identity, **kwargs)
self.identity = identity
self.system_data = None
self.provisioning_state = None
self.ingestion_endpoint_configuration = ingestion_endpoint_configuration
self.device_mapping = device_mapping
self.id = None
self.name = None
self.type = None
self.etag = etag
self.location = location
self.tags = tags
[docs]class IotConnectorCollection(_serialization.Model):
"""A collection of IoT Connectors.
:ivar next_link: The link used to get the next page of IoT Connectors.
:vartype next_link: str
:ivar value: The list of IoT Connectors.
:vartype value: list[~azure.mgmt.healthcareapis.models.IotConnector]
"""
_attribute_map = {
"next_link": {"key": "nextLink", "type": "str"},
"value": {"key": "value", "type": "[IotConnector]"},
}
def __init__(
self, *, next_link: Optional[str] = None, value: Optional[List["_models.IotConnector"]] = None, **kwargs
):
"""
:keyword next_link: The link used to get the next page of IoT Connectors.
:paramtype next_link: str
:keyword value: The list of IoT Connectors.
:paramtype value: list[~azure.mgmt.healthcareapis.models.IotConnector]
"""
super().__init__(**kwargs)
self.next_link = next_link
self.value = value
[docs]class IotConnectorPatchResource(ResourceTags, ServiceManagedIdentity):
"""Iot Connector patch properties.
:ivar identity: Setting indicating whether the service has a managed identity associated with
it.
:vartype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
"""
_attribute_map = {
"identity": {"key": "identity", "type": "ServiceManagedIdentityIdentity"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(
self,
*,
identity: Optional["_models.ServiceManagedIdentityIdentity"] = None,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
"""
:keyword identity: Setting indicating whether the service has a managed identity associated
with it.
:paramtype identity: ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityIdentity
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(tags=tags, identity=identity, **kwargs)
self.identity = identity
self.tags = tags
[docs]class IotDestinationProperties(_serialization.Model):
"""Common IoT Connector destination properties.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar provisioning_state: The provisioning state. Known values are: "Deleting", "Succeeded",
"Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned",
"Moving", "Suspended", "Warned", and "SystemMaintenance".
:vartype provisioning_state: str or ~azure.mgmt.healthcareapis.models.ProvisioningState
"""
_validation = {
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"provisioning_state": {"key": "provisioningState", "type": "str"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.provisioning_state = None
[docs]class IotEventHubIngestionEndpointConfiguration(_serialization.Model):
"""Event Hub ingestion endpoint configuration.
:ivar event_hub_name: Event Hub name to connect to.
:vartype event_hub_name: str
:ivar consumer_group: Consumer group of the event hub to connected to.
:vartype consumer_group: str
:ivar fully_qualified_event_hub_namespace: Fully qualified namespace of the Event Hub to
connect to.
:vartype fully_qualified_event_hub_namespace: str
"""
_attribute_map = {
"event_hub_name": {"key": "eventHubName", "type": "str"},
"consumer_group": {"key": "consumerGroup", "type": "str"},
"fully_qualified_event_hub_namespace": {"key": "fullyQualifiedEventHubNamespace", "type": "str"},
}
def __init__(
self,
*,
event_hub_name: Optional[str] = None,
consumer_group: Optional[str] = None,
fully_qualified_event_hub_namespace: Optional[str] = None,
**kwargs
):
"""
:keyword event_hub_name: Event Hub name to connect to.
:paramtype event_hub_name: str
:keyword consumer_group: Consumer group of the event hub to connected to.
:paramtype consumer_group: str
:keyword fully_qualified_event_hub_namespace: Fully qualified namespace of the Event Hub to
connect to.
:paramtype fully_qualified_event_hub_namespace: str
"""
super().__init__(**kwargs)
self.event_hub_name = event_hub_name
self.consumer_group = consumer_group
self.fully_qualified_event_hub_namespace = fully_qualified_event_hub_namespace
[docs]class IotFhirDestination(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.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar etag: An etag associated with the resource, used for optimistic concurrency when editing
it.
:vartype etag: str
:ivar location: The resource location.
:vartype location: str
:ivar system_data: Metadata pertaining to creation and last modification of the resource.
:vartype system_data: ~azure.mgmt.healthcareapis.models.SystemData
:ivar provisioning_state: The provisioning state. Known values are: "Deleting", "Succeeded",
"Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned",
"Moving", "Suspended", "Warned", and "SystemMaintenance".
:vartype provisioning_state: str or ~azure.mgmt.healthcareapis.models.ProvisioningState
:ivar resource_identity_resolution_type: Determines how resource identity is resolved on the
destination. Required. Known values are: "Create" and "Lookup".
:vartype resource_identity_resolution_type: str or
~azure.mgmt.healthcareapis.models.IotIdentityResolutionType
:ivar fhir_service_resource_id: Fully qualified resource id of the FHIR service to connect to.
Required.
:vartype fhir_service_resource_id: str
:ivar fhir_mapping: FHIR Mappings. Required.
:vartype fhir_mapping: ~azure.mgmt.healthcareapis.models.IotMappingProperties
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$"},
"type": {"readonly": True},
"system_data": {"readonly": True},
"provisioning_state": {"readonly": True},
"resource_identity_resolution_type": {"required": True},
"fhir_service_resource_id": {"required": True},
"fhir_mapping": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"etag": {"key": "etag", "type": "str"},
"location": {"key": "location", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"resource_identity_resolution_type": {"key": "properties.resourceIdentityResolutionType", "type": "str"},
"fhir_service_resource_id": {"key": "properties.fhirServiceResourceId", "type": "str"},
"fhir_mapping": {"key": "properties.fhirMapping", "type": "IotMappingProperties"},
}
def __init__(
self,
*,
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
):
"""
:keyword etag: An etag associated with the resource, used for optimistic concurrency when
editing it.
:paramtype etag: str
:keyword location: The resource location.
:paramtype location: str
:keyword resource_identity_resolution_type: Determines how resource identity is resolved on the
destination. Required. Known values are: "Create" and "Lookup".
:paramtype resource_identity_resolution_type: str or
~azure.mgmt.healthcareapis.models.IotIdentityResolutionType
:keyword fhir_service_resource_id: Fully qualified resource id of the FHIR service to connect
to. Required.
:paramtype fhir_service_resource_id: str
:keyword fhir_mapping: FHIR Mappings. Required.
:paramtype fhir_mapping: ~azure.mgmt.healthcareapis.models.IotMappingProperties
"""
super().__init__(etag=etag, location=location, **kwargs)
self.system_data = None
self.provisioning_state = None
self.resource_identity_resolution_type = resource_identity_resolution_type
self.fhir_service_resource_id = fhir_service_resource_id
self.fhir_mapping = fhir_mapping
[docs]class IotFhirDestinationCollection(_serialization.Model):
"""A collection of IoT Connector FHIR destinations.
:ivar next_link: The link used to get the next page of IoT FHIR destinations.
:vartype next_link: str
:ivar value: The list of IoT Connector FHIR destinations.
:vartype value: list[~azure.mgmt.healthcareapis.models.IotFhirDestination]
"""
_attribute_map = {
"next_link": {"key": "nextLink", "type": "str"},
"value": {"key": "value", "type": "[IotFhirDestination]"},
}
def __init__(
self, *, next_link: Optional[str] = None, value: Optional[List["_models.IotFhirDestination"]] = None, **kwargs
):
"""
:keyword next_link: The link used to get the next page of IoT FHIR destinations.
:paramtype next_link: str
:keyword value: The list of IoT Connector FHIR destinations.
:paramtype value: list[~azure.mgmt.healthcareapis.models.IotFhirDestination]
"""
super().__init__(**kwargs)
self.next_link = next_link
self.value = value
[docs]class IotFhirDestinationProperties(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.
:ivar provisioning_state: The provisioning state. Known values are: "Deleting", "Succeeded",
"Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned",
"Moving", "Suspended", "Warned", and "SystemMaintenance".
:vartype provisioning_state: str or ~azure.mgmt.healthcareapis.models.ProvisioningState
:ivar resource_identity_resolution_type: Determines how resource identity is resolved on the
destination. Required. Known values are: "Create" and "Lookup".
:vartype resource_identity_resolution_type: str or
~azure.mgmt.healthcareapis.models.IotIdentityResolutionType
:ivar fhir_service_resource_id: Fully qualified resource id of the FHIR service to connect to.
Required.
:vartype fhir_service_resource_id: str
:ivar fhir_mapping: FHIR Mappings. Required.
:vartype fhir_mapping: ~azure.mgmt.healthcareapis.models.IotMappingProperties
"""
_validation = {
"provisioning_state": {"readonly": True},
"resource_identity_resolution_type": {"required": True},
"fhir_service_resource_id": {"required": True},
"fhir_mapping": {"required": True},
}
_attribute_map = {
"provisioning_state": {"key": "provisioningState", "type": "str"},
"resource_identity_resolution_type": {"key": "resourceIdentityResolutionType", "type": "str"},
"fhir_service_resource_id": {"key": "fhirServiceResourceId", "type": "str"},
"fhir_mapping": {"key": "fhirMapping", "type": "IotMappingProperties"},
}
def __init__(
self,
*,
resource_identity_resolution_type: Union[str, "_models.IotIdentityResolutionType"],
fhir_service_resource_id: str,
fhir_mapping: "_models.IotMappingProperties",
**kwargs
):
"""
:keyword resource_identity_resolution_type: Determines how resource identity is resolved on the
destination. Required. Known values are: "Create" and "Lookup".
:paramtype resource_identity_resolution_type: str or
~azure.mgmt.healthcareapis.models.IotIdentityResolutionType
:keyword fhir_service_resource_id: Fully qualified resource id of the FHIR service to connect
to. Required.
:paramtype fhir_service_resource_id: str
:keyword fhir_mapping: FHIR Mappings. Required.
:paramtype fhir_mapping: ~azure.mgmt.healthcareapis.models.IotMappingProperties
"""
super().__init__(**kwargs)
self.resource_identity_resolution_type = resource_identity_resolution_type
self.fhir_service_resource_id = fhir_service_resource_id
self.fhir_mapping = fhir_mapping
[docs]class IotMappingProperties(_serialization.Model):
"""The mapping content.
:ivar content: The mapping.
:vartype content: JSON
"""
_attribute_map = {
"content": {"key": "content", "type": "object"},
}
def __init__(self, *, content: Optional[JSON] = None, **kwargs):
"""
:keyword content: The mapping.
:paramtype content: JSON
"""
super().__init__(**kwargs)
self.content = content
[docs]class ListOperations(_serialization.Model):
"""Available operations of the service.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: Collection of available operation details.
:vartype value: list[~azure.mgmt.healthcareapis.models.OperationDetail]
:ivar next_link: URL client should use to fetch the next page (per server side paging).
It's null for now, added for future use.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[OperationDetail]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, *, next_link: Optional[str] = None, **kwargs):
"""
:keyword next_link: URL client should use to fetch the next page (per server side paging).
It's null for now, added for future use.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.value = None
self.next_link = next_link
[docs]class LogSpecification(_serialization.Model):
"""Specifications of the Log for Azure Monitoring.
:ivar name: Name of the log.
:vartype name: str
:ivar display_name: Localized friendly display name of the log.
:vartype display_name: str
:ivar blob_duration: Blob duration of the log.
:vartype blob_duration: str
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"display_name": {"key": "displayName", "type": "str"},
"blob_duration": {"key": "blobDuration", "type": "str"},
}
def __init__(
self,
*,
name: Optional[str] = None,
display_name: Optional[str] = None,
blob_duration: Optional[str] = None,
**kwargs
):
"""
:keyword name: Name of the log.
:paramtype name: str
:keyword display_name: Localized friendly display name of the log.
:paramtype display_name: str
:keyword blob_duration: Blob duration of the log.
:paramtype blob_duration: str
"""
super().__init__(**kwargs)
self.name = name
self.display_name = display_name
self.blob_duration = blob_duration
[docs]class MetricDimension(_serialization.Model):
"""Specifications of the Dimension of metrics.
:ivar name: Name of the dimension.
:vartype name: str
:ivar display_name: Localized friendly display name of the dimension.
:vartype display_name: str
:ivar to_be_exported_for_shoebox: Whether this dimension should be included for the Shoebox
export scenario.
:vartype to_be_exported_for_shoebox: bool
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"display_name": {"key": "displayName", "type": "str"},
"to_be_exported_for_shoebox": {"key": "toBeExportedForShoebox", "type": "bool"},
}
def __init__(
self,
*,
name: Optional[str] = None,
display_name: Optional[str] = None,
to_be_exported_for_shoebox: Optional[bool] = None,
**kwargs
):
"""
:keyword name: Name of the dimension.
:paramtype name: str
:keyword display_name: Localized friendly display name of the dimension.
:paramtype display_name: str
:keyword to_be_exported_for_shoebox: Whether this dimension should be included for the Shoebox
export scenario.
:paramtype to_be_exported_for_shoebox: bool
"""
super().__init__(**kwargs)
self.name = name
self.display_name = display_name
self.to_be_exported_for_shoebox = to_be_exported_for_shoebox
[docs]class MetricSpecification(_serialization.Model): # pylint: disable=too-many-instance-attributes
"""Specifications of the Metrics for Azure Monitoring.
:ivar name: Name of the metric.
:vartype name: str
:ivar display_name: Localized friendly display name of the metric.
:vartype display_name: str
:ivar display_description: Localized friendly description of the metric.
:vartype display_description: str
:ivar unit: Unit that makes sense for the metric.
:vartype unit: str
:ivar category: Name of the metric category that the metric belongs to. A metric can only
belong to a single category.
:vartype category: str
:ivar aggregation_type: Only provide one value for this field. Valid values: Average, Minimum,
Maximum, Total, Count.
:vartype aggregation_type: str
:ivar supported_aggregation_types: Supported aggregation types.
:vartype supported_aggregation_types: list[str]
:ivar supported_time_grain_types: Supported time grain types.
:vartype supported_time_grain_types: list[str]
:ivar fill_gap_with_zero: Optional. If set to true, then zero will be returned for time
duration where no metric is emitted/published.
:vartype fill_gap_with_zero: bool
:ivar metric_filter_pattern: Pattern for the filter of the metric.
:vartype metric_filter_pattern: str
:ivar dimensions: Dimensions of the metric.
:vartype dimensions: list[~azure.mgmt.healthcareapis.models.MetricDimension]
:ivar is_internal: Whether the metric is internal.
:vartype is_internal: bool
:ivar source_mdm_account: The source MDM account.
:vartype source_mdm_account: str
:ivar source_mdm_namespace: The source MDM namespace.
:vartype source_mdm_namespace: str
:ivar enable_regional_mdm_account: Whether regional MDM account enabled.
:vartype enable_regional_mdm_account: bool
:ivar resource_id_dimension_name_override: The resource Id dimension name override.
:vartype resource_id_dimension_name_override: str
"""
_attribute_map = {
"name": {"key": "name", "type": "str"},
"display_name": {"key": "displayName", "type": "str"},
"display_description": {"key": "displayDescription", "type": "str"},
"unit": {"key": "unit", "type": "str"},
"category": {"key": "category", "type": "str"},
"aggregation_type": {"key": "aggregationType", "type": "str"},
"supported_aggregation_types": {"key": "supportedAggregationTypes", "type": "[str]"},
"supported_time_grain_types": {"key": "supportedTimeGrainTypes", "type": "[str]"},
"fill_gap_with_zero": {"key": "fillGapWithZero", "type": "bool"},
"metric_filter_pattern": {"key": "metricFilterPattern", "type": "str"},
"dimensions": {"key": "dimensions", "type": "[MetricDimension]"},
"is_internal": {"key": "isInternal", "type": "bool"},
"source_mdm_account": {"key": "sourceMdmAccount", "type": "str"},
"source_mdm_namespace": {"key": "sourceMdmNamespace", "type": "str"},
"enable_regional_mdm_account": {"key": "enableRegionalMdmAccount", "type": "bool"},
"resource_id_dimension_name_override": {"key": "resourceIdDimensionNameOverride", "type": "str"},
}
def __init__(
self,
*,
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
):
"""
:keyword name: Name of the metric.
:paramtype name: str
:keyword display_name: Localized friendly display name of the metric.
:paramtype display_name: str
:keyword display_description: Localized friendly description of the metric.
:paramtype display_description: str
:keyword unit: Unit that makes sense for the metric.
:paramtype unit: str
:keyword category: Name of the metric category that the metric belongs to. A metric can only
belong to a single category.
:paramtype category: str
:keyword aggregation_type: Only provide one value for this field. Valid values: Average,
Minimum, Maximum, Total, Count.
:paramtype aggregation_type: str
:keyword supported_aggregation_types: Supported aggregation types.
:paramtype supported_aggregation_types: list[str]
:keyword supported_time_grain_types: Supported time grain types.
:paramtype supported_time_grain_types: list[str]
:keyword fill_gap_with_zero: Optional. If set to true, then zero will be returned for time
duration where no metric is emitted/published.
:paramtype fill_gap_with_zero: bool
:keyword metric_filter_pattern: Pattern for the filter of the metric.
:paramtype metric_filter_pattern: str
:keyword dimensions: Dimensions of the metric.
:paramtype dimensions: list[~azure.mgmt.healthcareapis.models.MetricDimension]
:keyword is_internal: Whether the metric is internal.
:paramtype is_internal: bool
:keyword source_mdm_account: The source MDM account.
:paramtype source_mdm_account: str
:keyword source_mdm_namespace: The source MDM namespace.
:paramtype source_mdm_namespace: str
:keyword enable_regional_mdm_account: Whether regional MDM account enabled.
:paramtype enable_regional_mdm_account: bool
:keyword resource_id_dimension_name_override: The resource Id dimension name override.
:paramtype resource_id_dimension_name_override: str
"""
super().__init__(**kwargs)
self.name = name
self.display_name = display_name
self.display_description = display_description
self.unit = unit
self.category = category
self.aggregation_type = aggregation_type
self.supported_aggregation_types = supported_aggregation_types
self.supported_time_grain_types = supported_time_grain_types
self.fill_gap_with_zero = fill_gap_with_zero
self.metric_filter_pattern = metric_filter_pattern
self.dimensions = dimensions
self.is_internal = is_internal
self.source_mdm_account = source_mdm_account
self.source_mdm_namespace = source_mdm_namespace
self.enable_regional_mdm_account = enable_regional_mdm_account
self.resource_id_dimension_name_override = resource_id_dimension_name_override
[docs]class OperationDetail(_serialization.Model):
"""Service REST API operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: Name of the operation.
:vartype name: str
:ivar is_data_action: Whether the operation applies to data-plane. This is "true" for
data-plane operations and "false" for ARM/control-plane operations.
:vartype is_data_action: bool
:ivar display: Display of the operation.
:vartype display: ~azure.mgmt.healthcareapis.models.OperationDisplay
:ivar origin: Default value is 'user,system'.
:vartype origin: str
:ivar action_type: Enum. Indicates the action type. "Internal" refers to actions that are for
internal only APIs. "Internal"
:vartype action_type: str or ~azure.mgmt.healthcareapis.models.ActionType
:ivar properties: Properties of the operation.
:vartype properties: ~azure.mgmt.healthcareapis.models.OperationProperties
"""
_validation = {
"name": {"readonly": True},
"is_data_action": {"readonly": True},
"origin": {"readonly": True},
"action_type": {"readonly": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"is_data_action": {"key": "isDataAction", "type": "bool"},
"display": {"key": "display", "type": "OperationDisplay"},
"origin": {"key": "origin", "type": "str"},
"action_type": {"key": "actionType", "type": "str"},
"properties": {"key": "properties", "type": "OperationProperties"},
}
def __init__(
self,
*,
display: Optional["_models.OperationDisplay"] = None,
properties: Optional["_models.OperationProperties"] = None,
**kwargs
):
"""
:keyword display: Display of the operation.
:paramtype display: ~azure.mgmt.healthcareapis.models.OperationDisplay
:keyword properties: Properties of the operation.
:paramtype properties: ~azure.mgmt.healthcareapis.models.OperationProperties
"""
super().__init__(**kwargs)
self.name = None
self.is_data_action = None
self.display = display
self.origin = None
self.action_type = None
self.properties = properties
[docs]class OperationDisplay(_serialization.Model):
"""The object that represents the operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar provider: Service provider: Microsoft.HealthcareApis.
:vartype provider: str
:ivar resource: Resource Type: Services.
:vartype resource: str
:ivar operation: Name of the operation.
:vartype operation: str
:ivar description: Friendly description for the operation,.
:vartype description: str
"""
_validation = {
"provider": {"readonly": True},
"resource": {"readonly": True},
"operation": {"readonly": True},
"description": {"readonly": True},
}
_attribute_map = {
"provider": {"key": "provider", "type": "str"},
"resource": {"key": "resource", "type": "str"},
"operation": {"key": "operation", "type": "str"},
"description": {"key": "description", "type": "str"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.provider = None
self.resource = None
self.operation = None
self.description = None
[docs]class OperationProperties(_serialization.Model):
"""Extra Operation properties.
:ivar service_specification: Service specifications of the operation.
:vartype service_specification: ~azure.mgmt.healthcareapis.models.ServiceSpecification
"""
_attribute_map = {
"service_specification": {"key": "serviceSpecification", "type": "ServiceSpecification"},
}
def __init__(self, *, service_specification: Optional["_models.ServiceSpecification"] = None, **kwargs):
"""
:keyword service_specification: Service specifications of the operation.
:paramtype service_specification: ~azure.mgmt.healthcareapis.models.ServiceSpecification
"""
super().__init__(**kwargs)
self.service_specification = service_specification
[docs]class OperationResultsDescription(_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.
:ivar id: The ID of the operation returned.
:vartype id: str
:ivar name: The name of the operation result.
:vartype name: str
:ivar status: The status of the operation being performed. Known values are: "Canceled",
"Succeeded", "Failed", "Requested", and "Running".
:vartype status: str or ~azure.mgmt.healthcareapis.models.OperationResultStatus
:ivar start_time: The time that the operation was started.
:vartype start_time: str
:ivar end_time: The time that the operation finished.
:vartype end_time: str
:ivar properties: Additional properties of the operation result.
:vartype properties: JSON
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"status": {"readonly": True},
"start_time": {"readonly": True},
"end_time": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"status": {"key": "status", "type": "str"},
"start_time": {"key": "startTime", "type": "str"},
"end_time": {"key": "endTime", "type": "str"},
"properties": {"key": "properties", "type": "object"},
}
def __init__(self, *, properties: Optional[JSON] = None, **kwargs):
"""
:keyword properties: Additional properties of the operation result.
:paramtype properties: JSON
"""
super().__init__(**kwargs)
self.id = None
self.name = None
self.status = None
self.start_time = None
self.end_time = None
self.properties = properties
[docs]class PrivateEndpoint(_serialization.Model):
"""The Private Endpoint resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The ARM identifier for Private Endpoint.
:vartype id: str
"""
_validation = {
"id": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.id = None
[docs]class Resource(_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.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.id = None
self.name = None
self.type = None
[docs]class PrivateEndpointConnection(Resource):
"""The Private Endpoint Connection resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar private_endpoint: The resource of private end point.
:vartype private_endpoint: ~azure.mgmt.healthcareapis.models.PrivateEndpoint
:ivar private_link_service_connection_state: A collection of information about the state of the
connection between service consumer and provider.
:vartype private_link_service_connection_state:
~azure.mgmt.healthcareapis.models.PrivateLinkServiceConnectionState
:ivar provisioning_state: The provisioning state of the private endpoint connection resource.
Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
:vartype provisioning_state: str or
~azure.mgmt.healthcareapis.models.PrivateEndpointConnectionProvisioningState
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"private_endpoint": {"key": "properties.privateEndpoint", "type": "PrivateEndpoint"},
"private_link_service_connection_state": {
"key": "properties.privateLinkServiceConnectionState",
"type": "PrivateLinkServiceConnectionState",
},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
}
def __init__(
self,
*,
private_endpoint: Optional["_models.PrivateEndpoint"] = None,
private_link_service_connection_state: Optional["_models.PrivateLinkServiceConnectionState"] = None,
**kwargs
):
"""
:keyword private_endpoint: The resource of private end point.
:paramtype private_endpoint: ~azure.mgmt.healthcareapis.models.PrivateEndpoint
:keyword private_link_service_connection_state: A collection of information about the state of
the connection between service consumer and provider.
:paramtype private_link_service_connection_state:
~azure.mgmt.healthcareapis.models.PrivateLinkServiceConnectionState
"""
super().__init__(**kwargs)
self.private_endpoint = private_endpoint
self.private_link_service_connection_state = private_link_service_connection_state
self.provisioning_state = None
[docs]class PrivateEndpointConnectionDescription(PrivateEndpointConnection):
"""The Private Endpoint Connection resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar private_endpoint: The resource of private end point.
:vartype private_endpoint: ~azure.mgmt.healthcareapis.models.PrivateEndpoint
:ivar private_link_service_connection_state: A collection of information about the state of the
connection between service consumer and provider.
:vartype private_link_service_connection_state:
~azure.mgmt.healthcareapis.models.PrivateLinkServiceConnectionState
:ivar provisioning_state: The provisioning state of the private endpoint connection resource.
Known values are: "Succeeded", "Creating", "Deleting", and "Failed".
:vartype provisioning_state: str or
~azure.mgmt.healthcareapis.models.PrivateEndpointConnectionProvisioningState
:ivar system_data: Metadata pertaining to creation and last modification of the resource.
:vartype system_data: ~azure.mgmt.healthcareapis.models.SystemData
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"provisioning_state": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"private_endpoint": {"key": "properties.privateEndpoint", "type": "PrivateEndpoint"},
"private_link_service_connection_state": {
"key": "properties.privateLinkServiceConnectionState",
"type": "PrivateLinkServiceConnectionState",
},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"system_data": {"key": "systemData", "type": "SystemData"},
}
def __init__(
self,
*,
private_endpoint: Optional["_models.PrivateEndpoint"] = None,
private_link_service_connection_state: Optional["_models.PrivateLinkServiceConnectionState"] = None,
**kwargs
):
"""
:keyword private_endpoint: The resource of private end point.
:paramtype private_endpoint: ~azure.mgmt.healthcareapis.models.PrivateEndpoint
:keyword private_link_service_connection_state: A collection of information about the state of
the connection between service consumer and provider.
:paramtype private_link_service_connection_state:
~azure.mgmt.healthcareapis.models.PrivateLinkServiceConnectionState
"""
super().__init__(
private_endpoint=private_endpoint,
private_link_service_connection_state=private_link_service_connection_state,
**kwargs
)
self.system_data = None
[docs]class PrivateEndpointConnectionListResult(_serialization.Model):
"""List of private endpoint connection associated with the specified storage account.
:ivar value: Array of private endpoint connections.
:vartype value: list[~azure.mgmt.healthcareapis.models.PrivateEndpointConnection]
"""
_attribute_map = {
"value": {"key": "value", "type": "[PrivateEndpointConnection]"},
}
def __init__(self, *, value: Optional[List["_models.PrivateEndpointConnection"]] = None, **kwargs):
"""
:keyword value: Array of private endpoint connections.
:paramtype value: list[~azure.mgmt.healthcareapis.models.PrivateEndpointConnection]
"""
super().__init__(**kwargs)
self.value = value
[docs]class PrivateEndpointConnectionListResultDescription(_serialization.Model):
"""List of private endpoint connection associated with the specified storage account.
:ivar value: Array of private endpoint connections.
:vartype value: list[~azure.mgmt.healthcareapis.models.PrivateEndpointConnectionDescription]
"""
_attribute_map = {
"value": {"key": "value", "type": "[PrivateEndpointConnectionDescription]"},
}
def __init__(self, *, value: Optional[List["_models.PrivateEndpointConnectionDescription"]] = None, **kwargs):
"""
:keyword value: Array of private endpoint connections.
:paramtype value: list[~azure.mgmt.healthcareapis.models.PrivateEndpointConnectionDescription]
"""
super().__init__(**kwargs)
self.value = value
[docs]class PrivateLinkResource(Resource):
"""A private link resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar group_id: The private link resource group id.
:vartype group_id: str
:ivar required_members: The private link resource required member names.
:vartype required_members: list[str]
:ivar required_zone_names: The private link resource Private link DNS zone name.
:vartype required_zone_names: list[str]
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"group_id": {"readonly": True},
"required_members": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"group_id": {"key": "properties.groupId", "type": "str"},
"required_members": {"key": "properties.requiredMembers", "type": "[str]"},
"required_zone_names": {"key": "properties.requiredZoneNames", "type": "[str]"},
}
def __init__(self, *, required_zone_names: Optional[List[str]] = None, **kwargs):
"""
:keyword required_zone_names: The private link resource Private link DNS zone name.
:paramtype required_zone_names: list[str]
"""
super().__init__(**kwargs)
self.group_id = None
self.required_members = None
self.required_zone_names = required_zone_names
[docs]class PrivateLinkResourceDescription(PrivateLinkResource):
"""The Private Endpoint Connection resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
:vartype id: str
:ivar name: The name of the resource.
:vartype name: str
:ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts".
:vartype type: str
:ivar group_id: The private link resource group id.
:vartype group_id: str
:ivar required_members: The private link resource required member names.
:vartype required_members: list[str]
:ivar required_zone_names: The private link resource Private link DNS zone name.
:vartype required_zone_names: list[str]
:ivar system_data: Metadata pertaining to creation and last modification of the resource.
:vartype system_data: ~azure.mgmt.healthcareapis.models.SystemData
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"group_id": {"readonly": True},
"required_members": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"group_id": {"key": "properties.groupId", "type": "str"},
"required_members": {"key": "properties.requiredMembers", "type": "[str]"},
"required_zone_names": {"key": "properties.requiredZoneNames", "type": "[str]"},
"system_data": {"key": "systemData", "type": "SystemData"},
}
def __init__(self, *, required_zone_names: Optional[List[str]] = None, **kwargs):
"""
:keyword required_zone_names: The private link resource Private link DNS zone name.
:paramtype required_zone_names: list[str]
"""
super().__init__(required_zone_names=required_zone_names, **kwargs)
self.system_data = None
[docs]class PrivateLinkResourceListResultDescription(_serialization.Model):
"""A list of private link resources.
:ivar value: Array of private link resources.
:vartype value: list[~azure.mgmt.healthcareapis.models.PrivateLinkResourceDescription]
"""
_attribute_map = {
"value": {"key": "value", "type": "[PrivateLinkResourceDescription]"},
}
def __init__(self, *, value: Optional[List["_models.PrivateLinkResourceDescription"]] = None, **kwargs):
"""
:keyword value: Array of private link resources.
:paramtype value: list[~azure.mgmt.healthcareapis.models.PrivateLinkResourceDescription]
"""
super().__init__(**kwargs)
self.value = value
[docs]class PrivateLinkServiceConnectionState(_serialization.Model):
"""A collection of information about the state of the connection between service consumer and provider.
:ivar status: Indicates whether the connection has been Approved/Rejected/Removed by the owner
of the service. Known values are: "Pending", "Approved", and "Rejected".
:vartype status: str or
~azure.mgmt.healthcareapis.models.PrivateEndpointServiceConnectionStatus
:ivar description: The reason for approval/rejection of the connection.
:vartype description: str
:ivar actions_required: A message indicating if changes on the service provider require any
updates on the consumer.
:vartype actions_required: str
"""
_attribute_map = {
"status": {"key": "status", "type": "str"},
"description": {"key": "description", "type": "str"},
"actions_required": {"key": "actionsRequired", "type": "str"},
}
def __init__(
self,
*,
status: Optional[Union[str, "_models.PrivateEndpointServiceConnectionStatus"]] = None,
description: Optional[str] = None,
actions_required: Optional[str] = None,
**kwargs
):
"""
:keyword status: Indicates whether the connection has been Approved/Rejected/Removed by the
owner of the service. Known values are: "Pending", "Approved", and "Rejected".
:paramtype status: str or
~azure.mgmt.healthcareapis.models.PrivateEndpointServiceConnectionStatus
:keyword description: The reason for approval/rejection of the connection.
:paramtype description: str
:keyword actions_required: A message indicating if changes on the service provider require any
updates on the consumer.
:paramtype actions_required: str
"""
super().__init__(**kwargs)
self.status = status
self.description = description
self.actions_required = actions_required
[docs]class ResourceVersionPolicyConfiguration(_serialization.Model):
"""The settings for history tracking for FHIR resources.
:ivar default: The default value for tracking history across all resources. Known values are:
"no-version", "versioned", and "versioned-update".
:vartype default: str or ~azure.mgmt.healthcareapis.models.FhirResourceVersionPolicy
:ivar resource_type_overrides: A list of FHIR Resources and their version policy overrides.
:vartype resource_type_overrides: dict[str, str or
~azure.mgmt.healthcareapis.models.FhirResourceVersionPolicy]
"""
_attribute_map = {
"default": {"key": "default", "type": "str"},
"resource_type_overrides": {"key": "resourceTypeOverrides", "type": "{str}"},
}
def __init__(
self,
*,
default: Optional[Union[str, "_models.FhirResourceVersionPolicy"]] = None,
resource_type_overrides: Optional[Dict[str, Union[str, "_models.FhirResourceVersionPolicy"]]] = None,
**kwargs
):
"""
:keyword default: The default value for tracking history across all resources. Known values
are: "no-version", "versioned", and "versioned-update".
:paramtype default: str or ~azure.mgmt.healthcareapis.models.FhirResourceVersionPolicy
:keyword resource_type_overrides: A list of FHIR Resources and their version policy overrides.
:paramtype resource_type_overrides: dict[str, str or
~azure.mgmt.healthcareapis.models.FhirResourceVersionPolicy]
"""
super().__init__(**kwargs)
self.default = default
self.resource_type_overrides = resource_type_overrides
[docs]class ServiceAccessPolicyEntry(_serialization.Model):
"""An access policy entry.
All required parameters must be populated in order to send to Azure.
:ivar object_id: An Azure AD object ID (User or Apps) that is allowed access to the FHIR
service. Required.
:vartype object_id: str
"""
_validation = {
"object_id": {
"required": True,
"pattern": r"^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$",
},
}
_attribute_map = {
"object_id": {"key": "objectId", "type": "str"},
}
def __init__(self, *, object_id: str, **kwargs):
"""
:keyword object_id: An Azure AD object ID (User or Apps) that is allowed access to the FHIR
service. Required.
:paramtype object_id: str
"""
super().__init__(**kwargs)
self.object_id = object_id
[docs]class ServiceAcrConfigurationInfo(_serialization.Model):
"""Azure container registry configuration information.
:ivar login_servers: The list of the ACR login servers.
:vartype login_servers: list[str]
:ivar oci_artifacts: The list of Open Container Initiative (OCI) artifacts.
:vartype oci_artifacts: list[~azure.mgmt.healthcareapis.models.ServiceOciArtifactEntry]
"""
_attribute_map = {
"login_servers": {"key": "loginServers", "type": "[str]"},
"oci_artifacts": {"key": "ociArtifacts", "type": "[ServiceOciArtifactEntry]"},
}
def __init__(
self,
*,
login_servers: Optional[List[str]] = None,
oci_artifacts: Optional[List["_models.ServiceOciArtifactEntry"]] = None,
**kwargs
):
"""
:keyword login_servers: The list of the ACR login servers.
:paramtype login_servers: list[str]
:keyword oci_artifacts: The list of Open Container Initiative (OCI) artifacts.
:paramtype oci_artifacts: list[~azure.mgmt.healthcareapis.models.ServiceOciArtifactEntry]
"""
super().__init__(**kwargs)
self.login_servers = login_servers
self.oci_artifacts = oci_artifacts
[docs]class ServiceAuthenticationConfigurationInfo(_serialization.Model):
"""Authentication configuration information.
:ivar authority: The authority url for the service.
:vartype authority: str
:ivar audience: The audience url for the service.
:vartype audience: str
:ivar smart_proxy_enabled: If the SMART on FHIR proxy is enabled.
:vartype smart_proxy_enabled: bool
"""
_attribute_map = {
"authority": {"key": "authority", "type": "str"},
"audience": {"key": "audience", "type": "str"},
"smart_proxy_enabled": {"key": "smartProxyEnabled", "type": "bool"},
}
def __init__(
self,
*,
authority: Optional[str] = None,
audience: Optional[str] = None,
smart_proxy_enabled: Optional[bool] = None,
**kwargs
):
"""
:keyword authority: The authority url for the service.
:paramtype authority: str
:keyword audience: The audience url for the service.
:paramtype audience: str
:keyword smart_proxy_enabled: If the SMART on FHIR proxy is enabled.
:paramtype smart_proxy_enabled: bool
"""
super().__init__(**kwargs)
self.authority = authority
self.audience = audience
self.smart_proxy_enabled = smart_proxy_enabled
[docs]class ServiceCorsConfigurationInfo(_serialization.Model):
"""The settings for the CORS configuration of the service instance.
:ivar origins: The origins to be allowed via CORS.
:vartype origins: list[str]
:ivar headers: The headers to be allowed via CORS.
:vartype headers: list[str]
:ivar methods: The methods to be allowed via CORS.
:vartype methods: list[str]
:ivar max_age: The max age to be allowed via CORS.
:vartype max_age: int
:ivar allow_credentials: If credentials are allowed via CORS.
:vartype allow_credentials: bool
"""
_validation = {
"max_age": {"maximum": 99999, "minimum": 0},
}
_attribute_map = {
"origins": {"key": "origins", "type": "[str]"},
"headers": {"key": "headers", "type": "[str]"},
"methods": {"key": "methods", "type": "[str]"},
"max_age": {"key": "maxAge", "type": "int"},
"allow_credentials": {"key": "allowCredentials", "type": "bool"},
}
def __init__(
self,
*,
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
):
"""
:keyword origins: The origins to be allowed via CORS.
:paramtype origins: list[str]
:keyword headers: The headers to be allowed via CORS.
:paramtype headers: list[str]
:keyword methods: The methods to be allowed via CORS.
:paramtype methods: list[str]
:keyword max_age: The max age to be allowed via CORS.
:paramtype max_age: int
:keyword allow_credentials: If credentials are allowed via CORS.
:paramtype allow_credentials: bool
"""
super().__init__(**kwargs)
self.origins = origins
self.headers = headers
self.methods = methods
self.max_age = max_age
self.allow_credentials = allow_credentials
[docs]class ServiceCosmosDbConfigurationInfo(_serialization.Model):
"""The settings for the Cosmos DB database backing the service.
:ivar offer_throughput: The provisioned throughput for the backing database.
:vartype offer_throughput: int
:ivar key_vault_key_uri: The URI of the customer-managed key for the backing database.
:vartype key_vault_key_uri: str
"""
_validation = {
"offer_throughput": {"maximum": 10000, "minimum": 400},
}
_attribute_map = {
"offer_throughput": {"key": "offerThroughput", "type": "int"},
"key_vault_key_uri": {"key": "keyVaultKeyUri", "type": "str"},
}
def __init__(self, *, offer_throughput: Optional[int] = None, key_vault_key_uri: Optional[str] = None, **kwargs):
"""
:keyword offer_throughput: The provisioned throughput for the backing database.
:paramtype offer_throughput: int
:keyword key_vault_key_uri: The URI of the customer-managed key for the backing database.
:paramtype key_vault_key_uri: str
"""
super().__init__(**kwargs)
self.offer_throughput = offer_throughput
self.key_vault_key_uri = key_vault_key_uri
[docs]class ServiceExportConfigurationInfo(_serialization.Model):
"""Export operation configuration information.
:ivar storage_account_name: The name of the default export storage account.
:vartype storage_account_name: str
"""
_attribute_map = {
"storage_account_name": {"key": "storageAccountName", "type": "str"},
}
def __init__(self, *, storage_account_name: Optional[str] = None, **kwargs):
"""
:keyword storage_account_name: The name of the default export storage account.
:paramtype storage_account_name: str
"""
super().__init__(**kwargs)
self.storage_account_name = storage_account_name
[docs]class ServiceImportConfigurationInfo(_serialization.Model):
"""Import operation configuration information.
:ivar integration_data_store: The name of the default integration storage account.
:vartype integration_data_store: str
:ivar initial_import_mode: If the FHIR service is in InitialImportMode.
:vartype initial_import_mode: bool
:ivar enabled: If the import operation is enabled.
:vartype enabled: bool
"""
_attribute_map = {
"integration_data_store": {"key": "integrationDataStore", "type": "str"},
"initial_import_mode": {"key": "initialImportMode", "type": "bool"},
"enabled": {"key": "enabled", "type": "bool"},
}
def __init__(
self,
*,
integration_data_store: Optional[str] = None,
initial_import_mode: Optional[bool] = None,
enabled: Optional[bool] = None,
**kwargs
):
"""
:keyword integration_data_store: The name of the default integration storage account.
:paramtype integration_data_store: str
:keyword initial_import_mode: If the FHIR service is in InitialImportMode.
:paramtype initial_import_mode: bool
:keyword enabled: If the import operation is enabled.
:paramtype enabled: bool
"""
super().__init__(**kwargs)
self.integration_data_store = integration_data_store
self.initial_import_mode = initial_import_mode
self.enabled = enabled
[docs]class ServiceManagedIdentityIdentity(_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.
:ivar type: Type of identity being specified, currently SystemAssigned and None are allowed.
Required. Known values are: "None", "SystemAssigned", "UserAssigned", and
"SystemAssigned,UserAssigned".
:vartype type: str or ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityType
:ivar principal_id: The service principal ID of the system assigned identity. This property
will only be provided for a system assigned identity.
:vartype principal_id: str
:ivar tenant_id: The tenant ID of the system assigned identity. This property will only be
provided for a system assigned identity.
:vartype tenant_id: str
:ivar user_assigned_identities: 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.
:vartype user_assigned_identities: dict[str,
~azure.mgmt.healthcareapis.models.UserAssignedIdentity]
"""
_validation = {
"type": {"required": True},
"principal_id": {"readonly": True},
"tenant_id": {"readonly": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"principal_id": {"key": "principalId", "type": "str"},
"tenant_id": {"key": "tenantId", "type": "str"},
"user_assigned_identities": {"key": "userAssignedIdentities", "type": "{UserAssignedIdentity}"},
}
def __init__(
self,
*,
type: Union[str, "_models.ServiceManagedIdentityType"],
user_assigned_identities: Optional[Dict[str, "_models.UserAssignedIdentity"]] = None,
**kwargs
):
"""
:keyword type: Type of identity being specified, currently SystemAssigned and None are allowed.
Required. Known values are: "None", "SystemAssigned", "UserAssigned", and
"SystemAssigned,UserAssigned".
:paramtype type: str or ~azure.mgmt.healthcareapis.models.ServiceManagedIdentityType
:keyword user_assigned_identities: 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.
:paramtype user_assigned_identities: dict[str,
~azure.mgmt.healthcareapis.models.UserAssignedIdentity]
"""
super().__init__(**kwargs)
self.type = type
self.principal_id = None
self.tenant_id = None
self.user_assigned_identities = user_assigned_identities
[docs]class ServiceOciArtifactEntry(_serialization.Model):
"""An Open Container Initiative (OCI) artifact.
:ivar login_server: The Azure Container Registry login server.
:vartype login_server: str
:ivar image_name: The artifact name.
:vartype image_name: str
:ivar digest: The artifact digest.
:vartype digest: str
"""
_attribute_map = {
"login_server": {"key": "loginServer", "type": "str"},
"image_name": {"key": "imageName", "type": "str"},
"digest": {"key": "digest", "type": "str"},
}
def __init__(
self,
*,
login_server: Optional[str] = None,
image_name: Optional[str] = None,
digest: Optional[str] = None,
**kwargs
):
"""
:keyword login_server: The Azure Container Registry login server.
:paramtype login_server: str
:keyword image_name: The artifact name.
:paramtype image_name: str
:keyword digest: The artifact digest.
:paramtype digest: str
"""
super().__init__(**kwargs)
self.login_server = login_server
self.image_name = image_name
self.digest = digest
[docs]class ServicesResource(_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.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar kind: The kind of the service. Required. Known values are: "fhir", "fhir-Stu3", and
"fhir-R4".
:vartype kind: str or ~azure.mgmt.healthcareapis.models.Kind
:ivar location: The resource location. Required.
:vartype location: str
:ivar tags: The resource tags.
:vartype tags: dict[str, str]
:ivar etag: An etag associated with the resource, used for optimistic concurrency when editing
it.
:vartype etag: str
:ivar identity: Setting indicating whether the service has a managed identity associated with
it.
:vartype identity: ~azure.mgmt.healthcareapis.models.ServicesResourceIdentity
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$"},
"type": {"readonly": True},
"kind": {"required": True},
"location": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"kind": {"key": "kind", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"etag": {"key": "etag", "type": "str"},
"identity": {"key": "identity", "type": "ServicesResourceIdentity"},
}
def __init__(
self,
*,
kind: Union[str, "_models.Kind"],
location: str,
tags: Optional[Dict[str, str]] = None,
etag: Optional[str] = None,
identity: Optional["_models.ServicesResourceIdentity"] = None,
**kwargs
):
"""
:keyword kind: The kind of the service. Required. Known values are: "fhir", "fhir-Stu3", and
"fhir-R4".
:paramtype kind: str or ~azure.mgmt.healthcareapis.models.Kind
:keyword location: The resource location. Required.
:paramtype location: str
:keyword tags: The resource tags.
:paramtype tags: dict[str, str]
:keyword etag: An etag associated with the resource, used for optimistic concurrency when
editing it.
:paramtype etag: str
:keyword identity: Setting indicating whether the service has a managed identity associated
with it.
:paramtype identity: ~azure.mgmt.healthcareapis.models.ServicesResourceIdentity
"""
super().__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.kind = kind
self.location = location
self.tags = tags
self.etag = etag
self.identity = identity
[docs]class ServicesDescription(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.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar kind: The kind of the service. Required. Known values are: "fhir", "fhir-Stu3", and
"fhir-R4".
:vartype kind: str or ~azure.mgmt.healthcareapis.models.Kind
:ivar location: The resource location. Required.
:vartype location: str
:ivar tags: The resource tags.
:vartype tags: dict[str, str]
:ivar etag: An etag associated with the resource, used for optimistic concurrency when editing
it.
:vartype etag: str
:ivar identity: Setting indicating whether the service has a managed identity associated with
it.
:vartype identity: ~azure.mgmt.healthcareapis.models.ServicesResourceIdentity
:ivar properties: The common properties of a service.
:vartype properties: ~azure.mgmt.healthcareapis.models.ServicesProperties
:ivar system_data: Metadata pertaining to creation and last modification of the resource.
:vartype system_data: ~azure.mgmt.healthcareapis.models.SystemData
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$"},
"type": {"readonly": True},
"kind": {"required": True},
"location": {"required": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"kind": {"key": "kind", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"etag": {"key": "etag", "type": "str"},
"identity": {"key": "identity", "type": "ServicesResourceIdentity"},
"properties": {"key": "properties", "type": "ServicesProperties"},
"system_data": {"key": "systemData", "type": "SystemData"},
}
def __init__(
self,
*,
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
):
"""
:keyword kind: The kind of the service. Required. Known values are: "fhir", "fhir-Stu3", and
"fhir-R4".
:paramtype kind: str or ~azure.mgmt.healthcareapis.models.Kind
:keyword location: The resource location. Required.
:paramtype location: str
:keyword tags: The resource tags.
:paramtype tags: dict[str, str]
:keyword etag: An etag associated with the resource, used for optimistic concurrency when
editing it.
:paramtype etag: str
:keyword identity: Setting indicating whether the service has a managed identity associated
with it.
:paramtype identity: ~azure.mgmt.healthcareapis.models.ServicesResourceIdentity
:keyword properties: The common properties of a service.
:paramtype properties: ~azure.mgmt.healthcareapis.models.ServicesProperties
"""
super().__init__(kind=kind, location=location, tags=tags, etag=etag, identity=identity, **kwargs)
self.properties = properties
self.system_data = None
[docs]class ServicesDescriptionListResult(_serialization.Model):
"""A list of service description objects with a next link.
:ivar next_link: The link used to get the next page of service description objects.
:vartype next_link: str
:ivar value: A list of service description objects.
:vartype value: list[~azure.mgmt.healthcareapis.models.ServicesDescription]
"""
_attribute_map = {
"next_link": {"key": "nextLink", "type": "str"},
"value": {"key": "value", "type": "[ServicesDescription]"},
}
def __init__(
self, *, next_link: Optional[str] = None, value: Optional[List["_models.ServicesDescription"]] = None, **kwargs
):
"""
:keyword next_link: The link used to get the next page of service description objects.
:paramtype next_link: str
:keyword value: A list of service description objects.
:paramtype value: list[~azure.mgmt.healthcareapis.models.ServicesDescription]
"""
super().__init__(**kwargs)
self.next_link = next_link
self.value = value
[docs]class ServicesNameAvailabilityInfo(_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.
:ivar name_available: The value which indicates whether the provided name is available.
:vartype name_available: bool
:ivar reason: The reason for unavailability. Known values are: "Invalid" and "AlreadyExists".
:vartype reason: str or ~azure.mgmt.healthcareapis.models.ServiceNameUnavailabilityReason
:ivar message: The detailed reason message.
:vartype message: str
"""
_validation = {
"name_available": {"readonly": True},
"reason": {"readonly": True},
}
_attribute_map = {
"name_available": {"key": "nameAvailable", "type": "bool"},
"reason": {"key": "reason", "type": "str"},
"message": {"key": "message", "type": "str"},
}
def __init__(self, *, message: Optional[str] = None, **kwargs):
"""
:keyword message: The detailed reason message.
:paramtype message: str
"""
super().__init__(**kwargs)
self.name_available = None
self.reason = None
self.message = message
[docs]class ServicesPatchDescription(_serialization.Model):
"""The description of the service.
:ivar tags: Instance tags.
:vartype tags: dict[str, str]
:ivar public_network_access: Control permission for data plane traffic coming from public
networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled".
:vartype public_network_access: str or ~azure.mgmt.healthcareapis.models.PublicNetworkAccess
"""
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"public_network_access": {"key": "properties.publicNetworkAccess", "type": "str"},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
public_network_access: Optional[Union[str, "_models.PublicNetworkAccess"]] = None,
**kwargs
):
"""
:keyword tags: Instance tags.
:paramtype tags: dict[str, str]
:keyword public_network_access: Control permission for data plane traffic coming from public
networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled".
:paramtype public_network_access: str or ~azure.mgmt.healthcareapis.models.PublicNetworkAccess
"""
super().__init__(**kwargs)
self.tags = tags
self.public_network_access = public_network_access
[docs]class ServiceSpecification(_serialization.Model):
"""Service specification payload.
:ivar log_specifications: Specifications of the Log for Azure Monitoring.
:vartype log_specifications: list[~azure.mgmt.healthcareapis.models.LogSpecification]
:ivar metric_specifications: Specifications of the Metrics for Azure Monitoring.
:vartype metric_specifications: list[~azure.mgmt.healthcareapis.models.MetricSpecification]
"""
_attribute_map = {
"log_specifications": {"key": "logSpecifications", "type": "[LogSpecification]"},
"metric_specifications": {"key": "metricSpecifications", "type": "[MetricSpecification]"},
}
def __init__(
self,
*,
log_specifications: Optional[List["_models.LogSpecification"]] = None,
metric_specifications: Optional[List["_models.MetricSpecification"]] = None,
**kwargs
):
"""
:keyword log_specifications: Specifications of the Log for Azure Monitoring.
:paramtype log_specifications: list[~azure.mgmt.healthcareapis.models.LogSpecification]
:keyword metric_specifications: Specifications of the Metrics for Azure Monitoring.
:paramtype metric_specifications: list[~azure.mgmt.healthcareapis.models.MetricSpecification]
"""
super().__init__(**kwargs)
self.log_specifications = log_specifications
self.metric_specifications = metric_specifications
[docs]class ServicesProperties(_serialization.Model):
"""The properties of a service instance.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar provisioning_state: The provisioning state. Known values are: "Deleting", "Succeeded",
"Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned",
"Moving", "Suspended", "Warned", and "SystemMaintenance".
:vartype provisioning_state: str or ~azure.mgmt.healthcareapis.models.ProvisioningState
:ivar access_policies: The access policies of the service instance.
:vartype access_policies: list[~azure.mgmt.healthcareapis.models.ServiceAccessPolicyEntry]
:ivar cosmos_db_configuration: The settings for the Cosmos DB database backing the service.
:vartype cosmos_db_configuration:
~azure.mgmt.healthcareapis.models.ServiceCosmosDbConfigurationInfo
:ivar authentication_configuration: The authentication configuration for the service instance.
:vartype authentication_configuration:
~azure.mgmt.healthcareapis.models.ServiceAuthenticationConfigurationInfo
:ivar cors_configuration: The settings for the CORS configuration of the service instance.
:vartype cors_configuration: ~azure.mgmt.healthcareapis.models.ServiceCorsConfigurationInfo
:ivar export_configuration: The settings for the export operation of the service instance.
:vartype export_configuration: ~azure.mgmt.healthcareapis.models.ServiceExportConfigurationInfo
:ivar private_endpoint_connections: The list of private endpoint connections that are set up
for this resource.
:vartype private_endpoint_connections:
list[~azure.mgmt.healthcareapis.models.PrivateEndpointConnection]
:ivar public_network_access: Control permission for data plane traffic coming from public
networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled".
:vartype public_network_access: str or ~azure.mgmt.healthcareapis.models.PublicNetworkAccess
:ivar acr_configuration: The azure container registry settings used for convert data operation
of the service instance.
:vartype acr_configuration: ~azure.mgmt.healthcareapis.models.ServiceAcrConfigurationInfo
:ivar import_configuration: The settings for the import operation of the service instance.
:vartype import_configuration: ~azure.mgmt.healthcareapis.models.ServiceImportConfigurationInfo
"""
_validation = {
"provisioning_state": {"readonly": True},
}
_attribute_map = {
"provisioning_state": {"key": "provisioningState", "type": "str"},
"access_policies": {"key": "accessPolicies", "type": "[ServiceAccessPolicyEntry]"},
"cosmos_db_configuration": {"key": "cosmosDbConfiguration", "type": "ServiceCosmosDbConfigurationInfo"},
"authentication_configuration": {
"key": "authenticationConfiguration",
"type": "ServiceAuthenticationConfigurationInfo",
},
"cors_configuration": {"key": "corsConfiguration", "type": "ServiceCorsConfigurationInfo"},
"export_configuration": {"key": "exportConfiguration", "type": "ServiceExportConfigurationInfo"},
"private_endpoint_connections": {"key": "privateEndpointConnections", "type": "[PrivateEndpointConnection]"},
"public_network_access": {"key": "publicNetworkAccess", "type": "str"},
"acr_configuration": {"key": "acrConfiguration", "type": "ServiceAcrConfigurationInfo"},
"import_configuration": {"key": "importConfiguration", "type": "ServiceImportConfigurationInfo"},
}
def __init__(
self,
*,
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
):
"""
:keyword access_policies: The access policies of the service instance.
:paramtype access_policies: list[~azure.mgmt.healthcareapis.models.ServiceAccessPolicyEntry]
:keyword cosmos_db_configuration: The settings for the Cosmos DB database backing the service.
:paramtype cosmos_db_configuration:
~azure.mgmt.healthcareapis.models.ServiceCosmosDbConfigurationInfo
:keyword authentication_configuration: The authentication configuration for the service
instance.
:paramtype authentication_configuration:
~azure.mgmt.healthcareapis.models.ServiceAuthenticationConfigurationInfo
:keyword cors_configuration: The settings for the CORS configuration of the service instance.
:paramtype cors_configuration: ~azure.mgmt.healthcareapis.models.ServiceCorsConfigurationInfo
:keyword export_configuration: The settings for the export operation of the service instance.
:paramtype export_configuration:
~azure.mgmt.healthcareapis.models.ServiceExportConfigurationInfo
:keyword private_endpoint_connections: The list of private endpoint connections that are set up
for this resource.
:paramtype private_endpoint_connections:
list[~azure.mgmt.healthcareapis.models.PrivateEndpointConnection]
:keyword public_network_access: Control permission for data plane traffic coming from public
networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled".
:paramtype public_network_access: str or ~azure.mgmt.healthcareapis.models.PublicNetworkAccess
:keyword acr_configuration: The azure container registry settings used for convert data
operation of the service instance.
:paramtype acr_configuration: ~azure.mgmt.healthcareapis.models.ServiceAcrConfigurationInfo
:keyword import_configuration: The settings for the import operation of the service instance.
:paramtype import_configuration:
~azure.mgmt.healthcareapis.models.ServiceImportConfigurationInfo
"""
super().__init__(**kwargs)
self.provisioning_state = None
self.access_policies = access_policies
self.cosmos_db_configuration = cosmos_db_configuration
self.authentication_configuration = authentication_configuration
self.cors_configuration = cors_configuration
self.export_configuration = export_configuration
self.private_endpoint_connections = private_endpoint_connections
self.public_network_access = public_network_access
self.acr_configuration = acr_configuration
self.import_configuration = import_configuration
[docs]class ServicesResourceIdentity(_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.
:ivar principal_id: The principal ID of the resource identity.
:vartype principal_id: str
:ivar tenant_id: The tenant ID of the resource.
:vartype tenant_id: str
:ivar type: Type of identity being specified, currently SystemAssigned and None are allowed.
Known values are: "SystemAssigned" and "None".
:vartype type: str or ~azure.mgmt.healthcareapis.models.ManagedServiceIdentityType
"""
_validation = {
"principal_id": {"readonly": True},
"tenant_id": {"readonly": True},
}
_attribute_map = {
"principal_id": {"key": "principalId", "type": "str"},
"tenant_id": {"key": "tenantId", "type": "str"},
"type": {"key": "type", "type": "str"},
}
def __init__(self, *, type: Optional[Union[str, "_models.ManagedServiceIdentityType"]] = None, **kwargs):
"""
:keyword type: Type of identity being specified, currently SystemAssigned and None are allowed.
Known values are: "SystemAssigned" and "None".
:paramtype type: str or ~azure.mgmt.healthcareapis.models.ManagedServiceIdentityType
"""
super().__init__(**kwargs)
self.principal_id = None
self.tenant_id = None
self.type = type
[docs]class SystemData(_serialization.Model):
"""Metadata pertaining to creation and last modification of the resource.
:ivar created_by: The identity that created the resource.
:vartype created_by: str
:ivar created_by_type: The type of identity that created the resource. Known values are:
"User", "Application", "ManagedIdentity", and "Key".
:vartype created_by_type: str or ~azure.mgmt.healthcareapis.models.CreatedByType
:ivar created_at: The timestamp of resource creation (UTC).
:vartype created_at: ~datetime.datetime
:ivar last_modified_by: The identity that last modified the resource.
:vartype last_modified_by: str
:ivar last_modified_by_type: The type of identity that last modified the resource. Known values
are: "User", "Application", "ManagedIdentity", and "Key".
:vartype last_modified_by_type: str or ~azure.mgmt.healthcareapis.models.CreatedByType
:ivar last_modified_at: The timestamp of resource last modification (UTC).
:vartype last_modified_at: ~datetime.datetime
"""
_attribute_map = {
"created_by": {"key": "createdBy", "type": "str"},
"created_by_type": {"key": "createdByType", "type": "str"},
"created_at": {"key": "createdAt", "type": "iso-8601"},
"last_modified_by": {"key": "lastModifiedBy", "type": "str"},
"last_modified_by_type": {"key": "lastModifiedByType", "type": "str"},
"last_modified_at": {"key": "lastModifiedAt", "type": "iso-8601"},
}
def __init__(
self,
*,
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
):
"""
:keyword created_by: The identity that created the resource.
:paramtype created_by: str
:keyword created_by_type: The type of identity that created the resource. Known values are:
"User", "Application", "ManagedIdentity", and "Key".
:paramtype created_by_type: str or ~azure.mgmt.healthcareapis.models.CreatedByType
:keyword created_at: The timestamp of resource creation (UTC).
:paramtype created_at: ~datetime.datetime
:keyword last_modified_by: The identity that last modified the resource.
:paramtype last_modified_by: str
:keyword last_modified_by_type: The type of identity that last modified the resource. Known
values are: "User", "Application", "ManagedIdentity", and "Key".
:paramtype last_modified_by_type: str or ~azure.mgmt.healthcareapis.models.CreatedByType
:keyword last_modified_at: The timestamp of resource last modification (UTC).
:paramtype last_modified_at: ~datetime.datetime
"""
super().__init__(**kwargs)
self.created_by = created_by
self.created_by_type = created_by_type
self.created_at = created_at
self.last_modified_by = last_modified_by
self.last_modified_by_type = last_modified_by_type
self.last_modified_at = last_modified_at
[docs]class UserAssignedIdentity(_serialization.Model):
"""User assigned identity properties.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar principal_id: The principal ID of the assigned identity.
:vartype principal_id: str
:ivar client_id: The client ID of the assigned identity.
:vartype client_id: str
"""
_validation = {
"principal_id": {"readonly": True},
"client_id": {"readonly": True},
}
_attribute_map = {
"principal_id": {"key": "principalId", "type": "str"},
"client_id": {"key": "clientId", "type": "str"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.principal_id = None
self.client_id = None
[docs]class Workspace(TaggedResource):
"""Workspace resource.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar etag: An etag associated with the resource, used for optimistic concurrency when editing
it.
:vartype etag: str
:ivar location: The resource location.
:vartype location: str
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar properties: Workspaces resource specific properties.
:vartype properties: ~azure.mgmt.healthcareapis.models.WorkspaceProperties
:ivar system_data: Metadata pertaining to creation and last modification of the resource.
:vartype system_data: ~azure.mgmt.healthcareapis.models.SystemData
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$"},
"type": {"readonly": True},
"system_data": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"etag": {"key": "etag", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"properties": {"key": "properties", "type": "WorkspaceProperties"},
"system_data": {"key": "systemData", "type": "SystemData"},
}
def __init__(
self,
*,
etag: Optional[str] = None,
location: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
properties: Optional["_models.WorkspaceProperties"] = None,
**kwargs
):
"""
:keyword etag: An etag associated with the resource, used for optimistic concurrency when
editing it.
:paramtype etag: str
:keyword location: The resource location.
:paramtype location: str
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword properties: Workspaces resource specific properties.
:paramtype properties: ~azure.mgmt.healthcareapis.models.WorkspaceProperties
"""
super().__init__(etag=etag, location=location, tags=tags, **kwargs)
self.properties = properties
self.system_data = None
[docs]class WorkspaceList(_serialization.Model):
"""Collection of workspace object with a next link.
:ivar next_link: The link used to get the next page.
:vartype next_link: str
:ivar value: Collection of resources.
:vartype value: list[~azure.mgmt.healthcareapis.models.Workspace]
"""
_attribute_map = {
"next_link": {"key": "nextLink", "type": "str"},
"value": {"key": "value", "type": "[Workspace]"},
}
def __init__(self, *, next_link: Optional[str] = None, value: Optional[List["_models.Workspace"]] = None, **kwargs):
"""
:keyword next_link: The link used to get the next page.
:paramtype next_link: str
:keyword value: Collection of resources.
:paramtype value: list[~azure.mgmt.healthcareapis.models.Workspace]
"""
super().__init__(**kwargs)
self.next_link = next_link
self.value = value
[docs]class WorkspacePatchResource(ResourceTags):
"""Workspace patch properties.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
"""
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(self, *, tags: Optional[Dict[str, str]] = None, **kwargs):
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(tags=tags, **kwargs)
[docs]class WorkspaceProperties(_serialization.Model):
"""Workspaces resource specific properties.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar provisioning_state: The provisioning state. Known values are: "Deleting", "Succeeded",
"Creating", "Accepted", "Verifying", "Updating", "Failed", "Canceled", "Deprovisioned",
"Moving", "Suspended", "Warned", and "SystemMaintenance".
:vartype provisioning_state: str or ~azure.mgmt.healthcareapis.models.ProvisioningState
:ivar private_endpoint_connections: The list of private endpoint connections that are set up
for this resource.
:vartype private_endpoint_connections:
list[~azure.mgmt.healthcareapis.models.PrivateEndpointConnection]
:ivar public_network_access: Control permission for data plane traffic coming from public
networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled".
:vartype public_network_access: str or ~azure.mgmt.healthcareapis.models.PublicNetworkAccess
"""
_validation = {
"provisioning_state": {"readonly": True},
"private_endpoint_connections": {"readonly": True},
}
_attribute_map = {
"provisioning_state": {"key": "provisioningState", "type": "str"},
"private_endpoint_connections": {"key": "privateEndpointConnections", "type": "[PrivateEndpointConnection]"},
"public_network_access": {"key": "publicNetworkAccess", "type": "str"},
}
def __init__(self, *, public_network_access: Optional[Union[str, "_models.PublicNetworkAccess"]] = None, **kwargs):
"""
:keyword public_network_access: Control permission for data plane traffic coming from public
networks while private endpoint is enabled. Known values are: "Enabled" and "Disabled".
:paramtype public_network_access: str or ~azure.mgmt.healthcareapis.models.PublicNetworkAccess
"""
super().__init__(**kwargs)
self.provisioning_state = None
self.private_endpoint_connections = None
self.public_network_access = public_network_access