ServicesOperations Class

ServicesOperations async 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 a new Service or update an exiting Service.

begin_delete

Operation to delete a Service.

begin_update

Operation to update an exiting Service.

check_name_availability

Checks that the resource name is valid and is not already in use.

disable_test_endpoint

Disable test endpoint functionality for a Service.

enable_test_endpoint

Enable test endpoint functionality for a Service.

get

Get a Service and its properties.

list

Handles requests to list all resources in a resource group.

list_by_subscription

Handles requests to list all resources in a subscription.

list_test_keys

List test keys for a Service.

regenerate_test_key

Regenerate a test key for a Service.

begin_create_or_update

Create a new Service or update an exiting Service.

async begin_create_or_update(resource_group_name: str, service_name: str, resource: azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.ServiceResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.ServiceResource]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

resource
ServiceResource
Required

Parameters for the create or update operation.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either ServiceResource or the result of cls(response)

Return type

Exceptions

begin_delete

Operation to delete a Service.

async begin_delete(resource_group_name: str, service_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_update

Operation to update an exiting Service.

async begin_update(resource_group_name: str, service_name: str, resource: azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.ServiceResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.ServiceResource]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

resource
ServiceResource
Required

Parameters for the update operation.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either ServiceResource or the result of cls(response)

Return type

Exceptions

check_name_availability

Checks that the resource name is valid and is not already in use.

async check_name_availability(location: str, availability_parameters: azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.NameAvailabilityParameters, **kwargs: Any) -> azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.NameAvailability

Parameters

location
str
Required

the region.

availability_parameters
NameAvailabilityParameters
Required

Parameters supplied to the operation.

cls
callable

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

Returns

NameAvailability, or the result of cls(response)

Return type

Exceptions

disable_test_endpoint

Disable test endpoint functionality for a Service.

async disable_test_endpoint(resource_group_name: str, service_name: str, **kwargs: Any) -> None

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

enable_test_endpoint

Enable test endpoint functionality for a Service.

async enable_test_endpoint(resource_group_name: str, service_name: str, **kwargs: Any) -> azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.TestKeys

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

cls
callable

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

Returns

TestKeys, or the result of cls(response)

Return type

Exceptions

get

Get a Service and its properties.

async get(resource_group_name: str, service_name: str, **kwargs: Any) -> azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.ServiceResource

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

cls
callable

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

Returns

ServiceResource, or the result of cls(response)

Return type

Exceptions

list

Handles requests to list all resources in a resource group.

list(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.ServiceResourceList]

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

cls
callable

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

Returns

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

Return type

Exceptions

list_by_subscription

Handles requests to list all resources in a subscription.

list_by_subscription(**kwargs: Any) -> AsyncIterable[azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.ServiceResourceList]

Parameters

cls
callable

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

Returns

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

Return type

Exceptions

list_test_keys

List test keys for a Service.

async list_test_keys(resource_group_name: str, service_name: str, **kwargs: Any) -> azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.TestKeys

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

cls
callable

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

Returns

TestKeys, or the result of cls(response)

Return type

Exceptions

regenerate_test_key

Regenerate a test key for a Service.

async regenerate_test_key(resource_group_name: str, service_name: str, regenerate_test_key_request: azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.RegenerateTestKeyRequestPayload, **kwargs: Any) -> azure.mgmt.appplatform.v2020_11_01_preview.models._models_py3.TestKeys

Parameters

resource_group_name
str
Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

service_name
str
Required

The name of the Service resource.

regenerate_test_key_request
RegenerateTestKeyRequestPayload
Required

Parameters for the operation.

cls
callable

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

Returns

TestKeys, or the result of cls(response)

Return type

Exceptions

Attributes

models

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