azure.mgmt.healthcareapis.operations module

class azure.mgmt.healthcareapis.operations.DicomServicesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s dicom_services attribute.

begin_create_or_update(resource_group_name: str, workspace_name: str, dicom_service_name: str, dicomservice: _models.DicomService, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DicomService][source]
begin_create_or_update(resource_group_name: str, workspace_name: str, dicom_service_name: str, dicomservice: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DicomService]

Creates or updates a DICOM Service resource with the specified parameters.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • dicom_service_name (str) – The name of DICOM Service resource. Required.

  • dicomservice (DicomService or IO) – The parameters for creating or updating a Dicom Service resource. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DicomService or the result of cls(response)

Return type

LROPoller[DicomService]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, dicom_service_name: str, workspace_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes a DICOM Service.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • dicom_service_name (str) – The name of DICOM Service resource. Required.

  • workspace_name (str) – The name of workspace resource. Required.

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, dicom_service_name: str, workspace_name: str, dicomservice_patch_resource: _models.DicomServicePatchResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DicomService][source]
begin_update(resource_group_name: str, dicom_service_name: str, workspace_name: str, dicomservice_patch_resource: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DicomService]

Patch DICOM Service details.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • dicom_service_name (str) – The name of DICOM Service resource. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • dicomservice_patch_resource (DicomServicePatchResource or IO) – The parameters for updating a Dicom Service. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DicomService or the result of cls(response)

Return type

LROPoller[DicomService]

Raises

HttpResponseError –

get(resource_group_name: str, workspace_name: str, dicom_service_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.DicomService[source]

Gets the properties of the specified DICOM Service.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • dicom_service_name (str) – The name of DICOM Service resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DicomService or the result of cls(response)

Return type

DicomService

Raises

HttpResponseError –

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.DicomService][source]

Lists all DICOM Services for the given workspace.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DicomService or the result of cls(response)

Return type

ItemPaged[DicomService]

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.FhirDestinationsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s fhir_destinations attribute.

list_by_iot_connector(resource_group_name: str, workspace_name: str, iot_connector_name: str, **kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.IotFhirDestination][source]

Lists all FHIR destinations for the given IoT Connector.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • iot_connector_name (str) – The name of IoT Connector resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IotFhirDestination or the result of cls(response)

Return type

ItemPaged[IotFhirDestination]

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.FhirServicesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s fhir_services attribute.

begin_create_or_update(resource_group_name: str, workspace_name: str, fhir_service_name: str, fhirservice: _models.FhirService, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FhirService][source]
begin_create_or_update(resource_group_name: str, workspace_name: str, fhir_service_name: str, fhirservice: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FhirService]

Creates or updates a FHIR Service resource with the specified parameters.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • fhir_service_name (str) – The name of FHIR Service resource. Required.

  • fhirservice (FhirService or IO) – The parameters for creating or updating a Fhir Service resource. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either FhirService or the result of cls(response)

Return type

LROPoller[FhirService]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, fhir_service_name: str, workspace_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes a FHIR Service.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • fhir_service_name (str) – The name of FHIR Service resource. Required.

  • workspace_name (str) – The name of workspace resource. Required.

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, fhir_service_name: str, workspace_name: str, fhirservice_patch_resource: _models.FhirServicePatchResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FhirService][source]
begin_update(resource_group_name: str, fhir_service_name: str, workspace_name: str, fhirservice_patch_resource: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FhirService]

Patch FHIR Service details.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • fhir_service_name (str) – The name of FHIR Service resource. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • fhirservice_patch_resource (FhirServicePatchResource or IO) – The parameters for updating a Fhir Service. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either FhirService or the result of cls(response)

Return type

LROPoller[FhirService]

Raises

HttpResponseError –

get(resource_group_name: str, workspace_name: str, fhir_service_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.FhirService[source]

Gets the properties of the specified FHIR Service.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • fhir_service_name (str) – The name of FHIR Service resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

FhirService or the result of cls(response)

Return type

FhirService

Raises

HttpResponseError –

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.FhirService][source]

