DomainsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:domains> attribute.
- Inheritance
-
builtins.objectDomainsOperations
Constructor
DomainsOperations(*args, **kwargs)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. |
| transfer_out |
Transfer out domain to another registrar. Transfer out domain to another registrar. |
| 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.
begin_create_or_update(resource_group_name: str, domain_name: str, domain: _models.Domain, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Domain]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of the domain. Required. |
|
domain
Required
|
Domain registration information. Is either a Domain type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either Domain or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
check_availability
Check if a domain is available for registration.
Description for Check if a domain is available for registration.
check_availability(identifier: _models.NameIdentifier, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DomainAvailabilityCheckResultParameters
| Name | Description |
|---|---|
|
identifier
Required
|
Name of the domain. Is either a NameIdentifier type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
DomainAvailabilityCheckResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.
create_or_update_ownership_identifier(resource_group_name: str, domain_name: str, name: str, domain_ownership_identifier: _models.DomainOwnershipIdentifier, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DomainOwnershipIdentifierParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of domain. Required. |
|
name
Required
|
Name of identifier. Required. |
|
domain_ownership_identifier
Required
|
A JSON representation of the domain ownership properties. Is either a DomainOwnershipIdentifier type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
DomainOwnershipIdentifier or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Delete a domain.
Description for Delete a domain.
delete(resource_group_name: str, domain_name: str, force_hard_delete_domain: bool | None = None, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of the domain. Required. |
|
force_hard_delete_domain
Required
|
Specify |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete_ownership_identifier
Delete ownership identifier for domain.
Description for Delete ownership identifier for domain.
delete_ownership_identifier(resource_group_name: str, domain_name: str, name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of domain. Required. |
|
name
Required
|
Name of identifier. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get a domain.
Description for Get a domain.
get(resource_group_name: str, domain_name: str, **kwargs: Any) -> DomainParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of the domain. Required. |
Returns
| Type | Description |
|---|---|
|
Domain or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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_control_center_sso_request(**kwargs: Any) -> DomainControlCenterSsoRequestReturns
| Type | Description |
|---|---|
|
DomainControlCenterSsoRequest or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_ownership_identifier
Get ownership identifier for domain.
Description for Get ownership identifier for domain.
get_ownership_identifier(resource_group_name: str, domain_name: str, name: str, **kwargs: Any) -> DomainOwnershipIdentifierParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of domain. Required. |
|
name
Required
|
Name of identifier. Required. |
Returns
| Type | Description |
|---|---|
|
DomainOwnershipIdentifier or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Get all domains in a subscription.
Description for Get all domains in a subscription.
list(**kwargs: Any) -> Iterable[Domain]Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Domain or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> Iterable[Domain]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Domain or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> Iterable[DomainOwnershipIdentifier]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of domain. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either DomainOwnershipIdentifier or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_recommendations
Get domain name recommendations based on keywords.
Description for Get domain name recommendations based on keywords.
list_recommendations(parameters: _models.DomainRecommendationSearchParameters, *, content_type: str = 'application/json', **kwargs: Any) -> Iterable['_models.NameIdentifier']Parameters
| Name | Description |
|---|---|
|
parameters
Required
|
Search parameters for domain name recommendations. Is either a DomainRecommendationSearchParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either NameIdentifier or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
renew
Renew a domain.
Description for Renew a domain.
renew(resource_group_name: str, domain_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of the domain. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
transfer_out
Transfer out domain to another registrar.
Transfer out domain to another registrar.
transfer_out(resource_group_name: str, domain_name: str, **kwargs: Any) -> DomainParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of domain. Required. |
Returns
| Type | Description |
|---|---|
|
Domain or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update
Creates or updates a domain.
Description for Creates or updates a domain.
update(resource_group_name: str, domain_name: str, domain: _models.DomainPatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DomainParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of the domain. Required. |
|
domain
Required
|
Domain registration information. Is either a DomainPatchResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
Domain or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.
update_ownership_identifier(resource_group_name: str, domain_name: str, name: str, domain_ownership_identifier: _models.DomainOwnershipIdentifier, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DomainOwnershipIdentifierParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the resource group to which the resource belongs. Required. |
|
domain_name
Required
|
Name of domain. Required. |
|
name
Required
|
Name of identifier. Required. |
|
domain_ownership_identifier
Required
|
A JSON representation of the domain ownership properties. Is either a DomainOwnershipIdentifier type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
DomainOwnershipIdentifier or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.web.v2022_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2022_09_01\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for