azure.mgmt.healthcareapis.operations module

class azure.mgmt.healthcareapis.operations.ServicesOperations(client, config, serializer, deserializer)[source]

Bases: object

ServicesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the API. Constant value: “2018-08-20-preview”.

check_name_availability(name, type, custom_headers=None, raw=False, **operation_config)[source]

Check if a service instance name is available.

Parameters

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

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ServicesNameAvailabilityInfo or ClientRawResponse if raw=true

Return type

ServicesNameAvailabilityInfo or ClientRawResponse

Raises

ErrorDetailsException

create_or_update(resource_group_name, resource_name, service_description, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

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

  • service_description (ServicesDescription) – The service instance metadata.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServicesDescription or ClientRawResponse<ServicesDescription> if raw==True

Return type

AzureOperationPoller[ServicesDescription] or AzureOperationPoller[ClientRawResponse[ServicesDescription]]

Raises

ErrorDetailsException

delete(resource_group_name, resource_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Delete a service instance.

Parameters

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

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ErrorDetailsException

get(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)[source]

Get the metadata of a service instance.

Parameters

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

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ServicesDescription or ClientRawResponse if raw=true

Return type

ServicesDescription or ClientRawResponse

Raises

ErrorDetailsException

list(custom_headers=None, raw=False, **operation_config)[source]

Get all the service instances in a subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServicesDescription

Return type

ServicesDescriptionPaged[ServicesDescription]

Raises

ErrorDetailsException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[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.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServicesDescription

Return type

ServicesDescriptionPaged[ServicesDescription]

Raises

ErrorDetailsException

update(resource_group_name, resource_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Update the metadata of a service instance.

Parameters

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

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

  • tags (dict[str, str]) – Instance tags

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServicesDescription or ClientRawResponse<ServicesDescription> if raw==True

Return type

AzureOperationPoller[ServicesDescription] or AzureOperationPoller[ClientRawResponse[ServicesDescription]]

Raises

ErrorDetailsException

models = <module 'azure.mgmt.healthcareapis.models' from '/home/vsts/work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the API. Constant value: “2018-08-20-preview”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all of the available Healthcare service REST API operations.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Operation

Return type

OperationPaged[Operation]

Raises

ErrorDetailsException

models = <module 'azure.mgmt.healthcareapis.models' from '/home/vsts/work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>
class azure.mgmt.healthcareapis.operations.OperationResultsOperations(client, config, serializer, deserializer)[source]

Bases: object

OperationResultsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The version of the API. Constant value: “2018-08-20-preview”.

get(location_name, operation_result_id, custom_headers=None, raw=False, **operation_config)[source]

Get the operation result for a long running operation.

Parameters

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

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

object or ClientRawResponse

Raises

ErrorDetailsException

models = <module 'azure.mgmt.healthcareapis.models' from '/home/vsts/work/1/s/sdk/healthcareapis/azure-mgmt-healthcareapis/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/healthcareapis/models/__init__.py'>