Azure Native v1.102.0, May 2 23
Azure Native v1.102.0, May 2 23
azure-native.network.getPrivateZone
Explore with Pulumi AI
Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone. API Version: 2020-06-01.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:network:getPrivateZone
arguments:
# arguments dictionary
The following arguments are supported:
- Private
Zone stringName The name of the Private DNS zone (without a terminating dot).
- Resource
Group stringName The name of the resource group.
- Private
Zone stringName The name of the Private DNS zone (without a terminating dot).
- Resource
Group stringName The name of the resource group.
- private
Zone StringName The name of the Private DNS zone (without a terminating dot).
- resource
Group StringName The name of the resource group.
- private
Zone stringName The name of the Private DNS zone (without a terminating dot).
- resource
Group stringName The name of the resource group.
- private_
zone_ strname The name of the Private DNS zone (without a terminating dot).
- resource_
group_ strname The name of the resource group.
- private
Zone StringName The name of the Private DNS zone (without a terminating dot).
- resource
Group StringName The name of the resource group.
getPrivateZone Result
The following output properties are available:
- Id string
Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
- Internal
Id string Private zone internal Id
- Max
Number doubleOf Record Sets 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 doubleOf Virtual Network Links 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 doubleOf Virtual Network Links With Registration 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
- Number
Of doubleRecord Sets 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 doubleVirtual Network Links 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 doubleVirtual Network Links With Registration 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 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
- Dictionary<string, string>
Resource tags.
- Id string
Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
- Internal
Id string Private zone internal Id
- Max
Number float64Of Record Sets 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 float64Of Virtual Network Links 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 float64Of Virtual Network Links With Registration 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
- Number
Of float64Record Sets 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 float64Virtual Network Links 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 float64Virtual Network Links With Registration 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 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
- map[string]string
Resource tags.
- id String
Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
- internal
Id String Private zone internal Id
- max
Number DoubleOf Record Sets 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 DoubleOf Virtual Network Links 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 DoubleOf Virtual Network Links With Registration 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
- number
Of DoubleRecord Sets 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 DoubleVirtual Network Links 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 DoubleVirtual Network Links With Registration 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 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
- Map<String,String>
Resource tags.
- id string
Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
- internal
Id string Private zone internal Id
- max
Number numberOf Record Sets 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 numberOf Virtual Network Links 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 numberOf Virtual Network Links With Registration 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
- number
Of numberRecord Sets 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 numberVirtual Network Links 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 numberVirtual Network Links With Registration 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 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
- {[key: string]: string}
Resource tags.
- 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_ floatof_ record_ sets 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_ floatof_ virtual_ network_ links 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_ floatof_ virtual_ network_ links_ with_ registration 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_ floatrecord_ sets 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_ floatvirtual_ network_ links 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_ floatvirtual_ network_ links_ with_ registration 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
- Mapping[str, str]
Resource tags.
- id String
Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'.
- internal
Id String Private zone internal Id
- max
Number NumberOf Record Sets 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 NumberOf Virtual Network Links 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 NumberOf Virtual Network Links With Registration 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
- number
Of NumberRecord Sets 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 NumberVirtual Network Links 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 NumberVirtual Network Links With Registration 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 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
- Map<String>
Resource tags.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0