AFDProfilesOperations interface

Package:

@azure/arm-cdn

Interface representing a AFDProfiles operations.

Properties

beginUpgrade
beginUpgradeAndWait
checkEndpointNameAvailability	Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.
checkHostNameAvailability	Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.
listResourceUsage	Checks the quota and actual usage of endpoints under the given Azure Front Door profile.
upgrade	Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.
validateSecret	Validate a Secret in the profile.

Property Details

beginUpgrade

Warning

This API is now deprecated.

use upgrade instead

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

Property Value

(resourceGroupName: string, profileName: string, profileUpgradeParameters: ProfileUpgradeParameters, options?: AFDProfilesUpgradeOptionalParams) => Promise<SimplePollerLike<OperationState<Profile>, Profile>>

beginUpgradeAndWait

Warning

This API is now deprecated.

use upgrade instead

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

Property Value

(resourceGroupName: string, profileName: string, profileUpgradeParameters: ProfileUpgradeParameters, options?: AFDProfilesUpgradeOptionalParams) => Promise<Profile>

checkEndpointNameAvailability

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

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

Property Value

(resourceGroupName: string, profileName: string, checkEndpointNameAvailabilityInput: CheckEndpointNameAvailabilityInput, options?: AFDProfilesCheckEndpointNameAvailabilityOptionalParams) => Promise<CheckEndpointNameAvailabilityOutput>

checkHostNameAvailability

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

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

Property Value

(resourceGroupName: string, profileName: string, checkHostNameAvailabilityInput: CheckHostNameAvailabilityInput, options?: AFDProfilesCheckHostNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityOutput>

listResourceUsage

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

listResourceUsage: (resourceGroupName: string, profileName: string, options?: AFDProfilesListResourceUsageOptionalParams) => PagedAsyncIterableIterator<Usage, Usage[], PageSettings>

Property Value

(resourceGroupName: string, profileName: string, options?: AFDProfilesListResourceUsageOptionalParams) => PagedAsyncIterableIterator<Usage, Usage[], PageSettings>

upgrade

Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.

upgrade: (resourceGroupName: string, profileName: string, profileUpgradeParameters: ProfileUpgradeParameters, options?: AFDProfilesUpgradeOptionalParams) => PollerLike<OperationState<Profile>, Profile>

Property Value

(resourceGroupName: string, profileName: string, profileUpgradeParameters: ProfileUpgradeParameters, options?: AFDProfilesUpgradeOptionalParams) => PollerLike<OperationState<Profile>, Profile>

validateSecret

Validate a Secret in the profile.

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

Property Value

(resourceGroupName: string, profileName: string, validateSecretInput: ValidateSecretInput, options?: AFDProfilesValidateSecretOptionalParams) => Promise<ValidateSecretOutput>