@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.29 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Describes a forwarding rule within a DNS forwarding ruleset.
*
* Uses Azure REST API version 2023-07-01-preview.
*
* Other available API versions: 2020-04-01-preview, 2022-07-01, 2025-05-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native dnsresolver [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class ForwardingRule extends pulumi.CustomResource {
/**
* Get an existing ForwardingRule resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ForwardingRule;
/**
* Returns true if the given object is an instance of ForwardingRule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ForwardingRule;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The domain name for the forwarding rule.
*/
readonly domainName: pulumi.Output<string>;
/**
* ETag of the forwarding rule.
*/
readonly etag: pulumi.Output<string>;
/**
* The state of forwarding rule.
*/
readonly forwardingRuleState: pulumi.Output<string | undefined>;
/**
* Metadata attached to the forwarding rule.
*/
readonly metadata: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.dnsresolver.SystemDataResponse>;
/**
* DNS servers to forward the DNS query to.
*/
readonly targetDnsServers: pulumi.Output<outputs.dnsresolver.TargetDnsServerResponse[]>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a ForwardingRule resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ForwardingRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ForwardingRule resource.
*/
export interface ForwardingRuleArgs {
/**
* The name of the DNS forwarding ruleset.
*/
dnsForwardingRulesetName: pulumi.Input<string>;
/**
* The domain name for the forwarding rule.
*/
domainName: pulumi.Input<string>;
/**
* The name of the forwarding rule.
*/
forwardingRuleName?: pulumi.Input<string>;
/**
* The state of forwarding rule.
*/
forwardingRuleState?: pulumi.Input<string | enums.dnsresolver.ForwardingRuleState>;
/**
* Metadata attached to the forwarding rule.
*/
metadata?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* DNS servers to forward the DNS query to.
*/
targetDnsServers: pulumi.Input<pulumi.Input<inputs.dnsresolver.TargetDnsServerArgs>[]>;
}