Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. privatedns
  5. getVirtualNetworkLink
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.privatedns.getVirtualNetworkLink

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a virtual network link to the specified Private DNS 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 getVirtualNetworkLink

    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 getVirtualNetworkLink(args: GetVirtualNetworkLinkArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkLinkResult>
function getVirtualNetworkLinkOutput(args: GetVirtualNetworkLinkOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkLinkResult>
    def get_virtual_network_link(private_zone_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             virtual_network_link_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkLinkResult
def get_virtual_network_link_output(private_zone_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             virtual_network_link_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkLinkResult]
    func LookupVirtualNetworkLink(ctx *Context, args *LookupVirtualNetworkLinkArgs, opts ...InvokeOption) (*LookupVirtualNetworkLinkResult, error)
func LookupVirtualNetworkLinkOutput(ctx *Context, args *LookupVirtualNetworkLinkOutputArgs, opts ...InvokeOption) LookupVirtualNetworkLinkResultOutput

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

    public static class GetVirtualNetworkLink 
{
    public static Task<GetVirtualNetworkLinkResult> InvokeAsync(GetVirtualNetworkLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNetworkLinkResult> Invoke(GetVirtualNetworkLinkInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVirtualNetworkLinkResult> getVirtualNetworkLink(GetVirtualNetworkLinkArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkLinkResult> getVirtualNetworkLink(GetVirtualNetworkLinkArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:privatedns:getVirtualNetworkLink
  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.
    VirtualNetworkLinkName string
    The name of the virtual network link.
    PrivateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    ResourceGroupName string
    The name of the resource group.
    VirtualNetworkLinkName string
    The name of the virtual network link.
    privateZoneName String
    The name of the Private DNS zone (without a terminating dot).
    resourceGroupName String
    The name of the resource group.
    virtualNetworkLinkName String
    The name of the virtual network link.
    privateZoneName string
    The name of the Private DNS zone (without a terminating dot).
    resourceGroupName string
    The name of the resource group.
    virtualNetworkLinkName string
    The name of the virtual network link.
    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.
    virtual_network_link_name str
    The name of the virtual network link.
    privateZoneName String
    The name of the Private DNS zone (without a terminating dot).
    resourceGroupName String
    The name of the resource group.
    virtualNetworkLinkName String
    The name of the virtual network link.

    getVirtualNetworkLink 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}'.
    Name string
    The name of the resource
    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'.
    VirtualNetworkLinkState string
    The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.
    Etag string
    The ETag of the virtual network link.
    Location string
    The Azure Region where the resource lives
    RegistrationEnabled bool
    Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?
    ResolutionPolicy string
    The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response.
    Tags Dictionary<string, string>
    Resource tags.
    VirtualNetwork Pulumi.AzureNative.PrivateDns.Outputs.SubResourceResponse
    The reference of the virtual network.
    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}'.
    Name string
    The name of the resource
    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'.
    VirtualNetworkLinkState string
    The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.
    Etag string
    The ETag of the virtual network link.
    Location string
    The Azure Region where the resource lives
    RegistrationEnabled bool
    Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?
    ResolutionPolicy string
    The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response.
    Tags map[string]string
    Resource tags.
    VirtualNetwork SubResourceResponse
    The reference of the virtual network.
    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}'.
    name String
    The name of the resource
    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'.
    virtualNetworkLinkState String
    The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.
    etag String
    The ETag of the virtual network link.
    location String
    The Azure Region where the resource lives
    registrationEnabled Boolean
    Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?
    resolutionPolicy String
    The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response.
    tags Map<String,String>
    Resource tags.
    virtualNetwork SubResourceResponse
    The reference of the virtual network.
    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}'.
    name string
    The name of the resource
    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'.
    virtualNetworkLinkState string
    The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.
    etag string
    The ETag of the virtual network link.
    location string
    The Azure Region where the resource lives
    registrationEnabled boolean
    Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?
    resolutionPolicy string
    The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response.
    tags {[key: string]: string}
    Resource tags.
    virtualNetwork SubResourceResponse
    The reference of the virtual network.
    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}'.
    name str
    The name of the resource
    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'.
    virtual_network_link_state str
    The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.
    etag str
    The ETag of the virtual network link.
    location str
    The Azure Region where the resource lives
    registration_enabled bool
    Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?
    resolution_policy str
    The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response.
    tags Mapping[str, str]
    Resource tags.
    virtual_network SubResourceResponse
    The reference of the virtual network.
    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}'.
    name String
    The name of the resource
    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'.
    virtualNetworkLinkState String
    The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.
    etag String
    The ETag of the virtual network link.
    location String
    The Azure Region where the resource lives
    registrationEnabled Boolean
    Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?
    resolutionPolicy String
    The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response.
    tags Map<String>
    Resource tags.
    virtualNetwork Property Map
    The reference of the virtual network.

    Supporting Types

    SubResourceResponse

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    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.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native