azure.mgmt.web.v2015_04_01.operations module

class azure.mgmt.web.v2015_04_01.operations.DomainsOperations(client, config, serializer, deserializer)[source]

Bases: object

DomainsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – API Version. Constant value: “2015-04-01”.

check_availability(name=None, custom_headers=None, raw=False, **operation_config)[source]

Check if a domain is available for registration.

Check if a domain is available for registration.

Parameters

  • name (str) – Name of the object.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

DomainAvailablilityCheckResult or ClientRawResponse if raw=true

Return type

DomainAvailablilityCheckResult or ClientRawResponse

Raises

CloudError

create_or_update(resource_group_name, domain_name, domain, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates a domain.

Creates or updates a domain.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • domain_name (str) – Name of the domain.

  • domain (Domain) – Domain registration information.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Domain or ClientRawResponse<Domain> if raw==True

Return type

AzureOperationPoller[Domain] or AzureOperationPoller[ClientRawResponse[Domain]]

Raises

CloudError

create_or_update_ownership_identifier(resource_group_name, domain_name, name, kind=None, ownership_id=None, custom_headers=None, raw=False, **operation_config)[source]

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

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

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • domain_name (str) – Name of domain.

  • name (str) – Name of identifier.

  • kind (str) – Kind of resource.

  • ownership_id (str) – Ownership Id.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

DomainOwnershipIdentifier or ClientRawResponse if raw=true

Return type

DomainOwnershipIdentifier or ClientRawResponse

Raises

CloudError

delete(resource_group_name, domain_name, force_hard_delete_domain=None, custom_headers=None, raw=False, **operation_config)[source]

Delete a domain.

Delete a domain.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • domain_name (str) – Name of the domain.

  • force_hard_delete_domain (bool) – Specify <code>true</code> to delete the domain immediately. The default is <code>false</code> which deletes the domain after 24 hours.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

delete_ownership_identifier(resource_group_name, domain_name, name, custom_headers=None, raw=False, **operation_config)[source]

Delete ownership identifier for domain.

Delete ownership identifier for domain.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • domain_name (str) – Name of domain.

  • name (str) – Name of identifier.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, domain_name, custom_headers=None, raw=False, **operation_config)[source]

Get a domain.

Get a domain.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • domain_name (str) – Name of the domain.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Domain or ClientRawResponse if raw=true

Return type

Domain or ClientRawResponse

Raises

CloudError

get_control_center_sso_request(custom_headers=None, raw=False, **operation_config)[source]

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

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

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

DomainControlCenterSsoRequest or ClientRawResponse if raw=true

Return type

DomainControlCenterSsoRequest or ClientRawResponse

Raises

CloudError

get_ownership_identifier(resource_group_name, domain_name, name, custom_headers=None, raw=False, **operation_config)[source]

Get ownership identifier for domain.

Get ownership identifier for domain.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • domain_name (str) – Name of domain.

  • name (str) – Name of identifier.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

DomainOwnershipIdentifier or ClientRawResponse if raw=true

Return type

DomainOwnershipIdentifier or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Get all domains in a subscription.

Get all domains in a subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Domain

Return type

DomainPaged[Domain]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Get all domains in a resource group.

Get all domains in a resource group.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Domain

Return type

DomainPaged[Domain]

Raises

CloudError

list_ownership_identifiers(resource_group_name, domain_name, custom_headers=None, raw=False, **operation_config)[source]

Lists domain ownership identifiers.

Lists domain ownership identifiers.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • domain_name (str) – Name of domain.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of DomainOwnershipIdentifier

Return type

DomainOwnershipIdentifierPaged[DomainOwnershipIdentifier]

Raises

CloudError

list_recommendations(keywords=None, max_domain_recommendations=None, custom_headers=None, raw=False, **operation_config)[source]

Get domain name recommendations based on keywords.

Get domain name recommendations based on keywords.

Parameters

  • keywords (str) – Keywords to be used for generating domain recommendations.

  • max_domain_recommendations (int) – Maximum number of recommendations.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of NameIdentifier

Return type

NameIdentifierPaged[NameIdentifier]

Raises

CloudError

renew(resource_group_name, domain_name, custom_headers=None, raw=False, **operation_config)[source]

Renew a domain.

Renew a domain.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • domain_name (str) – Name of the domain.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ErrorResponseException

update(resource_group_name, domain_name, domain, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a domain.

Creates or updates a domain.

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • domain_name (str) – Name of the domain.

  • domain (DomainPatchResource) – Domain registration information.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Domain or ClientRawResponse if raw=true

Return type

Domain or ClientRawResponse

Raises

CloudError

update_ownership_identifier(resource_group_name, domain_name, name, kind=None, ownership_id=None, custom_headers=None, raw=False, **operation_config)[source]

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

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

Parameters

  • resource_group_name (str) – Name of the resource group to which the resource belongs.

  • domain_name (str) – Name of domain.

  • name (str) – Name of identifier.

  • kind (str) – Kind of resource.

  • ownership_id (str) – Ownership Id.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

DomainOwnershipIdentifier or ClientRawResponse if raw=true

Return type

DomainOwnershipIdentifier or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.web.v2015_04_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2015_04_01/models/__init__.py'>
class azure.mgmt.web.v2015_04_01.operations.TopLevelDomainsOperations(client, config, serializer, deserializer)[source]

Bases: object

TopLevelDomainsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – API Version. Constant value: “2015-04-01”.

get(name, custom_headers=None, raw=False, **operation_config)[source]

Get details of a top-level domain.

Get details of a top-level domain.

Parameters

  • name (str) – Name of the top-level domain.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

TopLevelDomain or ClientRawResponse if raw=true

Return type

TopLevelDomain or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Get all top-level domains supported for registration.

Get all top-level domains supported for registration.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of TopLevelDomain

Return type

TopLevelDomainPaged[TopLevelDomain]

Raises

CloudError

list_agreements(name, include_privacy=None, for_transfer=None, custom_headers=None, raw=False, **operation_config)[source]

Gets all legal agreements that user needs to accept before purchasing a domain.

Gets all legal agreements that user needs to accept before purchasing a domain.

Parameters

  • name (str) – Name of the top-level domain.

  • include_privacy (bool) – If <code>true</code>, then the list of agreements will include agreements for domain privacy as well; otherwise, <code>false</code>.

  • for_transfer (bool) – If <code>true</code>, then the list of agreements will include agreements for domain transfer as well; otherwise, <code>false</code>.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of TldLegalAgreement

Return type

TldLegalAgreementPaged[TldLegalAgreement]

Raises

CloudError

models = <module 'azure.mgmt.web.v2015_04_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2015_04_01/models/__init__.py'>
class azure.mgmt.web.v2015_04_01.operations.DomainRegistrationProviderOperations(client, config, serializer, deserializer)[source]

Bases: object

DomainRegistrationProviderOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – API Version. Constant value: “2015-04-01”.

list_operations(custom_headers=None, raw=False, **operation_config)[source]

Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider.

Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of CsmOperationDescription

Return type

CsmOperationDescriptionPaged[CsmOperationDescription]

Raises

CloudError

models = <module 'azure.mgmt.web.v2015_04_01.models' from '/home/vsts/work/1/s/sdk/appservice/azure-mgmt-web/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/web/v2015_04_01/models/__init__.py'>