@azure/arm-domainregistration package

Interfaces

Address

Address information for domain registration.

Contact

Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements.

CsmOperationDescription

Description of an operation available for Microsoft.Web resource provider.

CsmOperationDescriptionProperties

Properties available for a Microsoft.Web resource provider operation.

CsmOperationDisplay

Meta data about operation used for display in portal.

DefaultErrorResponse

App Service error response.

DefaultErrorResponseError

Error model.

DefaultErrorResponseErrorDetailsItem

Detailed errors.

Dimension

Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app, where instance name is dimension of the metric HTTP request

Domain

Information about a domain.

DomainAvailabilityCheckResult

Domain availability check result.

DomainControlCenterSsoRequest

Single sign-on request information for domain management.

DomainOwnershipIdentifier

Domain ownership Identifier.

DomainOwnershipIdentifierProperties

DomainOwnershipIdentifier resource specific properties

DomainPatchResource

ARM resource for a domain.

DomainPatchResourceProperties

DomainPatchResource resource specific properties

DomainProperties

Domain resource specific properties

DomainPurchaseConsent

Domain purchase consent object, representing acceptance of applicable legal agreements.

DomainRecommendationSearchParameters

Domain recommendation search parameters.

DomainRegistrationManagementClientOptionalParams

Optional parameters for the client.

DomainRegistrationProviderListOperationsOptionalParams

Optional parameters.

DomainRegistrationProviderOperations

Interface representing a DomainRegistrationProvider operations.

DomainsCheckAvailabilityOptionalParams

Optional parameters.

DomainsCreateOrUpdateOptionalParams

Optional parameters.

DomainsCreateOrUpdateOwnershipIdentifierOptionalParams

Optional parameters.

DomainsDeleteOptionalParams

Optional parameters.

DomainsDeleteOwnershipIdentifierOptionalParams

Optional parameters.

DomainsGetControlCenterSsoRequestOptionalParams

Optional parameters.

DomainsGetOptionalParams

Optional parameters.

DomainsGetOwnershipIdentifierOptionalParams

Optional parameters.

DomainsListByResourceGroupOptionalParams

Optional parameters.

DomainsListOptionalParams

Optional parameters.

DomainsListOwnershipIdentifiersOptionalParams

Optional parameters.

DomainsListRecommendationsOptionalParams

Optional parameters.

DomainsOperations

Interface representing a Domains operations.

DomainsRenewOptionalParams

Optional parameters.

DomainsTransferOutOptionalParams

Optional parameters.

DomainsUpdateOptionalParams

Optional parameters.

DomainsUpdateOwnershipIdentifierOptionalParams

Optional parameters.

HostName

Details of a hostname derived from a domain.

LogSpecification

Log Definition of a single resource metric.

MetricAvailability

Retention policy of a resource metric.

MetricSpecification

Definition of a single resource metric.

NameIdentifier

Identifies an object.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

ProxyOnlyResource

Azure proxy only resource. This resource is not tracked by Azure Resource Manager.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

RestorePollerOptions
ServiceSpecification

Resource metrics service provided by Microsoft.Insights resource provider.

SystemData

Metadata pertaining to creation and last modification of the resource.

TldLegalAgreement

Legal agreement for a top level domain.

TopLevelDomain

A top level domain object.

TopLevelDomainAgreementOption

Options for retrieving the list of top level domain legal agreements.

TopLevelDomainProperties

TopLevelDomain resource specific properties

TopLevelDomainsGetOptionalParams

Optional parameters.

TopLevelDomainsListAgreementsOptionalParams

Optional parameters.

TopLevelDomainsListOptionalParams

Optional parameters.

TopLevelDomainsOperations

Interface representing a TopLevelDomains operations.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

AzureResourceType

Type of the Azure resource the hostname is assigned to.

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

CustomHostNameDnsRecordType

Type of the DNS record.

DnsType

Current DNS type

DomainStatus

Domain registration status.

DomainType

Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything.

HostNameType

Type of the hostname.

ProvisioningState

Domain provisioning state.

ResourceNotRenewableReason

Reasons why domain is not renewable.
KnownResourceNotRenewableReason can be used interchangeably with ResourceNotRenewableReason, this enum contains the known values that the service supports.

Known values supported by the service

RegistrationStatusNotSupportedForRenewal: Registration status is not supported for renewal.
ExpirationNotInRenewalTimeRange: Domain expiration is not in the renewal time range.
SubscriptionNotActive: Subscription is not active.

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownCreatedByType

The kind of entity that created the resource.

KnownResourceNotRenewableReason

Reasons why domain is not renewable.

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(DomainRegistrationManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(DomainRegistrationManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: DomainRegistrationManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>