AfdProfiles interface

Interface representing a AfdProfiles.

Methods

beginUpgrade(string, string, ProfileUpgradeParameters, AfdProfilesUpgradeOptionalParams)

Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.

beginUpgradeAndWait(string, string, ProfileUpgradeParameters, AfdProfilesUpgradeOptionalParams)

Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.

checkEndpointNameAvailability(string, string, CheckEndpointNameAvailabilityInput, AfdProfilesCheckEndpointNameAvailabilityOptionalParams)

Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.

checkHostNameAvailability(string, string, CheckHostNameAvailabilityInput, AfdProfilesCheckHostNameAvailabilityOptionalParams)

Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.

listResourceUsage(string, string, AfdProfilesListResourceUsageOptionalParams)

Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

validateSecret(string, string, ValidateSecretInput, AfdProfilesValidateSecretOptionalParams)

Validate a Secret in the profile.

Method Details

beginUpgrade(string, string, ProfileUpgradeParameters, AfdProfilesUpgradeOptionalParams)

Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.

function beginUpgrade(resourceGroupName: string, profileName: string, profileUpgradeParameters: ProfileUpgradeParameters, options?: AfdProfilesUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<Profile>, Profile>>

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 which is unique within the resource group.

profileUpgradeParameters
ProfileUpgradeParameters

Profile upgrade input parameter.

options
AfdProfilesUpgradeOptionalParams

The options parameters.

Returns

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

beginUpgradeAndWait(string, string, ProfileUpgradeParameters, AfdProfilesUpgradeOptionalParams)

Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.

function beginUpgradeAndWait(resourceGroupName: string, profileName: string, profileUpgradeParameters: ProfileUpgradeParameters, options?: AfdProfilesUpgradeOptionalParams): Promise<Profile>

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 which is unique within the resource group.

profileUpgradeParameters
ProfileUpgradeParameters

Profile upgrade input parameter.

options
AfdProfilesUpgradeOptionalParams

The options parameters.

Returns

Promise<Profile>

checkEndpointNameAvailability(string, string, CheckEndpointNameAvailabilityInput, AfdProfilesCheckEndpointNameAvailabilityOptionalParams)

Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.

function checkEndpointNameAvailability(resourceGroupName: string, profileName: string, checkEndpointNameAvailabilityInput: CheckEndpointNameAvailabilityInput, options?: AfdProfilesCheckEndpointNameAvailabilityOptionalParams): Promise<CheckEndpointNameAvailabilityOutput>

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 which is unique within the resource group.

checkEndpointNameAvailabilityInput
CheckEndpointNameAvailabilityInput

Input to check.

Returns

checkHostNameAvailability(string, string, CheckHostNameAvailabilityInput, AfdProfilesCheckHostNameAvailabilityOptionalParams)

Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.

function checkHostNameAvailability(resourceGroupName: string, profileName: string, checkHostNameAvailabilityInput: CheckHostNameAvailabilityInput, options?: AfdProfilesCheckHostNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityOutput>

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.

checkHostNameAvailabilityInput
CheckHostNameAvailabilityInput

Custom domain to be validated.

options
AfdProfilesCheckHostNameAvailabilityOptionalParams

The options parameters.

Returns

listResourceUsage(string, string, AfdProfilesListResourceUsageOptionalParams)

Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

function listResourceUsage(resourceGroupName: string, profileName: string, options?: AfdProfilesListResourceUsageOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], 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
AfdProfilesListResourceUsageOptionalParams

The options parameters.

Returns

validateSecret(string, string, ValidateSecretInput, AfdProfilesValidateSecretOptionalParams)

Validate a Secret in the profile.

function validateSecret(resourceGroupName: string, profileName: string, validateSecretInput: ValidateSecretInput, options?: AfdProfilesValidateSecretOptionalParams): Promise<ValidateSecretOutput>

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 which is unique within the resource group.

validateSecretInput
ValidateSecretInput

The Secret source.

options
AfdProfilesValidateSecretOptionalParams

The options parameters.

Returns