Policies interface

Package:

@azure/arm-frontdoor

Interface representing a Policies.

Methods

beginCreateOrUpdate(string, string, WebApplicationFirewallPolicy, PoliciesCreateOrUpdateOptionalParams)	Create or update policy with specified rule set name within a resource group.
beginCreateOrUpdateAndWait(string, string, WebApplicationFirewallPolicy, PoliciesCreateOrUpdateOptionalParams)	Create or update policy with specified rule set name within a resource group.
beginDelete(string, string, PoliciesDeleteOptionalParams)	Deletes Policy
beginDeleteAndWait(string, string, PoliciesDeleteOptionalParams)	Deletes Policy
beginUpdate(string, string, TagsObject, PoliciesUpdateOptionalParams)	Patch a specific frontdoor webApplicationFirewall policy for tags update under the specified subscription and resource group.
beginUpdateAndWait(string, string, TagsObject, PoliciesUpdateOptionalParams)	Patch a specific frontdoor webApplicationFirewall policy for tags update under the specified subscription and resource group.
get(string, string, PoliciesGetOptionalParams)	Retrieve protection policy with specified name within a resource group.
list(string, PoliciesListOptionalParams)	Lists all of the protection policies within a resource group.
listBySubscription(PoliciesListBySubscriptionOptionalParams)	Lists all of the protection policies within a subscription.

Method Details

beginCreateOrUpdate(string, string, WebApplicationFirewallPolicy, PoliciesCreateOrUpdateOptionalParams)

Create or update policy with specified rule set name within a resource group.

function beginCreateOrUpdate(resourceGroupName: string, policyName: string, parameters: WebApplicationFirewallPolicy, options?: PoliciesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WebApplicationFirewallPolicy>, WebApplicationFirewallPolicy>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

policyName

string

The name of the Web Application Firewall Policy.

parameters

WebApplicationFirewallPolicy

Policy to be created.

options

PoliciesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, WebApplicationFirewallPolicy, PoliciesCreateOrUpdateOptionalParams)

Create or update policy with specified rule set name within a resource group.

function beginCreateOrUpdateAndWait(resourceGroupName: string, policyName: string, parameters: WebApplicationFirewallPolicy, options?: PoliciesCreateOrUpdateOptionalParams): Promise<WebApplicationFirewallPolicy>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

policyName

string

The name of the Web Application Firewall Policy.

parameters

WebApplicationFirewallPolicy

Policy to be created.

options

PoliciesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<WebApplicationFirewallPolicy>

beginDelete(string, string, PoliciesDeleteOptionalParams)

Deletes Policy

function beginDelete(resourceGroupName: string, policyName: string, options?: PoliciesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

policyName

string

The name of the Web Application Firewall Policy.

options

PoliciesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, PoliciesDeleteOptionalParams)

Deletes Policy

function beginDeleteAndWait(resourceGroupName: string, policyName: string, options?: PoliciesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

policyName

string

The name of the Web Application Firewall Policy.

options

PoliciesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, TagsObject, PoliciesUpdateOptionalParams)

Patch a specific frontdoor webApplicationFirewall policy for tags update under the specified subscription and resource group.

function beginUpdate(resourceGroupName: string, policyName: string, parameters: TagsObject, options?: PoliciesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WebApplicationFirewallPolicy>, WebApplicationFirewallPolicy>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

policyName

string

The name of the Web Application Firewall Policy.

parameters

TagsObject

FrontdoorWebApplicationFirewallPolicy parameters to be patched.

options

PoliciesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, TagsObject, PoliciesUpdateOptionalParams)

Patch a specific frontdoor webApplicationFirewall policy for tags update under the specified subscription and resource group.

function beginUpdateAndWait(resourceGroupName: string, policyName: string, parameters: TagsObject, options?: PoliciesUpdateOptionalParams): Promise<WebApplicationFirewallPolicy>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

policyName

string

The name of the Web Application Firewall Policy.

parameters

TagsObject

FrontdoorWebApplicationFirewallPolicy parameters to be patched.

options

PoliciesUpdateOptionalParams

The options parameters.

Returns

Promise<WebApplicationFirewallPolicy>

get(string, string, PoliciesGetOptionalParams)

Retrieve protection policy with specified name within a resource group.

function get(resourceGroupName: string, policyName: string, options?: PoliciesGetOptionalParams): Promise<WebApplicationFirewallPolicy>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

policyName

string

The name of the Web Application Firewall Policy.

options

PoliciesGetOptionalParams

The options parameters.

Returns

Promise<WebApplicationFirewallPolicy>

list(string, PoliciesListOptionalParams)

Lists all of the protection policies within a resource group.

function list(resourceGroupName: string, options?: PoliciesListOptionalParams): PagedAsyncIterableIterator<WebApplicationFirewallPolicy, WebApplicationFirewallPolicy[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

options

PoliciesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WebApplicationFirewallPolicy, WebApplicationFirewallPolicy[], PageSettings>

listBySubscription(PoliciesListBySubscriptionOptionalParams)

Lists all of the protection policies within a subscription.

function listBySubscription(options?: PoliciesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<WebApplicationFirewallPolicy, WebApplicationFirewallPolicy[], PageSettings>

Parameters

options

PoliciesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WebApplicationFirewallPolicy, WebApplicationFirewallPolicy[], PageSettings>