CustomDomainsOperations Class

CustomDomainsOperations 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
CustomDomainsOperations

Constructor

CustomDomainsOperations(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 custom domain of one lifecycle application.

begin_delete

Delete the custom domain of one lifecycle application.

begin_update

Update custom domain of one lifecycle application.

get

Get the custom domain of one lifecycle application.

list

List the custom domains of one lifecycle application.

begin_create_or_update

Create or update custom domain of one lifecycle application.

async begin_create_or_update(resource_group_name: str, service_name: str, app_name: str, domain_name: str, domain_resource: azure.mgmt.appplatform.v2021_09_01_preview.models._models_py3.CustomDomainResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appplatform.v2021_09_01_preview.models._models_py3.CustomDomainResource]

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.

app_name
str
Required

The name of the App resource.

domain_name
str
Required

The name of the custom domain resource.

domain_resource
CustomDomainResource
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 CustomDomainResource or the result of cls(response)

Return type

Exceptions

begin_delete

Delete the custom domain of one lifecycle application.

async begin_delete(resource_group_name: str, service_name: str, app_name: str, domain_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.

app_name
str
Required

The name of the App resource.

domain_name
str
Required

The name of the custom domain 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

Update custom domain of one lifecycle application.

async begin_update(resource_group_name: str, service_name: str, app_name: str, domain_name: str, domain_resource: azure.mgmt.appplatform.v2021_09_01_preview.models._models_py3.CustomDomainResource, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appplatform.v2021_09_01_preview.models._models_py3.CustomDomainResource]

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.

app_name
str
Required

The name of the App resource.

domain_name
str
Required

The name of the custom domain resource.

domain_resource
CustomDomainResource
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 CustomDomainResource or the result of cls(response)

Return type

Exceptions

get

Get the custom domain of one lifecycle application.

async get(resource_group_name: str, service_name: str, app_name: str, domain_name: str, **kwargs: Any) -> azure.mgmt.appplatform.v2021_09_01_preview.models._models_py3.CustomDomainResource

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.

app_name
str
Required

The name of the App resource.

domain_name
str
Required

The name of the custom domain resource.

cls
callable

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

Returns

CustomDomainResource, or the result of cls(response)

Return type

Exceptions

list

List the custom domains of one lifecycle application.

list(resource_group_name: str, service_name: str, app_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.appplatform.v2021_09_01_preview.models._models_py3.CustomDomainResourceCollection]

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.

app_name
str
Required

The name of the App resource.

cls
callable

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

Returns

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

Return type

Exceptions

Attributes

models

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