Share via

Rules interface

  • Reference
Package:
@azure/arm-cdn

Interface representing a Rules.

Methods

beginCreate(string, string, string, string, Rule, RulesCreateOptionalParams)

Creates a new delivery rule within the specified rule set.
beginCreateAndWait(string, string, string, string, Rule, RulesCreateOptionalParams)

Creates a new delivery rule within the specified rule set.
beginDelete(string, string, string, string, RulesDeleteOptionalParams)

Deletes an existing delivery rule within a rule set.
beginDeleteAndWait(string, string, string, string, RulesDeleteOptionalParams)

Deletes an existing delivery rule within a rule set.
beginUpdate(string, string, string, string, RuleUpdateParameters, RulesUpdateOptionalParams)

Updates an existing delivery rule within a rule set.
beginUpdateAndWait(string, string, string, string, RuleUpdateParameters, RulesUpdateOptionalParams)

Updates an existing delivery rule within a rule set.
get(string, string, string, string, RulesGetOptionalParams)

Gets an existing delivery rule within a rule set.
listByRuleSet(string, string, string, RulesListByRuleSetOptionalParams)

Lists all of the existing delivery rules within a rule set.

Method Details

beginCreate(string, string, string, string, Rule, RulesCreateOptionalParams)

Creates a new delivery rule within the specified rule set.

function beginCreate(resourceGroupName: string, profileName: string, ruleSetName: string, ruleName: string, rule: Rule, options?: RulesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Rule>, Rule>>

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.

ruleName

string

Name of the delivery rule which is unique within the endpoint.

rule
Rule

The delivery rule properties.

options
RulesCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, string, Rule, RulesCreateOptionalParams)

Creates a new delivery rule within the specified rule set.

function beginCreateAndWait(resourceGroupName: string, profileName: string, ruleSetName: string, ruleName: string, rule: Rule, options?: RulesCreateOptionalParams): Promise<Rule>

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.

ruleName

string

Name of the delivery rule which is unique within the endpoint.

rule
Rule

The delivery rule properties.

options
RulesCreateOptionalParams

The options parameters.

Returns

Promise<Rule>

beginDelete(string, string, string, string, RulesDeleteOptionalParams)

Deletes an existing delivery rule within a rule set.

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

ruleName

string

Name of the delivery rule which is unique within the endpoint.

options
RulesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, RulesDeleteOptionalParams)

Deletes an existing delivery rule within a rule set.

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

ruleName

string

Name of the delivery rule which is unique within the endpoint.

options
RulesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, RuleUpdateParameters, RulesUpdateOptionalParams)

Updates an existing delivery rule within a rule set.

function beginUpdate(resourceGroupName: string, profileName: string, ruleSetName: string, ruleName: string, ruleUpdateProperties: RuleUpdateParameters, options?: RulesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Rule>, Rule>>

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.

ruleName

string

Name of the delivery rule which is unique within the endpoint.

ruleUpdateProperties
RuleUpdateParameters

Delivery rule properties

options
RulesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, string, RuleUpdateParameters, RulesUpdateOptionalParams)

Updates an existing delivery rule within a rule set.

function beginUpdateAndWait(resourceGroupName: string, profileName: string, ruleSetName: string, ruleName: string, ruleUpdateProperties: RuleUpdateParameters, options?: RulesUpdateOptionalParams): Promise<Rule>

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.

ruleName

string

Name of the delivery rule which is unique within the endpoint.

ruleUpdateProperties
RuleUpdateParameters

Delivery rule properties

options
RulesUpdateOptionalParams

The options parameters.

Returns

Promise<Rule>

get(string, string, string, string, RulesGetOptionalParams)

Gets an existing delivery rule within a rule set.

function get(resourceGroupName: string, profileName: string, ruleSetName: string, ruleName: string, options?: RulesGetOptionalParams): Promise<Rule>

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.

ruleName

string

Name of the delivery rule which is unique within the endpoint.

options
RulesGetOptionalParams

The options parameters.

Returns

Promise<Rule>

listByRuleSet(string, string, string, RulesListByRuleSetOptionalParams)

Lists all of the existing delivery rules within a rule set.

function listByRuleSet(resourceGroupName: string, profileName: string, ruleSetName: string, options?: RulesListByRuleSetOptionalParams): PagedAsyncIterableIterator<Rule, Rule[], 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.

options
RulesListByRuleSetOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Rule, Rule[], PageSettings>