Domains interface

Package:

@azure/arm-appservice

Interface representing a Domains.

Methods

beginCreateOrUpdate(string, string, Domain, DomainsCreateOrUpdateOptionalParams)	Description for Creates or updates a domain.
beginCreateOrUpdateAndWait(string, string, Domain, DomainsCreateOrUpdateOptionalParams)	Description for Creates or updates a domain.
checkAvailability(NameIdentifier, DomainsCheckAvailabilityOptionalParams)	Description for Check if a domain is available for registration.
createOrUpdateOwnershipIdentifier(string, string, string, DomainOwnershipIdentifier, DomainsCreateOrUpdateOwnershipIdentifierOptionalParams)	Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier
delete(string, string, DomainsDeleteOptionalParams)	Description for Delete a domain.
deleteOwnershipIdentifier(string, string, string, DomainsDeleteOwnershipIdentifierOptionalParams)	Description for Delete ownership identifier for domain
get(string, string, DomainsGetOptionalParams)	Description for Get a domain.
getControlCenterSsoRequest(DomainsGetControlCenterSsoRequestOptionalParams)	Description for Generate a single sign-on request for the domain management portal.
getOwnershipIdentifier(string, string, string, DomainsGetOwnershipIdentifierOptionalParams)	Description for Get ownership identifier for domain
list(DomainsListOptionalParams)	Description for Get all domains in a subscription.
listByResourceGroup(string, DomainsListByResourceGroupOptionalParams)	Description for Get all domains in a resource group.
listOwnershipIdentifiers(string, string, DomainsListOwnershipIdentifiersOptionalParams)	Description for Lists domain ownership identifiers.
listRecommendations(DomainRecommendationSearchParameters, DomainsListRecommendationsOptionalParams)	Description for Get domain name recommendations based on keywords.
renew(string, string, DomainsRenewOptionalParams)	Description for Renew a domain.
transferOut(string, string, DomainsTransferOutOptionalParams)	Transfer out domain to another registrar
update(string, string, DomainPatchResource, DomainsUpdateOptionalParams)	Description for Creates or updates a domain.
updateOwnershipIdentifier(string, string, string, DomainOwnershipIdentifier, DomainsUpdateOwnershipIdentifierOptionalParams)	Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier

Method Details

beginCreateOrUpdate(string, string, Domain, DomainsCreateOrUpdateOptionalParams)

Description for Creates or updates a domain.

