Share via

ForwardingRules interface

  • Reference
Package:
@azure/arm-dnsresolver

Interface representing a ForwardingRules.

Methods

createOrUpdate(string, string, string, ForwardingRule, ForwardingRulesCreateOrUpdateOptionalParams)

Creates or updates a forwarding rule in a DNS forwarding ruleset.
delete(string, string, string, ForwardingRulesDeleteOptionalParams)

Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.
get(string, string, string, ForwardingRulesGetOptionalParams)

Gets properties of a forwarding rule in a DNS forwarding ruleset.
list(string, string, ForwardingRulesListOptionalParams)

Lists forwarding rules in a DNS forwarding ruleset.
update(string, string, string, ForwardingRulePatch, ForwardingRulesUpdateOptionalParams)

Updates a forwarding rule in a DNS forwarding ruleset.

Method Details

createOrUpdate(string, string, string, ForwardingRule, ForwardingRulesCreateOrUpdateOptionalParams)

Creates or updates a forwarding rule in a DNS forwarding ruleset.

function createOrUpdate(resourceGroupName: string, dnsForwardingRulesetName: string, forwardingRuleName: string, parameters: ForwardingRule, options?: ForwardingRulesCreateOrUpdateOptionalParams): Promise<ForwardingRule>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

forwardingRuleName

string

The name of the forwarding rule.

parameters
ForwardingRule

Parameters supplied to the CreateOrUpdate operation.

options
ForwardingRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ForwardingRule>

delete(string, string, string, ForwardingRulesDeleteOptionalParams)

Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.

function delete(resourceGroupName: string, dnsForwardingRulesetName: string, forwardingRuleName: string, options?: ForwardingRulesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

forwardingRuleName

string

The name of the forwarding rule.

options
ForwardingRulesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ForwardingRulesGetOptionalParams)

Gets properties of a forwarding rule in a DNS forwarding ruleset.

function get(resourceGroupName: string, dnsForwardingRulesetName: string, forwardingRuleName: string, options?: ForwardingRulesGetOptionalParams): Promise<ForwardingRule>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

forwardingRuleName

string

The name of the forwarding rule.

options
ForwardingRulesGetOptionalParams

The options parameters.

Returns

Promise<ForwardingRule>

list(string, string, ForwardingRulesListOptionalParams)

Lists forwarding rules in a DNS forwarding ruleset.

function list(resourceGroupName: string, dnsForwardingRulesetName: string, options?: ForwardingRulesListOptionalParams): PagedAsyncIterableIterator<ForwardingRule, ForwardingRule[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

options
ForwardingRulesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ForwardingRule, ForwardingRule[], PageSettings>

update(string, string, string, ForwardingRulePatch, ForwardingRulesUpdateOptionalParams)

Updates a forwarding rule in a DNS forwarding ruleset.

function update(resourceGroupName: string, dnsForwardingRulesetName: string, forwardingRuleName: string, parameters: ForwardingRulePatch, options?: ForwardingRulesUpdateOptionalParams): Promise<ForwardingRule>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

forwardingRuleName

string

The name of the forwarding rule.

parameters
ForwardingRulePatch

Parameters supplied to the Update operation.

options
ForwardingRulesUpdateOptionalParams

The options parameters.

Returns

Promise<ForwardingRule>