1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. hybridcontainerservice
  6. getVirtualNetworkRetrieve
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.20.0
published on Thursday, Jul 9, 2026 by Pulumi
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.
Viewing docs for Azure Native v3.20.0
published on Thursday, Jul 9, 2026 by Pulumi

    Gets the specified virtual network resource

    Uses Azure REST API version 2024-01-01.

    Other available API versions: 2023-11-15-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native hybridcontainerservice [ApiVersion]. See the version guide for details.

    Using getVirtualNetworkRetrieve

    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 getVirtualNetworkRetrieve(args: GetVirtualNetworkRetrieveArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkRetrieveResult>
    function getVirtualNetworkRetrieveOutput(args: GetVirtualNetworkRetrieveOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkRetrieveResult>
    def get_virtual_network_retrieve(resource_group_name: Optional[str] = None,
                                     virtual_network_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkRetrieveResult
    def get_virtual_network_retrieve_output(resource_group_name: pulumi.Input[Optional[str]] = None,
                                     virtual_network_name: pulumi.Input[Optional[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkRetrieveResult]
    func LookupVirtualNetworkRetrieve(ctx *Context, args *LookupVirtualNetworkRetrieveArgs, opts ...InvokeOption) (*LookupVirtualNetworkRetrieveResult, error)
    func LookupVirtualNetworkRetrieveOutput(ctx *Context, args *LookupVirtualNetworkRetrieveOutputArgs, opts ...InvokeOption) LookupVirtualNetworkRetrieveResultOutput

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

    public static class GetVirtualNetworkRetrieve 
    {
        public static Task<GetVirtualNetworkRetrieveResult> InvokeAsync(GetVirtualNetworkRetrieveArgs args, InvokeOptions? opts = null)
        public static Output<GetVirtualNetworkRetrieveResult> Invoke(GetVirtualNetworkRetrieveInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVirtualNetworkRetrieveResult> getVirtualNetworkRetrieve(GetVirtualNetworkRetrieveArgs args, InvokeOptions options)
    public static Output<GetVirtualNetworkRetrieveResult> getVirtualNetworkRetrieve(GetVirtualNetworkRetrieveArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:hybridcontainerservice:getVirtualNetworkRetrieve
      arguments:
        # arguments dictionary
    data "azure-native_hybridcontainerservice_getvirtualnetworkretrieve" "name" {
        # arguments
    }

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VirtualNetworkName string
    Parameter for the name of the virtual network
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VirtualNetworkName string
    Parameter for the name of the virtual network
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    virtual_network_name string
    Parameter for the name of the virtual network
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    virtualNetworkName String
    Parameter for the name of the virtual network
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    virtualNetworkName string
    Parameter for the name of the virtual network
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    virtual_network_name str
    Parameter for the name of the virtual network
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    virtualNetworkName String
    Parameter for the name of the virtual network

    getVirtualNetworkRetrieve 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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.HybridContainerService.Outputs.VirtualNetworkPropertiesResponse
    Properties of the virtual network resource
    SystemData Pulumi.AzureNative.HybridContainerService.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ExtendedLocation Pulumi.AzureNative.HybridContainerService.Outputs.VirtualNetworkResponseExtendedLocation
    Extended location pointing to the underlying infrastructure
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties VirtualNetworkPropertiesResponse
    Properties of the virtual network resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ExtendedLocation VirtualNetworkResponseExtendedLocation
    Extended location pointing to the underlying infrastructure
    Tags map[string]string
    Resource tags.
    azure_api_version string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties object
    Properties of the virtual network resource
    system_data object
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extended_location object
    Extended location pointing to the underlying infrastructure
    tags map(string)
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties VirtualNetworkPropertiesResponse
    Properties of the virtual network resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation VirtualNetworkResponseExtendedLocation
    Extended location pointing to the underlying infrastructure
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties VirtualNetworkPropertiesResponse
    Properties of the virtual network resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation VirtualNetworkResponseExtendedLocation
    Extended location pointing to the underlying infrastructure
    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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties VirtualNetworkPropertiesResponse
    Properties of the virtual network resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extended_location VirtualNetworkResponseExtendedLocation
    Extended location pointing to the underlying infrastructure
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    Properties of the virtual network resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    extendedLocation Property Map
    Extended location pointing to the underlying infrastructure
    tags Map<String>
    Resource tags.

    Supporting Types

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    VirtualNetworkPropertiesResponse

    ProvisioningState string
    Status Pulumi.AzureNative.HybridContainerService.Inputs.VirtualNetworkPropertiesResponseStatus
    Status of the virtual network resource
    DnsServers List<string>
    List of DNS server IP Addresses associated with the network
    Gateway string
    IP Address of the Gateway associated with the network
    InfraVnetProfile Pulumi.AzureNative.HybridContainerService.Inputs.VirtualNetworkPropertiesResponseInfraVnetProfile
    IpAddressPrefix string
    IP Address Prefix of the network
    VipPool List<Pulumi.AzureNative.HybridContainerService.Inputs.VirtualNetworkPropertiesResponseVipPool>
    Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer
    VlanID int
    VLAN Id used by the network
    VmipPool List<Pulumi.AzureNative.HybridContainerService.Inputs.VirtualNetworkPropertiesResponseVmipPool>
    Range of IP Addresses for Kubernetes node VMs
    ProvisioningState string
    Status VirtualNetworkPropertiesResponseStatus
    Status of the virtual network resource
    DnsServers []string
    List of DNS server IP Addresses associated with the network
    Gateway string
    IP Address of the Gateway associated with the network
    InfraVnetProfile VirtualNetworkPropertiesResponseInfraVnetProfile
    IpAddressPrefix string
    IP Address Prefix of the network
    VipPool []VirtualNetworkPropertiesResponseVipPool
    Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer
    VlanID int
    VLAN Id used by the network
    VmipPool []VirtualNetworkPropertiesResponseVmipPool
    Range of IP Addresses for Kubernetes node VMs
    provisioning_state string
    status object
    Status of the virtual network resource
    dns_servers list(string)
    List of DNS server IP Addresses associated with the network
    gateway string
    IP Address of the Gateway associated with the network
    infra_vnet_profile object
    ip_address_prefix string
    IP Address Prefix of the network
    vip_pool list(object)
    Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer
    vlan_id number
    VLAN Id used by the network
    vmip_pool list(object)
    Range of IP Addresses for Kubernetes node VMs
    provisioningState String
    status VirtualNetworkPropertiesResponseStatus
    Status of the virtual network resource
    dnsServers List<String>
    List of DNS server IP Addresses associated with the network
    gateway String
    IP Address of the Gateway associated with the network
    infraVnetProfile VirtualNetworkPropertiesResponseInfraVnetProfile
    ipAddressPrefix String
    IP Address Prefix of the network
    vipPool List<VirtualNetworkPropertiesResponseVipPool>
    Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer
    vlanID Integer
    VLAN Id used by the network
    vmipPool List<VirtualNetworkPropertiesResponseVmipPool>
    Range of IP Addresses for Kubernetes node VMs
    provisioningState string
    status VirtualNetworkPropertiesResponseStatus
    Status of the virtual network resource
    dnsServers string[]
    List of DNS server IP Addresses associated with the network
    gateway string
    IP Address of the Gateway associated with the network
    infraVnetProfile VirtualNetworkPropertiesResponseInfraVnetProfile
    ipAddressPrefix string
    IP Address Prefix of the network
    vipPool VirtualNetworkPropertiesResponseVipPool[]
    Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer
    vlanID number
    VLAN Id used by the network
    vmipPool VirtualNetworkPropertiesResponseVmipPool[]
    Range of IP Addresses for Kubernetes node VMs
    provisioning_state str
    status VirtualNetworkPropertiesResponseStatus
    Status of the virtual network resource
    dns_servers Sequence[str]
    List of DNS server IP Addresses associated with the network
    gateway str
    IP Address of the Gateway associated with the network
    infra_vnet_profile VirtualNetworkPropertiesResponseInfraVnetProfile
    ip_address_prefix str
    IP Address Prefix of the network
    vip_pool Sequence[VirtualNetworkPropertiesResponseVipPool]
    Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer
    vlan_id int
    VLAN Id used by the network
    vmip_pool Sequence[VirtualNetworkPropertiesResponseVmipPool]
    Range of IP Addresses for Kubernetes node VMs
    provisioningState String
    status Property Map
    Status of the virtual network resource
    dnsServers List<String>
    List of DNS server IP Addresses associated with the network
    gateway String
    IP Address of the Gateway associated with the network
    infraVnetProfile Property Map
    ipAddressPrefix String
    IP Address Prefix of the network
    vipPool List<Property Map>
    Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer
    vlanID Number
    VLAN Id used by the network
    vmipPool List<Property Map>
    Range of IP Addresses for Kubernetes node VMs

    VirtualNetworkPropertiesResponseError

    Code string
    The error code from the operation.
    Message string
    The error message from the operation.
    Code string
    The error code from the operation.
    Message string
    The error message from the operation.
    code string
    The error code from the operation.
    message string
    The error message from the operation.
    code String
    The error code from the operation.
    message String
    The error message from the operation.
    code string
    The error code from the operation.
    message string
    The error message from the operation.
    code str
    The error code from the operation.
    message str
    The error message from the operation.
    code String
    The error code from the operation.
    message String
    The error message from the operation.

    VirtualNetworkPropertiesResponseHci

    MocGroup string
    Group in MOC(Microsoft On-premises Cloud)
    MocLocation string
    Location in MOC(Microsoft On-premises Cloud)
    MocVnetName string
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    MocGroup string
    Group in MOC(Microsoft On-premises Cloud)
    MocLocation string
    Location in MOC(Microsoft On-premises Cloud)
    MocVnetName string
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    moc_group string
    Group in MOC(Microsoft On-premises Cloud)
    moc_location string
    Location in MOC(Microsoft On-premises Cloud)
    moc_vnet_name string
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    mocGroup String
    Group in MOC(Microsoft On-premises Cloud)
    mocLocation String
    Location in MOC(Microsoft On-premises Cloud)
    mocVnetName String
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    mocGroup string
    Group in MOC(Microsoft On-premises Cloud)
    mocLocation string
    Location in MOC(Microsoft On-premises Cloud)
    mocVnetName string
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    moc_group str
    Group in MOC(Microsoft On-premises Cloud)
    moc_location str
    Location in MOC(Microsoft On-premises Cloud)
    moc_vnet_name str
    Virtual Network name in MOC(Microsoft On-premises Cloud)
    mocGroup String
    Group in MOC(Microsoft On-premises Cloud)
    mocLocation String
    Location in MOC(Microsoft On-premises Cloud)
    mocVnetName String
    Virtual Network name in MOC(Microsoft On-premises Cloud)

    VirtualNetworkPropertiesResponseInfraVnetProfile

    Hci VirtualNetworkPropertiesResponseHci
    Infrastructure network profile for HCI platform
    hci object
    Infrastructure network profile for HCI platform
    hci VirtualNetworkPropertiesResponseHci
    Infrastructure network profile for HCI platform
    hci VirtualNetworkPropertiesResponseHci
    Infrastructure network profile for HCI platform
    hci VirtualNetworkPropertiesResponseHci
    Infrastructure network profile for HCI platform
    hci Property Map
    Infrastructure network profile for HCI platform

    VirtualNetworkPropertiesResponseOperationStatus

    Error Pulumi.AzureNative.HybridContainerService.Inputs.VirtualNetworkPropertiesResponseError
    The error if any from the operation.
    OperationId string
    The identifier of the operation.
    Status string
    The status of the operation.
    Error VirtualNetworkPropertiesResponseError
    The error if any from the operation.
    OperationId string
    The identifier of the operation.
    Status string
    The status of the operation.
    error object
    The error if any from the operation.
    operation_id string
    The identifier of the operation.
    status string
    The status of the operation.
    error VirtualNetworkPropertiesResponseError
    The error if any from the operation.
    operationId String
    The identifier of the operation.
    status String
    The status of the operation.
    error VirtualNetworkPropertiesResponseError
    The error if any from the operation.
    operationId string
    The identifier of the operation.
    status string
    The status of the operation.
    error VirtualNetworkPropertiesResponseError
    The error if any from the operation.
    operation_id str
    The identifier of the operation.
    status str
    The status of the operation.
    error Property Map
    The error if any from the operation.
    operationId String
    The identifier of the operation.
    status String
    The status of the operation.

    VirtualNetworkPropertiesResponseStatus

    OperationStatus VirtualNetworkPropertiesResponseOperationStatus
    The detailed status of the long running operation.
    operation_status object
    The detailed status of the long running operation.
    operationStatus VirtualNetworkPropertiesResponseOperationStatus
    The detailed status of the long running operation.
    operationStatus VirtualNetworkPropertiesResponseOperationStatus
    The detailed status of the long running operation.
    operation_status VirtualNetworkPropertiesResponseOperationStatus
    The detailed status of the long running operation.
    operationStatus Property Map
    The detailed status of the long running operation.

    VirtualNetworkPropertiesResponseVipPool

    EndIP string
    Ending IP address for the IP Pool
    StartIP string
    Starting IP address for the IP Pool
    EndIP string
    Ending IP address for the IP Pool
    StartIP string
    Starting IP address for the IP Pool
    end_ip string
    Ending IP address for the IP Pool
    start_ip string
    Starting IP address for the IP Pool
    endIP String
    Ending IP address for the IP Pool
    startIP String
    Starting IP address for the IP Pool
    endIP string
    Ending IP address for the IP Pool
    startIP string
    Starting IP address for the IP Pool
    end_ip str
    Ending IP address for the IP Pool
    start_ip str
    Starting IP address for the IP Pool
    endIP String
    Ending IP address for the IP Pool
    startIP String
    Starting IP address for the IP Pool

    VirtualNetworkPropertiesResponseVmipPool

    EndIP string
    Ending IP address for the IP Pool
    StartIP string
    Starting IP address for the IP Pool
    EndIP string
    Ending IP address for the IP Pool
    StartIP string
    Starting IP address for the IP Pool
    end_ip string
    Ending IP address for the IP Pool
    start_ip string
    Starting IP address for the IP Pool
    endIP String
    Ending IP address for the IP Pool
    startIP String
    Starting IP address for the IP Pool
    endIP string
    Ending IP address for the IP Pool
    startIP string
    Starting IP address for the IP Pool
    end_ip str
    Ending IP address for the IP Pool
    start_ip str
    Starting IP address for the IP Pool
    endIP String
    Ending IP address for the IP Pool
    startIP String
    Starting IP address for the IP Pool

    VirtualNetworkResponseExtendedLocation

    Name string
    ARM Id of the extended location.
    Type string
    The extended location type. Allowed value: 'CustomLocation'
    Name string
    ARM Id of the extended location.
    Type string
    The extended location type. Allowed value: 'CustomLocation'
    name string
    ARM Id of the extended location.
    type string
    The extended location type. Allowed value: 'CustomLocation'
    name String
    ARM Id of the extended location.
    type String
    The extended location type. Allowed value: 'CustomLocation'
    name string
    ARM Id of the extended location.
    type string
    The extended location type. Allowed value: 'CustomLocation'
    name str
    ARM Id of the extended location.
    type str
    The extended location type. Allowed value: 'CustomLocation'
    name String
    ARM Id of the extended location.
    type String
    The extended location type. Allowed value: 'CustomLocation'

    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.
    Viewing docs for Azure Native v3.20.0
    published on Thursday, Jul 9, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial