DnsForwardingRulesets interface

Package:

@azure/arm-dnsresolver

Interface representing a DnsForwardingRulesets.

Methods

beginCreateOrUpdate(string, string, DnsForwardingRuleset, DnsForwardingRulesetsCreateOrUpdateOptionalParams)	Creates or updates a DNS forwarding ruleset.
beginCreateOrUpdateAndWait(string, string, DnsForwardingRuleset, DnsForwardingRulesetsCreateOrUpdateOptionalParams)	Creates or updates a DNS forwarding ruleset.
beginDelete(string, string, DnsForwardingRulesetsDeleteOptionalParams)	Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.
beginDeleteAndWait(string, string, DnsForwardingRulesetsDeleteOptionalParams)	Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.
beginUpdate(string, string, DnsForwardingRulesetPatch, DnsForwardingRulesetsUpdateOptionalParams)	Updates a DNS forwarding ruleset.
beginUpdateAndWait(string, string, DnsForwardingRulesetPatch, DnsForwardingRulesetsUpdateOptionalParams)	Updates a DNS forwarding ruleset.
get(string, string, DnsForwardingRulesetsGetOptionalParams)	Gets a DNS forwarding ruleset properties.
list(DnsForwardingRulesetsListOptionalParams)	Lists DNS forwarding rulesets in all resource groups of a subscription.
listByResourceGroup(string, DnsForwardingRulesetsListByResourceGroupOptionalParams)	Lists DNS forwarding rulesets within a resource group.
listByVirtualNetwork(string, string, DnsForwardingRulesetsListByVirtualNetworkOptionalParams)	Lists DNS forwarding ruleset resource IDs attached to a virtual network.

Method Details

beginCreateOrUpdate(string, string, DnsForwardingRuleset, DnsForwardingRulesetsCreateOrUpdateOptionalParams)

Creates or updates a DNS forwarding ruleset.

function beginCreateOrUpdate(resourceGroupName: string, dnsForwardingRulesetName: string, parameters: DnsForwardingRuleset, options?: DnsForwardingRulesetsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DnsForwardingRuleset>, DnsForwardingRuleset>>

Parameters

resourceGroupName

string

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

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

parameters

DnsForwardingRuleset

Parameters supplied to the CreateOrUpdate operation.

options

DnsForwardingRulesetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<DnsForwardingRuleset>, DnsForwardingRuleset>>

beginCreateOrUpdateAndWait(string, string, DnsForwardingRuleset, DnsForwardingRulesetsCreateOrUpdateOptionalParams)

Creates or updates a DNS forwarding ruleset.

function beginCreateOrUpdateAndWait(resourceGroupName: string, dnsForwardingRulesetName: string, parameters: DnsForwardingRuleset, options?: DnsForwardingRulesetsCreateOrUpdateOptionalParams): Promise<DnsForwardingRuleset>

Parameters

resourceGroupName

string

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

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

parameters

DnsForwardingRuleset

Parameters supplied to the CreateOrUpdate operation.

options

DnsForwardingRulesetsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DnsForwardingRuleset>

beginDelete(string, string, DnsForwardingRulesetsDeleteOptionalParams)

Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.

function beginDelete(resourceGroupName: string, dnsForwardingRulesetName: string, options?: DnsForwardingRulesetsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

options

DnsForwardingRulesetsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, DnsForwardingRulesetsDeleteOptionalParams)

Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.

function beginDeleteAndWait(resourceGroupName: string, dnsForwardingRulesetName: string, options?: DnsForwardingRulesetsDeleteOptionalParams): 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.

options

DnsForwardingRulesetsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, DnsForwardingRulesetPatch, DnsForwardingRulesetsUpdateOptionalParams)

Updates a DNS forwarding ruleset.

function beginUpdate(resourceGroupName: string, dnsForwardingRulesetName: string, parameters: DnsForwardingRulesetPatch, options?: DnsForwardingRulesetsUpdateOptionalParams): Promise<PollerLike<PollOperationState<DnsForwardingRuleset>, DnsForwardingRuleset>>

Parameters

resourceGroupName

string

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

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

parameters

DnsForwardingRulesetPatch

Parameters supplied to the Update operation.

options

DnsForwardingRulesetsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<DnsForwardingRuleset>, DnsForwardingRuleset>>

beginUpdateAndWait(string, string, DnsForwardingRulesetPatch, DnsForwardingRulesetsUpdateOptionalParams)

Updates a DNS forwarding ruleset.

function beginUpdateAndWait(resourceGroupName: string, dnsForwardingRulesetName: string, parameters: DnsForwardingRulesetPatch, options?: DnsForwardingRulesetsUpdateOptionalParams): Promise<DnsForwardingRuleset>

Parameters

resourceGroupName

string

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

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

parameters

DnsForwardingRulesetPatch

Parameters supplied to the Update operation.

options

DnsForwardingRulesetsUpdateOptionalParams

The options parameters.

Returns

Promise<DnsForwardingRuleset>

get(string, string, DnsForwardingRulesetsGetOptionalParams)

Gets a DNS forwarding ruleset properties.

function get(resourceGroupName: string, dnsForwardingRulesetName: string, options?: DnsForwardingRulesetsGetOptionalParams): Promise<DnsForwardingRuleset>

Parameters

resourceGroupName

string

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

dnsForwardingRulesetName

string

The name of the DNS forwarding ruleset.

options

DnsForwardingRulesetsGetOptionalParams

The options parameters.

Returns

Promise<DnsForwardingRuleset>

list(DnsForwardingRulesetsListOptionalParams)

Lists DNS forwarding rulesets in all resource groups of a subscription.

function list(options?: DnsForwardingRulesetsListOptionalParams): PagedAsyncIterableIterator<DnsForwardingRuleset, DnsForwardingRuleset[], PageSettings>

Parameters

options

DnsForwardingRulesetsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DnsForwardingRuleset, DnsForwardingRuleset[], PageSettings>

listByResourceGroup(string, DnsForwardingRulesetsListByResourceGroupOptionalParams)

Lists DNS forwarding rulesets within a resource group.

function listByResourceGroup(resourceGroupName: string, options?: DnsForwardingRulesetsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DnsForwardingRuleset, DnsForwardingRuleset[], PageSettings>

Parameters

resourceGroupName

string

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

options

DnsForwardingRulesetsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DnsForwardingRuleset, DnsForwardingRuleset[], PageSettings>

listByVirtualNetwork(string, string, DnsForwardingRulesetsListByVirtualNetworkOptionalParams)

Lists DNS forwarding ruleset resource IDs attached to a virtual network.

function listByVirtualNetwork(resourceGroupName: string, virtualNetworkName: string, options?: DnsForwardingRulesetsListByVirtualNetworkOptionalParams): PagedAsyncIterableIterator<VirtualNetworkDnsForwardingRuleset, VirtualNetworkDnsForwardingRuleset[], PageSettings>

Parameters

resourceGroupName

string

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

virtualNetworkName

string

The name of the virtual network.

options

DnsForwardingRulesetsListByVirtualNetworkOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VirtualNetworkDnsForwardingRuleset, VirtualNetworkDnsForwardingRuleset[], PageSettings>