DomainsOperations interface

Package:

@azure/arm-domainregistration

Interface representing a Domains operations.

Properties

checkAvailability	Description for Check if a domain is available for registration.
createOrUpdate	Description for Creates or updates a domain.
createOrUpdateOwnershipIdentifier	Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier
delete
deleteOwnershipIdentifier	Description for Delete ownership identifier for domain
get	Description for Get a domain.
getControlCenterSsoRequest	Description for Generate a single sign-on request for the domain management portal.
getOwnershipIdentifier	Description for Get ownership identifier for domain
list	Description for Get all domains in a subscription.
listByResourceGroup	Description for Get all domains in a resource group.
listOwnershipIdentifiers	Description for Lists domain ownership identifiers.
listRecommendations	Description for Get domain name recommendations based on keywords.
renew	Description for Renew a domain.
transferOut	Transfer out domain to another registrar
update	Description for Creates or updates a domain.
updateOwnershipIdentifier	Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier

Property Details

checkAvailability

Description for Check if a domain is available for registration.

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

Property Value

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

createOrUpdate

Description for Creates or updates a domain.

createOrUpdate: (resourceGroupName: string, domainName: string, domain: Domain, options?: DomainsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Domain>, Domain>

Property Value

(resourceGroupName: string, domainName: string, domain: Domain, options?: DomainsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Domain>, Domain>

createOrUpdateOwnershipIdentifier

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

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

Property Value

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

delete

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

Property Value

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

deleteOwnershipIdentifier

Description for Delete ownership identifier for domain

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

Property Value

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

get

Description for Get a domain.

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

Property Value

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

getControlCenterSsoRequest

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

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

Property Value

(options?: DomainsGetControlCenterSsoRequestOptionalParams) => Promise<DomainControlCenterSsoRequest>

getOwnershipIdentifier

Description for Get ownership identifier for domain

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

Property Value

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

list

Description for Get all domains in a subscription.

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

Property Value

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

listByResourceGroup

Description for Get all domains in a resource group.

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

Property Value

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

listOwnershipIdentifiers

Description for Lists domain ownership identifiers.

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

Property Value

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

listRecommendations

Description for Get domain name recommendations based on keywords.

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

Property Value

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

renew

Description for Renew a domain.

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

Property Value

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

transferOut

Transfer out domain to another registrar

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

Property Value

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

update

Description for Creates or updates a domain.

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

Property Value

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

updateOwnershipIdentifier

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

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

Property Value

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