Lists all FHIR Services for the given workspace.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either FhirService or the result of cls(response)

Return type

ItemPaged[FhirService]

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.IotConnectorFhirDestinationOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s iot_connector_fhir_destination attribute.

begin_create_or_update(resource_group_name: str, workspace_name: str, iot_connector_name: str, fhir_destination_name: str, iot_fhir_destination: _models.IotFhirDestination, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.IotFhirDestination][source]
begin_create_or_update(resource_group_name: str, workspace_name: str, iot_connector_name: str, fhir_destination_name: str, iot_fhir_destination: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.IotFhirDestination]

Creates or updates an IoT Connector FHIR destination resource with the specified parameters.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • iot_connector_name (str) – The name of IoT Connector resource. Required.

  • fhir_destination_name (str) – The name of IoT Connector FHIR destination resource. Required.

  • iot_fhir_destination (IotFhirDestination or IO) – The parameters for creating or updating an IoT Connector FHIR destination resource. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either IotFhirDestination or the result of cls(response)

Return type

LROPoller[IotFhirDestination]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, workspace_name: str, iot_connector_name: str, fhir_destination_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an IoT Connector FHIR destination.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • iot_connector_name (str) – The name of IoT Connector resource. Required.

  • fhir_destination_name (str) – The name of IoT Connector FHIR destination resource. Required.

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, workspace_name: str, iot_connector_name: str, fhir_destination_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.IotFhirDestination[source]

Gets the properties of the specified Iot Connector FHIR destination.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • iot_connector_name (str) – The name of IoT Connector resource. Required.

  • fhir_destination_name (str) – The name of IoT Connector FHIR destination resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IotFhirDestination or the result of cls(response)

Return type

IotFhirDestination

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.IotConnectorsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s iot_connectors attribute.

begin_create_or_update(resource_group_name: str, workspace_name: str, iot_connector_name: str, iot_connector: _models.IotConnector, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.IotConnector][source]
begin_create_or_update(resource_group_name: str, workspace_name: str, iot_connector_name: str, iot_connector: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.IotConnector]

Creates or updates an IoT Connector resource with the specified parameters.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • iot_connector_name (str) – The name of IoT Connector resource. Required.

  • iot_connector (IotConnector or IO) – The parameters for creating or updating an IoT Connectors resource. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either IotConnector or the result of cls(response)

Return type

LROPoller[IotConnector]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, iot_connector_name: str, workspace_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes an IoT Connector.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • iot_connector_name (str) – The name of IoT Connector resource. Required.

  • workspace_name (str) – The name of workspace resource. Required.

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, iot_connector_name: str, workspace_name: str, iot_connector_patch_resource: _models.IotConnectorPatchResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.IotConnector][source]
begin_update(resource_group_name: str, iot_connector_name: str, workspace_name: str, iot_connector_patch_resource: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.IotConnector]

Patch an IoT Connector.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • iot_connector_name (str) – The name of IoT Connector resource. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • iot_connector_patch_resource (IotConnectorPatchResource or IO) – The parameters for updating an IoT Connector. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either IotConnector or the result of cls(response)

Return type

LROPoller[IotConnector]

Raises

HttpResponseError –

get(resource_group_name: str, workspace_name: str, iot_connector_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.IotConnector[source]

Gets the properties of the specified IoT Connector.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • iot_connector_name (str) – The name of IoT Connector resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IotConnector or the result of cls(response)

Return type

IotConnector

Raises

HttpResponseError –

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.IotConnector][source]

Lists all IoT Connectors for the given workspace.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IotConnector or the result of cls(response)

Return type

ItemPaged[IotConnector]

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.OperationResultsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s operation_results attribute.

