Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. network
  5. getPrivateDnsZoneGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.network.getPrivateDnsZoneGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the private dns zone group resource by specified private dns zone group name. Azure REST API version: 2023-02-01.

Other available API versions: 2021-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Using getPrivateDnsZoneGroup

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 getPrivateDnsZoneGroup(args: GetPrivateDnsZoneGroupArgs, opts?: InvokeOptions): Promise<GetPrivateDnsZoneGroupResult>
function getPrivateDnsZoneGroupOutput(args: GetPrivateDnsZoneGroupOutputArgs, opts?: InvokeOptions): Output<GetPrivateDnsZoneGroupResult>
Copy
def get_private_dns_zone_group(private_dns_zone_group_name: Optional[str] = None,
                               private_endpoint_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetPrivateDnsZoneGroupResult
def get_private_dns_zone_group_output(private_dns_zone_group_name: Optional[pulumi.Input[str]] = None,
                               private_endpoint_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetPrivateDnsZoneGroupResult]
Copy
func LookupPrivateDnsZoneGroup(ctx *Context, args *LookupPrivateDnsZoneGroupArgs, opts ...InvokeOption) (*LookupPrivateDnsZoneGroupResult, error)
func LookupPrivateDnsZoneGroupOutput(ctx *Context, args *LookupPrivateDnsZoneGroupOutputArgs, opts ...InvokeOption) LookupPrivateDnsZoneGroupResultOutput
Copy

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

public static class GetPrivateDnsZoneGroup 
{
    public static Task<GetPrivateDnsZoneGroupResult> InvokeAsync(GetPrivateDnsZoneGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateDnsZoneGroupResult> Invoke(GetPrivateDnsZoneGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPrivateDnsZoneGroupResult> getPrivateDnsZoneGroup(GetPrivateDnsZoneGroupArgs args, InvokeOptions options)
public static Output<GetPrivateDnsZoneGroupResult> getPrivateDnsZoneGroup(GetPrivateDnsZoneGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getPrivateDnsZoneGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PrivateDnsZoneGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private dns zone group.
PrivateEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
PrivateDnsZoneGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private dns zone group.
PrivateEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
privateDnsZoneGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private dns zone group.
privateEndpointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
privateDnsZoneGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private dns zone group.
privateEndpointName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private endpoint.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
private_dns_zone_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the private dns zone group.
private_endpoint_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the private endpoint.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
privateDnsZoneGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private dns zone group.
privateEndpointName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private endpoint.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getPrivateDnsZoneGroup Result

The following output properties are available:

Etag string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState string
The provisioning state of the private dns zone group resource.
Id string
Resource ID.
Name string
Name of the resource that is unique within a resource group. This name can be used to access the resource.
PrivateDnsZoneConfigs List<Pulumi.AzureNative.Network.Outputs.PrivateDnsZoneConfigResponse>
A collection of private dns zone configurations of the private dns zone group.
Etag string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState string
The provisioning state of the private dns zone group resource.
Id string
Resource ID.
Name string
Name of the resource that is unique within a resource group. This name can be used to access the resource.
PrivateDnsZoneConfigs []PrivateDnsZoneConfigResponse
A collection of private dns zone configurations of the private dns zone group.
etag String
A unique read-only string that changes whenever the resource is updated.
provisioningState String
The provisioning state of the private dns zone group resource.
id String
Resource ID.
name String
Name of the resource that is unique within a resource group. This name can be used to access the resource.
privateDnsZoneConfigs List<PrivateDnsZoneConfigResponse>
A collection of private dns zone configurations of the private dns zone group.
etag string
A unique read-only string that changes whenever the resource is updated.
provisioningState string
The provisioning state of the private dns zone group resource.
id string
Resource ID.
name string
Name of the resource that is unique within a resource group. This name can be used to access the resource.
privateDnsZoneConfigs PrivateDnsZoneConfigResponse[]
A collection of private dns zone configurations of the private dns zone group.
etag str
A unique read-only string that changes whenever the resource is updated.
provisioning_state str
The provisioning state of the private dns zone group resource.
id str
Resource ID.
name str
Name of the resource that is unique within a resource group. This name can be used to access the resource.
private_dns_zone_configs Sequence[PrivateDnsZoneConfigResponse]
A collection of private dns zone configurations of the private dns zone group.
etag String
A unique read-only string that changes whenever the resource is updated.
provisioningState String
The provisioning state of the private dns zone group resource.
id String
Resource ID.
name String
Name of the resource that is unique within a resource group. This name can be used to access the resource.
privateDnsZoneConfigs List<Property Map>
A collection of private dns zone configurations of the private dns zone group.

Supporting Types

PrivateDnsZoneConfigResponse

RecordSets This property is required. List<Pulumi.AzureNative.Network.Inputs.RecordSetResponse>
A collection of information regarding a recordSet, holding information to identify private resources.
Name string
Name of the resource that is unique within a resource group. This name can be used to access the resource.
PrivateDnsZoneId string
The resource id of the private dns zone.
RecordSets This property is required. []RecordSetResponse
A collection of information regarding a recordSet, holding information to identify private resources.
Name string
Name of the resource that is unique within a resource group. This name can be used to access the resource.
PrivateDnsZoneId string
The resource id of the private dns zone.
recordSets This property is required. List<RecordSetResponse>
A collection of information regarding a recordSet, holding information to identify private resources.
name String
Name of the resource that is unique within a resource group. This name can be used to access the resource.
privateDnsZoneId String
The resource id of the private dns zone.
recordSets This property is required. RecordSetResponse[]
A collection of information regarding a recordSet, holding information to identify private resources.
name string
Name of the resource that is unique within a resource group. This name can be used to access the resource.
privateDnsZoneId string
The resource id of the private dns zone.
record_sets This property is required. Sequence[RecordSetResponse]
A collection of information regarding a recordSet, holding information to identify private resources.
name str
Name of the resource that is unique within a resource group. This name can be used to access the resource.
private_dns_zone_id str
The resource id of the private dns zone.
recordSets This property is required. List<Property Map>
A collection of information regarding a recordSet, holding information to identify private resources.
name String
Name of the resource that is unique within a resource group. This name can be used to access the resource.
privateDnsZoneId String
The resource id of the private dns zone.

RecordSetResponse

ProvisioningState This property is required. string
The provisioning state of the recordset.
Fqdn string
Fqdn that resolves to private endpoint ip address.
IpAddresses List<string>
The private ip address of the private endpoint.
RecordSetName string
Recordset name.
RecordType string
Resource record type.
Ttl int
Recordset time to live.
ProvisioningState This property is required. string
The provisioning state of the recordset.
Fqdn string
Fqdn that resolves to private endpoint ip address.
IpAddresses []string
The private ip address of the private endpoint.
RecordSetName string
Recordset name.
RecordType string
Resource record type.
Ttl int
Recordset time to live.
provisioningState This property is required. String
The provisioning state of the recordset.
fqdn String
Fqdn that resolves to private endpoint ip address.
ipAddresses List<String>
The private ip address of the private endpoint.
recordSetName String
Recordset name.
recordType String
Resource record type.
ttl Integer
Recordset time to live.
provisioningState This property is required. string
The provisioning state of the recordset.
fqdn string
Fqdn that resolves to private endpoint ip address.
ipAddresses string[]
The private ip address of the private endpoint.
recordSetName string
Recordset name.
recordType string
Resource record type.
ttl number
Recordset time to live.
provisioning_state This property is required. str
The provisioning state of the recordset.
fqdn str
Fqdn that resolves to private endpoint ip address.
ip_addresses Sequence[str]
The private ip address of the private endpoint.
record_set_name str
Recordset name.
record_type str
Resource record type.
ttl int
Recordset time to live.
provisioningState This property is required. String
The provisioning state of the recordset.
fqdn String
Fqdn that resolves to private endpoint ip address.
ipAddresses List<String>
The private ip address of the private endpoint.
recordSetName String
Recordset name.
recordType String
Resource record type.
ttl Number
Recordset time to live.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native