FrontDoorsOperations interface

Package:

@azure/arm-frontdoor

Interface representing a FrontDoors operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
createOrUpdate	Creates a new Front Door with a Front Door name under the specified subscription and resource group.
delete	Deletes an existing Front Door with the specified parameters.
get	Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
list	Lists all of the Front Doors within an Azure subscription.
listByResourceGroup	Lists all of the Front Doors within a resource group under a subscription.
validateCustomDomain	Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, frontDoorName: string, frontDoorParameters: FrontDoor, options?: FrontDoorsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<FrontDoor>, FrontDoor>>

Property Value

(resourceGroupName: string, frontDoorName: string, frontDoorParameters: FrontDoor, options?: FrontDoorsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<FrontDoor>, FrontDoor>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, frontDoorName: string, frontDoorParameters: FrontDoor, options?: FrontDoorsCreateOrUpdateOptionalParams) => Promise<FrontDoor>

Property Value

(resourceGroupName: string, frontDoorName: string, frontDoorParameters: FrontDoor, options?: FrontDoorsCreateOrUpdateOptionalParams) => Promise<FrontDoor>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, frontDoorName: string, options?: FrontDoorsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, frontDoorName: string, options?: FrontDoorsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, frontDoorName: string, options?: FrontDoorsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, frontDoorName: string, options?: FrontDoorsDeleteOptionalParams) => Promise<void>

createOrUpdate

Creates a new Front Door with a Front Door name under the specified subscription and resource group.

createOrUpdate: (resourceGroupName: string, frontDoorName: string, frontDoorParameters: FrontDoor, options?: FrontDoorsCreateOrUpdateOptionalParams) => PollerLike<OperationState<FrontDoor>, FrontDoor>

Property Value

(resourceGroupName: string, frontDoorName: string, frontDoorParameters: FrontDoor, options?: FrontDoorsCreateOrUpdateOptionalParams) => PollerLike<OperationState<FrontDoor>, FrontDoor>

delete

Deletes an existing Front Door with the specified parameters.

delete: (resourceGroupName: string, frontDoorName: string, options?: FrontDoorsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, frontDoorName: string, options?: FrontDoorsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a Front Door with the specified Front Door name under the specified subscription and resource group.

get: (resourceGroupName: string, frontDoorName: string, options?: FrontDoorsGetOptionalParams) => Promise<FrontDoor>

Property Value

(resourceGroupName: string, frontDoorName: string, options?: FrontDoorsGetOptionalParams) => Promise<FrontDoor>

list

Lists all of the Front Doors within an Azure subscription.

list: (options?: FrontDoorsListOptionalParams) => PagedAsyncIterableIterator<FrontDoor, FrontDoor[], PageSettings>

Property Value

(options?: FrontDoorsListOptionalParams) => PagedAsyncIterableIterator<FrontDoor, FrontDoor[], PageSettings>

listByResourceGroup

Lists all of the Front Doors within a resource group under a subscription.

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

Property Value

(resourceGroupName: string, options?: FrontDoorsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<FrontDoor, FrontDoor[], PageSettings>

validateCustomDomain

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

validateCustomDomain: (resourceGroupName: string, frontDoorName: string, customDomainProperties: ValidateCustomDomainInput, options?: FrontDoorsValidateCustomDomainOptionalParams) => Promise<ValidateCustomDomainOutput>

Property Value

(resourceGroupName: string, frontDoorName: string, customDomainProperties: ValidateCustomDomainInput, options?: FrontDoorsValidateCustomDomainOptionalParams) => Promise<ValidateCustomDomainOutput>