@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.43 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
*
* Uses Azure REST API version 2023-07-01-preview.
*
* Other available API versions: 2015-05-04-preview, 2016-04-01, 2017-09-01, 2017-10-01, 2018-03-01-preview, 2018-05-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native dns [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getZone(args: GetZoneArgs, opts?: pulumi.InvokeOptions): Promise<GetZoneResult>;
export interface GetZoneArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of the DNS zone (without a terminating dot).
*/
zoneName: string;
}
/**
* Describes a DNS zone.
*/
export interface GetZoneResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The etag of the zone.
*/
readonly etag?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
*/
readonly maxNumberOfRecordSets: number;
/**
* The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
*/
readonly maxNumberOfRecordsPerRecordSet: number;
/**
* The name of the resource
*/
readonly name: string;
/**
* The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
*/
readonly nameServers: string[];
/**
* The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
*/
readonly numberOfRecordSets: number;
/**
* A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
*/
readonly registrationVirtualNetworks?: outputs.dns.SubResourceResponse[];
/**
* A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
*/
readonly resolutionVirtualNetworks?: outputs.dns.SubResourceResponse[];
/**
* The list of signing keys.
*/
readonly signingKeys: outputs.dns.SigningKeyResponse[];
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.dns.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* The type of this DNS zone (Public or Private).
*/
readonly zoneType?: string;
}
/**
* Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
*
* Uses Azure REST API version 2023-07-01-preview.
*
* Other available API versions: 2015-05-04-preview, 2016-04-01, 2017-09-01, 2017-10-01, 2018-03-01-preview, 2018-05-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native dns [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getZoneOutput(args: GetZoneOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetZoneResult>;
export interface GetZoneOutputArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the DNS zone (without a terminating dot).
*/
zoneName: pulumi.Input<string>;
}