@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets properties of a forwarding rule in 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 function getForwardingRule(args: GetForwardingRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetForwardingRuleResult>;
export interface GetForwardingRuleArgs {
/**
* The name of the DNS forwarding ruleset.
*/
dnsForwardingRulesetName: string;
/**
* The name of the forwarding rule.
*/
forwardingRuleName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Describes a forwarding rule within a DNS forwarding ruleset.
*/
export interface GetForwardingRuleResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The domain name for the forwarding rule.
*/
readonly domainName: string;
/**
* ETag of the forwarding rule.
*/
readonly etag: string;
/**
* The state of forwarding rule.
*/
readonly forwardingRuleState?: string;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* Metadata attached to the forwarding rule.
*/
readonly metadata?: {
[key: string]: string;
};
/**
* The name of the resource
*/
readonly name: 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: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.dnsresolver.SystemDataResponse;
/**
* DNS servers to forward the DNS query to.
*/
readonly targetDnsServers: outputs.dnsresolver.TargetDnsServerResponse[];
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* Gets properties of a forwarding rule in 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 function getForwardingRuleOutput(args: GetForwardingRuleOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetForwardingRuleResult>;
export interface GetForwardingRuleOutputArgs {
/**
* The name of the DNS forwarding ruleset.
*/
dnsForwardingRulesetName: pulumi.Input<string>;
/**
* The name of the forwarding rule.
*/
forwardingRuleName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}