ServicesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AppPlatformManagementClient's

<xref:services> attribute.

Inheritance

builtins.object

ServicesOperations

Constructor

ServicesOperations(*args, **kwargs)

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.

begin_create_or_update(resource_group_name: str, service_name: str, resource: _models.ServiceResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ServiceResource]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name Required	str The name of the Service resource. Required.
resource Required	ServiceResource or IO Parameters for the create or update operation. Is either a ServiceResource type or a IO type. Required.

Keyword-Only Parameters

Name	Description
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

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Operation to delete a Service.

begin_delete(resource_group_name: str, service_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name Required	str The name of the Service resource. Required.

Keyword-Only Parameters

Name	Description
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

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

Exceptions

Type	Description
HttpResponseError

begin_update

Operation to update an exiting Service.

begin_update(resource_group_name: str, service_name: str, resource: _models.ServiceResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ServiceResource]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name Required	str The name of the Service resource. Required.
resource Required	ServiceResource or IO Parameters for the update operation. Is either a ServiceResource type or a IO type. Required.

Keyword-Only Parameters

Name	Description
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

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

Exceptions

Type	Description
HttpResponseError

check_name_availability

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

check_name_availability(location: str, availability_parameters: _models.NameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NameAvailability

Parameters

Name	Description
location Required	str the region. Required.
availability_parameters Required	NameAvailabilityParameters or IO Parameters supplied to the operation. Is either a NameAvailabilityParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
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

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

Exceptions

Type	Description
HttpResponseError

disable_test_endpoint

Disable test endpoint functionality for a Service.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name Required	str The name of the Service resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

enable_test_endpoint

Enable test endpoint functionality for a Service.

enable_test_endpoint(resource_group_name: str, service_name: str, **kwargs: Any) -> TestKeys

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name Required	str The name of the Service resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Get a Service and its properties.

get(resource_group_name: str, service_name: str, **kwargs: Any) -> ServiceResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name Required	str The name of the Service resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Handles requests to list all resources in a resource group.

list(resource_group_name: str, **kwargs: Any) -> Iterable[ServiceResource]

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Handles requests to list all resources in a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[ServiceResource]

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

list_test_keys

List test keys for a Service.

list_test_keys(resource_group_name: str, service_name: str, **kwargs: Any) -> TestKeys

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name Required	str The name of the Service resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

regenerate_test_key

Regenerate a test key for a Service.

regenerate_test_key(resource_group_name: str, service_name: str, regenerate_test_key_request: _models.RegenerateTestKeyRequestPayload, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TestKeys

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
service_name Required	str The name of the Service resource. Required.
regenerate_test_key_request Required	RegenerateTestKeyRequestPayload or IO Parameters for the operation. Is either a RegenerateTestKeyRequestPayload type or a IO type. Required.

Keyword-Only Parameters

Name	Description
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

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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