ForwardingRule interface

Describes a forwarding rule within a DNS forwarding ruleset.

Extends

Properties

domainName

The domain name for the forwarding rule.

etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")

forwardingRuleState

The state of forwarding rule.

metadata

Metadata attached to the forwarding rule.

provisioningState

The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.

targetDnsServers

DNS servers to forward the DNS query to.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

domainName

The domain name for the forwarding rule.

domainName: string

Property Value

string

etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")

etag?: string

Property Value

string

forwardingRuleState

The state of forwarding rule.

forwardingRuleState?: string

Property Value

string

metadata

Metadata attached to the forwarding rule.

metadata?: Record<string, string>

Property Value

Record<string, string>

provisioningState

The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.

provisioningState?: string

Property Value

string

targetDnsServers

DNS servers to forward the DNS query to.

targetDnsServers: TargetDnsServer[]

Property Value

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type