Share via

CustomDomainsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AppPlatformManagementClient's

<xref:custom_domains> attribute.

Inheritance
builtins.object
CustomDomainsOperations

Constructor

CustomDomainsOperations(*args, **kwargs)

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.

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

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.
app_name
Required
str

The name of the App resource. Required.
domain_name
Required
str

The name of the custom domain resource. Required.
domain_resource
Required
CustomDomainResource or IO[bytes]

Parameters for the create or update operation. Is either a CustomDomainResource type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[CustomDomainResource]

An instance of LROPoller that returns either CustomDomainResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete the custom domain of one lifecycle application.

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

The name of the App resource. Required.
domain_name
Required
str

The name of the custom domain resource. Required.

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

Update custom domain of one lifecycle application.

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

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.
app_name
Required
str

The name of the App resource. Required.
domain_name
Required
str

The name of the custom domain resource. Required.
domain_resource
Required
CustomDomainResource or IO[bytes]

Parameters for the create or update operation. Is either a CustomDomainResource type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[CustomDomainResource]

An instance of LROPoller that returns either CustomDomainResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get the custom domain of one lifecycle application.

get(resource_group_name: str, service_name: str, app_name: str, domain_name: str, **kwargs: Any) -> CustomDomainResource

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.
app_name
Required
str

The name of the App resource. Required.
domain_name
Required
str

The name of the custom domain resource. Required.

Returns

Type Description
CustomDomainResource

CustomDomainResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List the custom domains of one lifecycle application.

list(resource_group_name: str, service_name: str, app_name: str, **kwargs: Any) -> Iterable[CustomDomainResource]

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.
app_name
Required
str

The name of the App resource. Required.

Returns

Type Description
ItemPaged[CustomDomainResource]

An iterator like instance of either CustomDomainResource 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'>