FrontDoors interface
Interface representing a FrontDoors.
Methods
| begin |
Creates a new Front Door with a Front Door name under the specified subscription and resource group. |
| begin |
Creates a new Front Door with a Front Door name under the specified subscription and resource group. |
| begin |
Deletes an existing Front Door with the specified parameters. |
| begin |
Deletes an existing Front Door with the specified parameters. |
| get(string, string, Front |
Gets a Front Door with the specified Front Door name under the specified subscription and resource group. |
| list(Front |
Lists all of the Front Doors within an Azure subscription. |
| list |
Lists all of the Front Doors within a resource group under a subscription. |
| validate |
Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS. |
Method Details
beginCreateOrUpdate(string, string, FrontDoor, FrontDoorsCreateOrUpdateOptionalParams)
Creates a new Front Door with a Front Door name under the specified subscription and resource group.
function beginCreateOrUpdate(resourceGroupName: string, frontDoorName: string, frontDoorParameters: FrontDoor, options?: FrontDoorsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FrontDoor>, FrontDoor>>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- frontDoorName
-
string
Name of the Front Door which is globally unique.
- frontDoorParameters
- FrontDoor
Front Door properties needed to create a new Front Door.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<FrontDoor>, FrontDoor>>
beginCreateOrUpdateAndWait(string, string, FrontDoor, FrontDoorsCreateOrUpdateOptionalParams)
Creates a new Front Door with a Front Door name under the specified subscription and resource group.
function beginCreateOrUpdateAndWait(resourceGroupName: string, frontDoorName: string, frontDoorParameters: FrontDoor, options?: FrontDoorsCreateOrUpdateOptionalParams): Promise<FrontDoor>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- frontDoorName
-
string
Name of the Front Door which is globally unique.
- frontDoorParameters
- FrontDoor
Front Door properties needed to create a new Front Door.
The options parameters.
Returns
Promise<FrontDoor>
beginDelete(string, string, FrontDoorsDeleteOptionalParams)
Deletes an existing Front Door with the specified parameters.
function beginDelete(resourceGroupName: string, frontDoorName: string, options?: FrontDoorsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- frontDoorName
-
string
Name of the Front Door which is globally unique.
- options
- FrontDoorsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, FrontDoorsDeleteOptionalParams)
Deletes an existing Front Door with the specified parameters.
function beginDeleteAndWait(resourceGroupName: string, frontDoorName: string, options?: FrontDoorsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- frontDoorName
-
string
Name of the Front Door which is globally unique.
- options
- FrontDoorsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, FrontDoorsGetOptionalParams)
Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
function get(resourceGroupName: string, frontDoorName: string, options?: FrontDoorsGetOptionalParams): Promise<FrontDoor>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- frontDoorName
-
string
Name of the Front Door which is globally unique.
- options
- FrontDoorsGetOptionalParams
The options parameters.
Returns
Promise<FrontDoor>
list(FrontDoorsListOptionalParams)
Lists all of the Front Doors within an Azure subscription.
function list(options?: FrontDoorsListOptionalParams): PagedAsyncIterableIterator<FrontDoor, FrontDoor[], PageSettings>Parameters
- options
- FrontDoorsListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, FrontDoorsListByResourceGroupOptionalParams)
Lists all of the Front Doors within a resource group under a subscription.
function listByResourceGroup(resourceGroupName: string, options?: FrontDoorsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<FrontDoor, FrontDoor[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
The options parameters.
Returns
validateCustomDomain(string, string, ValidateCustomDomainInput, FrontDoorsValidateCustomDomainOptionalParams)
Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.
function validateCustomDomain(resourceGroupName: string, frontDoorName: string, customDomainProperties: ValidateCustomDomainInput, options?: FrontDoorsValidateCustomDomainOptionalParams): Promise<ValidateCustomDomainOutput>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- frontDoorName
-
string
Name of the Front Door which is globally unique.
- customDomainProperties
- ValidateCustomDomainInput
Custom domain to be validated.
The options parameters.
Returns
Promise<ValidateCustomDomainOutput>