get(location_name: str, operation_result_id: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.OperationResultsDescription[source]

Get the operation result for a long running operation.

Parameters

  • location_name (str) – The location of the operation. Required.

  • operation_result_id (str) – The ID of the operation result to get. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OperationResultsDescription or the result of cls(response)

Return type

OperationResultsDescription

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.OperationDetail][source]

Lists all of the available operations supported by Microsoft Healthcare resource provider.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either OperationDetail or the result of cls(response)

Return type

ItemPaged[OperationDetail]

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s private_endpoint_connections attribute.

begin_create_or_update(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, properties: _models.PrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnectionDescription][source]
begin_create_or_update(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnectionDescription]

Update the state of the specified private endpoint connection associated with the service.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

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

  • private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

  • properties (PrivateEndpointConnection or IO) – The private endpoint connection properties. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PrivateEndpointConnectionDescription or the result of cls(response)

Return type

LROPoller[PrivateEndpointConnectionDescription]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes a private endpoint connection.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

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

  • private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, resource_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.PrivateEndpointConnectionDescription[source]

Gets the specified private endpoint connection associated with the service.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

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

  • private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateEndpointConnectionDescription or the result of cls(response)

Return type

PrivateEndpointConnectionDescription

Raises

HttpResponseError –

list_by_service(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.PrivateEndpointConnectionDescription][source]

Lists all private endpoint connections for a service.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateEndpointConnectionDescription or the result of cls(response)

Return type

ItemPaged[PrivateEndpointConnectionDescription]

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s private_link_resources attribute.

