ServicesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

HealthcareApisManagementClient's

<xref:services> attribute.

Inheritance

builtins.object

ServicesOperations

Constructor

ServicesOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update the metadata of a service instance.
begin_delete	Delete a service instance.
begin_update	Update the metadata of a service instance.
check_name_availability	Check if a service instance name is available.
get	Get the metadata of a service instance.
list	Get all the service instances in a subscription.
list_by_resource_group	Get all the service instances in a resource group.

begin_create_or_update

Create or update the metadata of a service instance.

async begin_create_or_update(resource_group_name: str, resource_name: str, service_description: _models.ServicesDescription, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ServicesDescription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
resource_name Required	str The name of the service instance. Required.
service_description Required	ServicesDescription or IO[bytes] The service instance metadata. Is either a ServicesDescription type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ServicesDescription]	An instance of AsyncLROPoller that returns either ServicesDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete a service instance.

async begin_delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
resource_name Required	str The name of the service instance. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Update the metadata of a service instance.

async begin_update(resource_group_name: str, resource_name: str, service_patch_description: _models.ServicesPatchDescription, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ServicesDescription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
resource_name Required	str The name of the service instance. Required.
service_patch_description Required	ServicesPatchDescription or IO[bytes] The service instance metadata and security metadata. Is either a ServicesPatchDescription type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ServicesDescription]	An instance of AsyncLROPoller that returns either ServicesDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

check_name_availability

Check if a service instance name is available.

async check_name_availability(check_name_availability_inputs: _models.CheckNameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ServicesNameAvailabilityInfo

Parameters

Name	Description
check_name_availability_inputs Required	CheckNameAvailabilityParameters or IO[bytes] Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check. Is either a CheckNameAvailabilityParameters type or a IO[bytes] type. Required.

Returns

Type	Description
ServicesNameAvailabilityInfo	ServicesNameAvailabilityInfo or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get the metadata of a service instance.

async get(resource_group_name: str, resource_name: str, **kwargs: Any) -> ServicesDescription

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.
resource_name Required	str The name of the service instance. Required.

Returns

Type	Description
ServicesDescription	ServicesDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Get all the service instances in a subscription.

list(**kwargs: Any) -> AsyncIterable[ServicesDescription]

Returns

Type	Description
AsyncItemPaged[ServicesDescription]	An iterator like instance of either ServicesDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get all the service instances in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[ServicesDescription]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the service instance. Required.

Returns

Type	Description
AsyncItemPaged[ServicesDescription]	An iterator like instance of either ServicesDescription or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.healthcareapis.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\healthcareapis\\models\\__init__.py'>