RuleSets interface

Package:

@azure/arm-cdn

Interface representing a RuleSets.

Methods

beginDelete(string, string, string, RuleSetsDeleteOptionalParams)	Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
beginDeleteAndWait(string, string, string, RuleSetsDeleteOptionalParams)	Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
create(string, string, string, RuleSetsCreateOptionalParams)	Creates a new rule set within the specified profile.
get(string, string, string, RuleSetsGetOptionalParams)	Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
listByProfile(string, string, RuleSetsListByProfileOptionalParams)	Lists existing AzureFrontDoor rule sets within a profile.
listResourceUsage(string, string, string, RuleSetsListResourceUsageOptionalParams)	Checks the quota and actual usage of endpoints under the given Azure Front Door profile..

Method Details

beginDelete(string, string, string, RuleSetsDeleteOptionalParams)

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

function beginDelete(resourceGroupName: string, profileName: string, ruleSetName: string, options?: RuleSetsDeleteOptionalParams): 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.

ruleSetName

string

Name of the rule set under the profile which is unique globally.

options

RuleSetsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, RuleSetsDeleteOptionalParams)

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

function beginDeleteAndWait(resourceGroupName: string, profileName: string, ruleSetName: string, options?: RuleSetsDeleteOptionalParams): 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.

ruleSetName

string

Name of the rule set under the profile which is unique globally.

options

RuleSetsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

create(string, string, string, RuleSetsCreateOptionalParams)

Creates a new rule set within the specified profile.

function create(resourceGroupName: string, profileName: string, ruleSetName: string, options?: RuleSetsCreateOptionalParams): Promise<RuleSet>

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.

ruleSetName

string

Name of the rule set under the profile which is unique globally

options

RuleSetsCreateOptionalParams

The options parameters.

Returns

Promise<RuleSet>

get(string, string, string, RuleSetsGetOptionalParams)

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

function get(resourceGroupName: string, profileName: string, ruleSetName: string, options?: RuleSetsGetOptionalParams): Promise<RuleSet>

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.

ruleSetName

string

Name of the rule set under the profile which is unique globally.

options

RuleSetsGetOptionalParams

The options parameters.

Returns

Promise<RuleSet>

listByProfile(string, string, RuleSetsListByProfileOptionalParams)

Lists existing AzureFrontDoor rule sets within a profile.

function listByProfile(resourceGroupName: string, profileName: string, options?: RuleSetsListByProfileOptionalParams): PagedAsyncIterableIterator<RuleSet, RuleSet[], 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

RuleSetsListByProfileOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RuleSet, RuleSet[], PageSettings>

listResourceUsage(string, string, string, RuleSetsListResourceUsageOptionalParams)

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

function listResourceUsage(resourceGroupName: string, profileName: string, ruleSetName: string, options?: RuleSetsListResourceUsageOptionalParams): 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.

ruleSetName

string

Name of the rule set under the profile which is unique globally.

options

RuleSetsListResourceUsageOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Usage, Usage[], PageSettings>