ServicesOperations Class

ServicesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
ServicesOperations

Constructor

ServicesOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

begin_create_or_update(resource_group_name: str, resource_name: str, service_description: azure.mgmt.healthcareapis.models._models_py3.ServicesDescription, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.healthcareapis.models._models_py3.ServicesDescription]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the service instance.

resource_name
str
Required

The name of the service instance.

service_description
ServicesDescription
Required

The service instance metadata.

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

Exceptions

begin_delete

Delete a service instance.

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

Parameters

resource_group_name
str
Required

The name of the resource group that contains the service instance.

resource_name
str
Required

The name of the service instance.

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

Exceptions

begin_update

Update the metadata of a service instance.

begin_update(resource_group_name: str, resource_name: str, service_patch_description: azure.mgmt.healthcareapis.models._models_py3.ServicesPatchDescription, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.healthcareapis.models._models_py3.ServicesDescription]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the service instance.

resource_name
str
Required

The name of the service instance.

service_patch_description
ServicesPatchDescription
Required

The service instance metadata and security metadata.

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

Exceptions

check_name_availability

Check if a service instance name is available.

check_name_availability(check_name_availability_inputs: azure.mgmt.healthcareapis.models._models_py3.CheckNameAvailabilityParameters, **kwargs: Any) -> azure.mgmt.healthcareapis.models._models_py3.ServicesNameAvailabilityInfo

Parameters

check_name_availability_inputs
CheckNameAvailabilityParameters
Required

Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.

cls
callable

A custom type or function that will be passed the direct response

Returns

ServicesNameAvailabilityInfo, or the result of cls(response)

Return type

Exceptions

get

Get the metadata of a service instance.

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.healthcareapis.models._models_py3.ServicesDescription

Parameters

resource_group_name
str
Required

The name of the resource group that contains the service instance.

resource_name
str
Required

The name of the service instance.

cls
callable

A custom type or function that will be passed the direct response

Returns

ServicesDescription, or the result of cls(response)

Return type

Exceptions

list

Get all the service instances in a subscription.

list(**kwargs: Any) -> Iterable[azure.mgmt.healthcareapis.models._models_py3.ServicesDescriptionListResult]

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

list_by_resource_group

Get all the service instances in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.healthcareapis.models._models_py3.ServicesDescriptionListResult]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the service instance.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

Attributes

models

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