Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. privatedns
  5. getPrivateZone
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.privatedns.getPrivateZone

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.

    Uses Azure REST API version 2024-06-01.

    Other available API versions: 2018-09-01, 2020-01-01, 2020-06-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native privatedns [ApiVersion]. See the version guide for details.

    Using getPrivateZone

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPrivateZone(args: GetPrivateZoneArgs, opts?: InvokeOptions): Promise<GetPrivateZoneResult>
function getPrivateZoneOutput(args: GetPrivateZoneOutputArgs, opts?: InvokeOptions): Output<GetPrivateZoneResult>
    def get_private_zone(private_zone_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPrivateZoneResult
def get_private_zone_output(private_zone_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPrivateZoneResult]
    func LookupPrivateZone(ctx *Context, args *LookupPrivateZoneArgs, opts ...InvokeOption) (*LookupPrivateZoneResult, error)
func LookupPrivateZoneOutput(ctx *Context, args *LookupPrivateZoneOutputArgs, opts ...InvokeOption) LookupPrivateZoneResultOutput

    > Note: This function is named LookupPrivateZone in the Go SDK.

    public static class GetPrivateZone 
{
    public static Task<GetPrivateZoneResult> InvokeAsync(GetPrivateZoneArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateZoneResult> Invoke(GetPrivateZoneInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrivateZoneResult> getPrivateZone(GetPrivateZoneArgs args, InvokeOptions options)
public static Output<GetPrivateZoneResult> getPrivateZone(GetPrivateZoneArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:privatedns:getPrivateZone
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PrivateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    ResourceGroupName string
    The name of the resource group.
    PrivateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    ResourceGroupName string
    The name of the resource group.
    privateZoneName String
    The name of the Private DNS zone (without a terminating dot).
    resourceGroupName String
    The name of the resource group.
    privateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    resourceGroupName string
    The name of the resource group.
    private_zone_name str
    The name of the Private DNS zone (without a terminating dot).
    resource_group_name str
    The name of the resource group.
    privateZoneName String
    The name of the Private DNS zone (without a terminating dot).
    resourceGroupName String
    The name of the resource group.

    getPrivateZone Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    InternalId string
    Private zone internal Id
    MaxNumberOfRecordSets double
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    MaxNumberOfVirtualNetworkLinks double
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    MaxNumberOfVirtualNetworkLinksWithRegistration double
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    Name string
    The name of the resource
    NumberOfRecordSets double
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    NumberOfVirtualNetworkLinks double
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    NumberOfVirtualNetworkLinksWithRegistration double
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    ProvisioningState string
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    Type string
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    Etag string
    The ETag of the zone.
    Location string
    The Azure Region where the resource lives
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    InternalId string
    Private zone internal Id
    MaxNumberOfRecordSets float64
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    MaxNumberOfVirtualNetworkLinks float64
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    MaxNumberOfVirtualNetworkLinksWithRegistration float64
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    Name string
    The name of the resource
    NumberOfRecordSets float64
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    NumberOfVirtualNetworkLinks float64
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    NumberOfVirtualNetworkLinksWithRegistration float64
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    ProvisioningState string
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    Type string
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    Etag string
    The ETag of the zone.
    Location string
    The Azure Region where the resource lives
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    internalId String
    Private zone internal Id
    maxNumberOfRecordSets Double
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinks Double
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinksWithRegistration Double
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    name String
    The name of the resource
    numberOfRecordSets Double
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinks Double
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinksWithRegistration Double
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    provisioningState String
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    type String
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    etag String
    The ETag of the zone.
    location String
    The Azure Region where the resource lives
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    internalId string
    Private zone internal Id
    maxNumberOfRecordSets number
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinks number
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinksWithRegistration number
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    name string
    The name of the resource
    numberOfRecordSets number
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinks number
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinksWithRegistration number
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    provisioningState string
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    type string
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    etag string
    The ETag of the zone.
    location string
    The Azure Region where the resource lives
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    internal_id str
    Private zone internal Id
    max_number_of_record_sets float
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    max_number_of_virtual_network_links float
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    max_number_of_virtual_network_links_with_registration float
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    name str
    The name of the resource
    number_of_record_sets float
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    number_of_virtual_network_links float
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    number_of_virtual_network_links_with_registration float
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    provisioning_state str
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    type str
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    etag str
    The ETag of the zone.
    location str
    The Azure Region where the resource lives
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
    internalId String
    Private zone internal Id
    maxNumberOfRecordSets Number
    The maximum number of record sets that can be created in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinks Number
    The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    maxNumberOfVirtualNetworkLinksWithRegistration Number
    The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    name String
    The name of the resource
    numberOfRecordSets Number
    The current number of record sets in this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinks Number
    The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
    numberOfVirtualNetworkLinksWithRegistration Number
    The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
    provisioningState String
    The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
    type String
    The type of the resource. Example - 'Microsoft.Network/privateDnsZones'.
    etag String
    The ETag of the zone.
    location String
    The Azure Region where the resource lives
    tags Map<String>
    Resource tags.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native