function beginCreateOrUpdate(resourceGroupName: string, domainName: string, domain: Domain, options?: DomainsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Domain>, Domain>>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of the domain.

domain

Domain

Domain registration information.

options

DomainsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Domain>, Domain>>

beginCreateOrUpdateAndWait(string, string, Domain, DomainsCreateOrUpdateOptionalParams)

Description for Creates or updates a domain.

function beginCreateOrUpdateAndWait(resourceGroupName: string, domainName: string, domain: Domain, options?: DomainsCreateOrUpdateOptionalParams): Promise<Domain>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of the domain.

domain

Domain

Domain registration information.

options

DomainsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Domain>

checkAvailability(NameIdentifier, DomainsCheckAvailabilityOptionalParams)

Description for Check if a domain is available for registration.

function checkAvailability(identifier: NameIdentifier, options?: DomainsCheckAvailabilityOptionalParams): Promise<DomainAvailabilityCheckResult>

Parameters

identifier

NameIdentifier

Name of the domain.

options

DomainsCheckAvailabilityOptionalParams

The options parameters.

Returns

Promise<DomainAvailabilityCheckResult>

createOrUpdateOwnershipIdentifier(string, string, string, DomainOwnershipIdentifier, DomainsCreateOrUpdateOwnershipIdentifierOptionalParams)

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

function createOrUpdateOwnershipIdentifier(resourceGroupName: string, domainName: string, name: string, domainOwnershipIdentifier: DomainOwnershipIdentifier, options?: DomainsCreateOrUpdateOwnershipIdentifierOptionalParams): Promise<DomainOwnershipIdentifier>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of domain.

name

string

Name of identifier.

domainOwnershipIdentifier

DomainOwnershipIdentifier

A JSON representation of the domain ownership properties.

options

DomainsCreateOrUpdateOwnershipIdentifierOptionalParams

The options parameters.

Returns

Promise<DomainOwnershipIdentifier>

delete(string, string, DomainsDeleteOptionalParams)

Description for Delete a domain.

function delete(resourceGroupName: string, domainName: string, options?: DomainsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of the domain.

options

DomainsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

deleteOwnershipIdentifier(string, string, string, DomainsDeleteOwnershipIdentifierOptionalParams)

Description for Delete ownership identifier for domain

function deleteOwnershipIdentifier(resourceGroupName: string, domainName: string, name: string, options?: DomainsDeleteOwnershipIdentifierOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of domain.

name

string

Name of identifier.

options

DomainsDeleteOwnershipIdentifierOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, DomainsGetOptionalParams)

Description for Get a domain.

function get(resourceGroupName: string, domainName: string, options?: DomainsGetOptionalParams): Promise<Domain>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of the domain.

options

DomainsGetOptionalParams

The options parameters.

Returns

Promise<Domain>

getControlCenterSsoRequest(DomainsGetControlCenterSsoRequestOptionalParams)

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

function getControlCenterSsoRequest(options?: DomainsGetControlCenterSsoRequestOptionalParams): Promise<DomainControlCenterSsoRequest>

Parameters

options

DomainsGetControlCenterSsoRequestOptionalParams

The options parameters.

Returns

Promise<DomainControlCenterSsoRequest>

getOwnershipIdentifier(string, string, string, DomainsGetOwnershipIdentifierOptionalParams)

Description for Get ownership identifier for domain

function getOwnershipIdentifier(resourceGroupName: string, domainName: string, name: string, options?: DomainsGetOwnershipIdentifierOptionalParams): Promise<DomainOwnershipIdentifier>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of domain.

name

string

Name of identifier.

options

DomainsGetOwnershipIdentifierOptionalParams

The options parameters.

Returns

Promise<DomainOwnershipIdentifier>

list(DomainsListOptionalParams)

Description for Get all domains in a subscription.

function list(options?: DomainsListOptionalParams): PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

Parameters

options

DomainsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

listByResourceGroup(string, DomainsListByResourceGroupOptionalParams)

Description for Get all domains in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: DomainsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

options

DomainsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Domain, Domain[], PageSettings>

listOwnershipIdentifiers(string, string, DomainsListOwnershipIdentifiersOptionalParams)

Description for Lists domain ownership identifiers.

function listOwnershipIdentifiers(resourceGroupName: string, domainName: string, options?: DomainsListOwnershipIdentifiersOptionalParams): PagedAsyncIterableIterator<DomainOwnershipIdentifier, DomainOwnershipIdentifier[], PageSettings>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of domain.

options

DomainsListOwnershipIdentifiersOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DomainOwnershipIdentifier, DomainOwnershipIdentifier[], PageSettings>

listRecommendations(DomainRecommendationSearchParameters, DomainsListRecommendationsOptionalParams)

Description for Get domain name recommendations based on keywords.

function listRecommendations(parameters: DomainRecommendationSearchParameters, options?: DomainsListRecommendationsOptionalParams): PagedAsyncIterableIterator<NameIdentifier, NameIdentifier[], PageSettings>

Parameters

parameters

DomainRecommendationSearchParameters

Search parameters for domain name recommendations.

options

DomainsListRecommendationsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NameIdentifier, NameIdentifier[], PageSettings>

renew(string, string, DomainsRenewOptionalParams)

Description for Renew a domain.

function renew(resourceGroupName: string, domainName: string, options?: DomainsRenewOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of the domain.

options

DomainsRenewOptionalParams

The options parameters.

Returns

Promise<void>

transferOut(string, string, DomainsTransferOutOptionalParams)

Transfer out domain to another registrar

function transferOut(resourceGroupName: string, domainName: string, options?: DomainsTransferOutOptionalParams): Promise<Domain>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of domain.

options

DomainsTransferOutOptionalParams

The options parameters.

Returns

Promise<Domain>

update(string, string, DomainPatchResource, DomainsUpdateOptionalParams)

Description for Creates or updates a domain.

function update(resourceGroupName: string, domainName: string, domain: DomainPatchResource, options?: DomainsUpdateOptionalParams): Promise<Domain>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of the domain.

domain

DomainPatchResource

Domain registration information.

options

DomainsUpdateOptionalParams

The options parameters.

Returns

Promise<Domain>

updateOwnershipIdentifier(string, string, string, DomainOwnershipIdentifier, DomainsUpdateOwnershipIdentifierOptionalParams)

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

function updateOwnershipIdentifier(resourceGroupName: string, domainName: string, name: string, domainOwnershipIdentifier: DomainOwnershipIdentifier, options?: DomainsUpdateOwnershipIdentifierOptionalParams): Promise<DomainOwnershipIdentifier>

Parameters

resourceGroupName

string

Name of the resource group to which the resource belongs.

domainName

string

Name of domain.

name

string

Name of identifier.

domainOwnershipIdentifier

DomainOwnershipIdentifier

A JSON representation of the domain ownership properties.

options

DomainsUpdateOwnershipIdentifierOptionalParams

The options parameters.

Returns

Promise<DomainOwnershipIdentifier>