AfdCustomDomains interface

Package:

@azure/arm-cdn

Interface representing a AfdCustomDomains.

Methods

beginCreate(string, string, string, AFDDomain, AfdCustomDomainsCreateOptionalParams)	Creates a new domain within the specified profile.
beginCreateAndWait(string, string, string, AFDDomain, AfdCustomDomainsCreateOptionalParams)	Creates a new domain within the specified profile.
beginDelete(string, string, string, AfdCustomDomainsDeleteOptionalParams)	Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
beginDeleteAndWait(string, string, string, AfdCustomDomainsDeleteOptionalParams)	Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
beginRefreshValidationToken(string, string, string, AfdCustomDomainsRefreshValidationTokenOptionalParams)	Updates the domain validation token.
beginRefreshValidationTokenAndWait(string, string, string, AfdCustomDomainsRefreshValidationTokenOptionalParams)	Updates the domain validation token.
beginUpdate(string, string, string, AFDDomainUpdateParameters, AfdCustomDomainsUpdateOptionalParams)	Updates an existing domain within a profile.
beginUpdateAndWait(string, string, string, AFDDomainUpdateParameters, AfdCustomDomainsUpdateOptionalParams)	Updates an existing domain within a profile.
get(string, string, string, AfdCustomDomainsGetOptionalParams)	Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
listByProfile(string, string, AfdCustomDomainsListByProfileOptionalParams)	Lists existing AzureFrontDoor domains.

Method Details

beginCreate(string, string, string, AFDDomain, AfdCustomDomainsCreateOptionalParams)

Creates a new domain within the specified profile.

function beginCreate(resourceGroupName: string, profileName: string, customDomainName: string, customDomain: AFDDomain, options?: AfdCustomDomainsCreateOptionalParams): Promise<SimplePollerLike<OperationState<AFDDomain>, AFDDomain>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

customDomainName

string

Name of the domain under the profile which is unique globally

customDomain

AFDDomain

Domain properties

options

AfdCustomDomainsCreateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<AFDDomain>, AFDDomain>>

beginCreateAndWait(string, string, string, AFDDomain, AfdCustomDomainsCreateOptionalParams)

Creates a new domain within the specified profile.

function beginCreateAndWait(resourceGroupName: string, profileName: string, customDomainName: string, customDomain: AFDDomain, options?: AfdCustomDomainsCreateOptionalParams): Promise<AFDDomain>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

customDomainName

string

Name of the domain under the profile which is unique globally

customDomain

AFDDomain

Domain properties

options

AfdCustomDomainsCreateOptionalParams

The options parameters.

Returns

Promise<AFDDomain>

beginDelete(string, string, string, AfdCustomDomainsDeleteOptionalParams)

Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

function beginDelete(resourceGroupName: string, profileName: string, customDomainName: string, options?: AfdCustomDomainsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

customDomainName

string

Name of the domain under the profile which is unique globally.

options

AfdCustomDomainsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, AfdCustomDomainsDeleteOptionalParams)

Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

function beginDeleteAndWait(resourceGroupName: string, profileName: string, customDomainName: string, options?: AfdCustomDomainsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

customDomainName

string

Name of the domain under the profile which is unique globally.

options

AfdCustomDomainsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRefreshValidationToken(string, string, string, AfdCustomDomainsRefreshValidationTokenOptionalParams)

Updates the domain validation token.

function beginRefreshValidationToken(resourceGroupName: string, profileName: string, customDomainName: string, options?: AfdCustomDomainsRefreshValidationTokenOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

customDomainName

string

Name of the domain under the profile which is unique globally.

options

AfdCustomDomainsRefreshValidationTokenOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginRefreshValidationTokenAndWait(string, string, string, AfdCustomDomainsRefreshValidationTokenOptionalParams)

Updates the domain validation token.

function beginRefreshValidationTokenAndWait(resourceGroupName: string, profileName: string, customDomainName: string, options?: AfdCustomDomainsRefreshValidationTokenOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

customDomainName

string

Name of the domain under the profile which is unique globally.

options

AfdCustomDomainsRefreshValidationTokenOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, AFDDomainUpdateParameters, AfdCustomDomainsUpdateOptionalParams)

Updates an existing domain within a profile.

function beginUpdate(resourceGroupName: string, profileName: string, customDomainName: string, customDomainUpdateProperties: AFDDomainUpdateParameters, options?: AfdCustomDomainsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AFDDomain>, AFDDomain>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

customDomainName

string

Name of the domain under the profile which is unique globally

customDomainUpdateProperties

AFDDomainUpdateParameters

Domain properties

options

AfdCustomDomainsUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<AFDDomain>, AFDDomain>>

beginUpdateAndWait(string, string, string, AFDDomainUpdateParameters, AfdCustomDomainsUpdateOptionalParams)

Updates an existing domain within a profile.

function beginUpdateAndWait(resourceGroupName: string, profileName: string, customDomainName: string, customDomainUpdateProperties: AFDDomainUpdateParameters, options?: AfdCustomDomainsUpdateOptionalParams): Promise<AFDDomain>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

customDomainName

string

Name of the domain under the profile which is unique globally

customDomainUpdateProperties

AFDDomainUpdateParameters

Domain properties

options

AfdCustomDomainsUpdateOptionalParams

The options parameters.

Returns

Promise<AFDDomain>

get(string, string, string, AfdCustomDomainsGetOptionalParams)

Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

function get(resourceGroupName: string, profileName: string, customDomainName: string, options?: AfdCustomDomainsGetOptionalParams): Promise<AFDDomain>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

customDomainName

string

Name of the domain under the profile which is unique globally.

options

AfdCustomDomainsGetOptionalParams

The options parameters.

Returns

Promise<AFDDomain>

listByProfile(string, string, AfdCustomDomainsListByProfileOptionalParams)

Lists existing AzureFrontDoor domains.

function listByProfile(resourceGroupName: string, profileName: string, options?: AfdCustomDomainsListByProfileOptionalParams): PagedAsyncIterableIterator<AFDDomain, AFDDomain[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

options

AfdCustomDomainsListByProfileOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AFDDomain, AFDDomain[], PageSettings>