get(resource_group_name: str, resource_name: str, group_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.PrivateLinkResourceDescription[source]

Gets a private link resource that need to be created for a service.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

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

  • group_name (str) – The name of the private link resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateLinkResourceDescription or the result of cls(response)

Return type

PrivateLinkResourceDescription

Raises

HttpResponseError –

list_by_service(resource_group_name: str, resource_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.PrivateLinkResourceListResultDescription[source]

Gets the private link resources that need to be created for a service.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateLinkResourceListResultDescription or the result of cls(response)

Return type

PrivateLinkResourceListResultDescription

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.ServicesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s services attribute.

begin_create_or_update(resource_group_name: str, resource_name: str, service_description: _models.ServicesDescription, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServicesDescription][source]
begin_create_or_update(resource_group_name: str, resource_name: str, service_description: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServicesDescription]

Create or update the metadata of a service instance.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

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

  • service_description (ServicesDescription or IO) – The service instance metadata. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServicesDescription or the result of cls(response)

Return type

LROPoller[ServicesDescription]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Delete a service instance.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

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

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, resource_name: str, service_patch_description: _models.ServicesPatchDescription, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServicesDescription][source]
begin_update(resource_group_name: str, resource_name: str, service_patch_description: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServicesDescription]

Update the metadata of a service instance.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

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

  • service_patch_description (ServicesPatchDescription or IO) – The service instance metadata and security metadata. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServicesDescription or the result of cls(response)

Return type

LROPoller[ServicesDescription]

Raises

HttpResponseError –

check_name_availability(check_name_availability_inputs: _models.CheckNameAvailabilityParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServicesNameAvailabilityInfo[source]
check_name_availability(check_name_availability_inputs: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServicesNameAvailabilityInfo

Check if a service instance name is available.

Parameters

check_name_availability_inputs (CheckNameAvailabilityParameters or IO) – Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

ServicesNameAvailabilityInfo or the result of cls(response)

Return type

ServicesNameAvailabilityInfo

Raises

HttpResponseError –

get(resource_group_name: str, resource_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.ServicesDescription[source]

Get the metadata of a service instance.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServicesDescription or the result of cls(response)

Return type

ServicesDescription

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.ServicesDescription][source]

Get all the service instances in a subscription.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServicesDescription or the result of cls(response)

Return type

ItemPaged[ServicesDescription]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.ServicesDescription][source]

Get all the service instances in a resource group.

Parameters

resource_group_name (str) – The name of the resource group that contains the service instance. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServicesDescription or the result of cls(response)

Return type

ItemPaged[ServicesDescription]

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.WorkspacePrivateEndpointConnectionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s workspace_private_endpoint_connections attribute.

begin_create_or_update(resource_group_name: str, workspace_name: str, private_endpoint_connection_name: str, properties: _models.PrivateEndpointConnectionDescription, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnectionDescription][source]
begin_create_or_update(resource_group_name: str, workspace_name: str, private_endpoint_connection_name: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnectionDescription]

Update the state of the specified private endpoint connection associated with the workspace.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

  • properties (PrivateEndpointConnectionDescription or IO) – The private endpoint connection properties. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PrivateEndpointConnectionDescription or the result of cls(response)

Return type

LROPoller[PrivateEndpointConnectionDescription]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, workspace_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes a private endpoint connection.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, workspace_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.PrivateEndpointConnectionDescription[source]

Gets the specified private endpoint connection associated with the workspace.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateEndpointConnectionDescription or the result of cls(response)

Return type

PrivateEndpointConnectionDescription

Raises

HttpResponseError –

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.PrivateEndpointConnectionDescription][source]

Lists all private endpoint connections for a workspace.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateEndpointConnectionDescription or the result of cls(response)

Return type

ItemPaged[PrivateEndpointConnectionDescription]

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.WorkspacePrivateLinkResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s workspace_private_link_resources attribute.

get(resource_group_name: str, workspace_name: str, group_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.PrivateLinkResourceDescription[source]

Gets a private link resource that need to be created for a workspace.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • group_name (str) – The name of the private link resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateLinkResourceDescription or the result of cls(response)

Return type

PrivateLinkResourceDescription

Raises

HttpResponseError –

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.PrivateLinkResourceDescription][source]

Gets the private link resources that need to be created for a workspace.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateLinkResourceDescription or the result of cls(response)

Return type

ItemPaged[PrivateLinkResourceDescription]

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.WorkspacesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through HealthcareApisManagementClient’s workspaces attribute.

begin_create_or_update(resource_group_name: str, workspace_name: str, workspace: _models.Workspace, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Workspace][source]
begin_create_or_update(resource_group_name: str, workspace_name: str, workspace: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Workspace]

Creates or updates a workspace resource with the specified parameters.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • workspace (Workspace or IO) – The parameters for creating or updating a healthcare workspace. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Workspace or the result of cls(response)

Return type

LROPoller[Workspace]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, workspace_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes a specified workspace.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, workspace_name: str, workspace_patch_resource: _models.WorkspacePatchResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Workspace][source]
begin_update(resource_group_name: str, workspace_name: str, workspace_patch_resource: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Workspace]

Patch workspace details.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

  • workspace_patch_resource (WorkspacePatchResource or IO) – The parameters for updating a specified workspace. Is either a model type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Workspace or the result of cls(response)

Return type

LROPoller[Workspace]

Raises

HttpResponseError –

get(resource_group_name: str, workspace_name: str, **kwargs: Any) → azure.mgmt.healthcareapis.models._models_py3.Workspace[source]

Gets the properties of the specified workspace.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the service instance. Required.

  • workspace_name (str) – The name of workspace resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Workspace or the result of cls(response)

Return type

Workspace

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.Workspace][source]

Lists all the available workspaces under the specified resource group.

Parameters

resource_group_name (str) – The name of the resource group that contains the service instance. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Workspace or the result of cls(response)

Return type

ItemPaged[Workspace]

Raises

HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.healthcareapis.models._models_py3.Workspace][source]

Lists all the available workspaces under the specified subscription.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Workspace or the result of cls(response)

Return type

ItemPaged[Workspace]

Raises

HttpResponseError –

models = <module 'azure.mgmt.healthcareapis.models' from '/mnt/vss/_work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>