DomainsOperations Class

Reference

DomainsOperations 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

DomainsOperations

Constructor

DomainsOperations(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	Creates or updates a domain. Description for Creates or updates a domain.
check_availability	Check if a domain is available for registration. Description for Check if a domain is available for registration.
create_or_update_ownership_identifier	Creates an ownership identifier for a domain or updates identifier details for an existing identifier. Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier.
delete	Delete a domain. Description for Delete a domain.
delete_ownership_identifier	Delete ownership identifier for domain. Description for Delete ownership identifier for domain.
get	Get a domain. Description for Get a domain.
get_control_center_sso_request	Generate a single sign-on request for the domain management portal. Description for Generate a single sign-on request for the domain management portal.
get_ownership_identifier	Get ownership identifier for domain. Description for Get ownership identifier for domain.
list	Get all domains in a subscription. Description for Get all domains in a subscription.
list_by_resource_group	Get all domains in a resource group. Description for Get all domains in a resource group.
list_ownership_identifiers	Lists domain ownership identifiers. Description for Lists domain ownership identifiers.
list_recommendations	Get domain name recommendations based on keywords. Description for Get domain name recommendations based on keywords.
renew	Renew a domain. Description for Renew a domain.
update	Creates or updates a domain. Description for Creates or updates a domain.
update_ownership_identifier	Creates an ownership identifier for a domain or updates identifier details for an existing identifier. Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier.

begin_create_or_update

Creates or updates a domain.

Description for Creates or updates a domain.

async begin_create_or_update(resource_group_name: str, domain_name: str, domain: azure.mgmt.web.v2019_08_01.models._models_py3.Domain, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.web.v2019_08_01.models._models_py3.Domain]

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

domain_name: str

Required

Name of the domain.

domain: Domain

Required

Domain registration information.

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

Return type

AsyncLROPoller[Domain]

Exceptions

HttpResponseError

check_availability

Check if a domain is available for registration.

Description for Check if a domain is available for registration.

async check_availability(identifier: azure.mgmt.web.v2019_08_01.models._models_py3.NameIdentifier, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.DomainAvailabilityCheckResult

Parameters

identifier: NameIdentifier

Required

Name of the domain.

cls: callable

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

Returns

DomainAvailabilityCheckResult, or the result of cls(response)

Return type

DomainAvailabilityCheckResult

Exceptions

HttpResponseError

create_or_update_ownership_identifier

Creates an ownership identifier for a domain or updates identifier details for an existing identifier.

Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier.

async create_or_update_ownership_identifier(resource_group_name: str, domain_name: str, name: str, domain_ownership_identifier: azure.mgmt.web.v2019_08_01.models._models_py3.DomainOwnershipIdentifier, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.DomainOwnershipIdentifier

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

domain_name: str

Required

Name of domain.

name: str

Required

Name of identifier.

domain_ownership_identifier: DomainOwnershipIdentifier

Required

A JSON representation of the domain ownership properties.

cls: callable

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

Returns

DomainOwnershipIdentifier, or the result of cls(response)

Return type

DomainOwnershipIdentifier

Exceptions

HttpResponseError

delete

Delete a domain.

Description for Delete a domain.

async delete(resource_group_name: str, domain_name: str, force_hard_delete_domain: Optional[bool] = None, **kwargs: Any) -> None

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

domain_name: str

Required

Name of the domain.

force_hard_delete_domain: bool

default value: None

Specify <code>true</code> to delete the domain immediately. The default is <code>false</code> which deletes the domain after 24 hours.

cls: callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

delete_ownership_identifier

Delete ownership identifier for domain.

Description for Delete ownership identifier for domain.

async delete_ownership_identifier(resource_group_name: str, domain_name: str, name: str, **kwargs: Any) -> None

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

domain_name: str

Required

Name of domain.

name: str

Required

Name of identifier.

cls: callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Get a domain.

Description for Get a domain.

async get(resource_group_name: str, domain_name: str, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.Domain

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

domain_name: str

Required

Name of the domain.

cls: callable

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

Returns

Domain, or the result of cls(response)

Return type

Domain

Exceptions

HttpResponseError

get_control_center_sso_request

Generate a single sign-on request for the domain management portal.

Description for Generate a single sign-on request for the domain management portal.

async get_control_center_sso_request(**kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.DomainControlCenterSsoRequest

Parameters

cls: callable

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

Returns

DomainControlCenterSsoRequest, or the result of cls(response)

Return type

DomainControlCenterSsoRequest

Exceptions

HttpResponseError

get_ownership_identifier

Get ownership identifier for domain.

Description for Get ownership identifier for domain.

async get_ownership_identifier(resource_group_name: str, domain_name: str, name: str, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.DomainOwnershipIdentifier

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

domain_name: str

Required

Name of domain.

name: str

Required

Name of identifier.

cls: callable

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

Returns

DomainOwnershipIdentifier, or the result of cls(response)

Return type

DomainOwnershipIdentifier

Exceptions

HttpResponseError

list

Get all domains in a subscription.

Description for Get all domains in a subscription.

list(**kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.DomainCollection]

Parameters

cls: callable

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

Returns

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

Return type

AsyncItemPaged[DomainCollection]

Exceptions

HttpResponseError

list_by_resource_group

Get all domains in a resource group.

Description for Get all domains in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.DomainCollection]

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

cls: callable

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

Returns

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

Return type

AsyncItemPaged[DomainCollection]

Exceptions

HttpResponseError

list_ownership_identifiers

Lists domain ownership identifiers.

Description for Lists domain ownership identifiers.

list_ownership_identifiers(resource_group_name: str, domain_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.DomainOwnershipIdentifierCollection]

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

domain_name: str

Required

Name of domain.

cls: callable

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

Returns

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

Return type

AsyncItemPaged[DomainOwnershipIdentifierCollection]

Exceptions

HttpResponseError

list_recommendations

Get domain name recommendations based on keywords.

Description for Get domain name recommendations based on keywords.

list_recommendations(parameters: azure.mgmt.web.v2019_08_01.models._models_py3.DomainRecommendationSearchParameters, **kwargs: Any) -> AsyncIterable[azure.mgmt.web.v2019_08_01.models._models_py3.NameIdentifierCollection]

Parameters

parameters: DomainRecommendationSearchParameters

Required

Search parameters for domain name recommendations.

cls: callable

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

Returns

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

Return type

AsyncItemPaged[NameIdentifierCollection]

Exceptions

HttpResponseError

renew

Renew a domain.

Description for Renew a domain.

async renew(resource_group_name: str, domain_name: str, **kwargs: Any) -> None

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

domain_name: str

Required

Name of the domain.

cls: callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

update

Creates or updates a domain.

Description for Creates or updates a domain.

async update(resource_group_name: str, domain_name: str, domain: azure.mgmt.web.v2019_08_01.models._models_py3.DomainPatchResource, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.Domain

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

domain_name: str

Required

Name of the domain.

domain: DomainPatchResource

Required

Domain registration information.

cls: callable

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

Returns

Domain, or the result of cls(response)

Return type

Domain

Exceptions

HttpResponseError

update_ownership_identifier

Creates an ownership identifier for a domain or updates identifier details for an existing identifier.

Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier.

async update_ownership_identifier(resource_group_name: str, domain_name: str, name: str, domain_ownership_identifier: azure.mgmt.web.v2019_08_01.models._models_py3.DomainOwnershipIdentifier, **kwargs: Any) -> azure.mgmt.web.v2019_08_01.models._models_py3.DomainOwnershipIdentifier

Parameters

resource_group_name: str

Required

Name of the resource group to which the resource belongs.

domain_name: str

Required

Name of domain.

name: str

Required

Name of identifier.

domain_ownership_identifier: DomainOwnershipIdentifier

Required

A JSON representation of the domain ownership properties.

cls: callable

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

Returns

DomainOwnershipIdentifier, or the result of cls(response)

Return type

DomainOwnershipIdentifier

Exceptions

HttpResponseError

Attributes

models

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