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
published on Thursday, Jul 9, 2026 by Pulumi
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
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 dictionarydata "azure-native_hybridcontainerservice_getvirtualnetworkretrieve" "name" {
# arguments
}The following arguments are supported:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Virtual
Network stringName - Parameter for the name of the virtual network
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Virtual
Network stringName - Parameter for the name of the virtual network
- resource_
group_ stringname - The name of the resource group. The name is case insensitive.
- virtual_
network_ stringname - Parameter for the name of the virtual network
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- virtual
Network StringName - Parameter for the name of the virtual network
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- virtual
Network stringName - Parameter for the name of the virtual network
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- virtual_
network_ strname - Parameter for the name of the virtual network
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- virtual
Network StringName - Parameter for the name of the virtual network
getVirtualNetworkRetrieve Result
The following output properties are available:
- Azure
Api stringVersion - 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.
Azure Native. Hybrid Container Service. Outputs. Virtual Network Properties Response - Properties of the virtual network resource
- System
Data Pulumi.Azure Native. Hybrid Container Service. Outputs. System Data Response - 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 Pulumi.Azure Native. Hybrid Container Service. Outputs. Virtual Network Response Extended Location - Extended location pointing to the underlying infrastructure
- Dictionary<string, string>
- Resource tags.
- Azure
Api stringVersion - 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
Virtual
Network Properties Response - Properties of the virtual network resource
- System
Data SystemData Response - 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 VirtualNetwork Response Extended Location - Extended location pointing to the underlying infrastructure
- map[string]string
- Resource tags.
- azure_
api_ stringversion - 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
- map(string)
- Resource tags.
- azure
Api StringVersion - 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
Virtual
Network Properties Response - Properties of the virtual network resource
- system
Data SystemData Response - 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 VirtualNetwork Response Extended Location - Extended location pointing to the underlying infrastructure
- Map<String,String>
- Resource tags.
- azure
Api stringVersion - 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
Virtual
Network Properties Response - Properties of the virtual network resource
- system
Data SystemData Response - 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 VirtualNetwork Response Extended Location - Extended location pointing to the underlying infrastructure
- {[key: string]: string}
- Resource tags.
- azure_
api_ strversion - 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
Virtual
Network Properties Response - Properties of the virtual network resource
- system_
data SystemData Response - 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 VirtualNetwork Response Extended Location - Extended location pointing to the underlying infrastructure
- Mapping[str, str]
- Resource tags.
- azure
Api StringVersion - 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
- system
Data 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"
- extended
Location Property Map - Extended location pointing to the underlying infrastructure
- Map<String>
- Resource tags.
Supporting Types
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - 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 stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - 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_ stringtype - The type of identity that created the resource.
- last_
modified_ stringat - The timestamp of resource last modification (UTC)
- last_
modified_ stringby - The identity that last modified the resource.
- last_
modified_ stringby_ type - 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 StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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 stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - 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 StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
VirtualNetworkPropertiesResponse
- Provisioning
State string - Status
Pulumi.
Azure Native. Hybrid Container Service. Inputs. Virtual Network Properties Response Status - 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 Pulumi.Profile Azure Native. Hybrid Container Service. Inputs. Virtual Network Properties Response Infra Vnet Profile - Ip
Address stringPrefix - IP Address Prefix of the network
- Vip
Pool List<Pulumi.Azure Native. Hybrid Container Service. Inputs. Virtual Network Properties Response Vip Pool> - 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 List<Pulumi.Azure Native. Hybrid Container Service. Inputs. Virtual Network Properties Response Vmip Pool> - Range of IP Addresses for Kubernetes node VMs
- Provisioning
State string - Status
Virtual
Network Properties Response Status - Status of the virtual network resource
- Dns
Servers []string - List of DNS server IP Addresses associated with the network
- Gateway string
- IP Address of the Gateway associated with the network
- Infra
Vnet VirtualProfile Network Properties Response Infra Vnet Profile - Ip
Address stringPrefix - IP Address Prefix of the network
- Vip
Pool []VirtualNetwork Properties Response Vip Pool - 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 []VirtualNetwork Properties Response Vmip Pool - 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_ objectprofile - ip_
address_ stringprefix - 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
- provisioning
State String - status
Virtual
Network Properties Response Status - 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 VirtualProfile Network Properties Response Infra Vnet Profile - ip
Address StringPrefix - IP Address Prefix of the network
- vip
Pool List<VirtualNetwork Properties Response Vip Pool> - Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer
- vlan
ID Integer - VLAN Id used by the network
- vmip
Pool List<VirtualNetwork Properties Response Vmip Pool> - Range of IP Addresses for Kubernetes node VMs
- provisioning
State string - status
Virtual
Network Properties Response Status - Status of the virtual network resource
- dns
Servers string[] - List of DNS server IP Addresses associated with the network
- gateway string
- IP Address of the Gateway associated with the network
- infra
Vnet VirtualProfile Network Properties Response Infra Vnet Profile - ip
Address stringPrefix - IP Address Prefix of the network
- vip
Pool VirtualNetwork Properties Response Vip Pool[] - 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 VirtualNetwork Properties Response Vmip Pool[] - Range of IP Addresses for Kubernetes node VMs
- provisioning_
state str - status
Virtual
Network Properties Response Status - 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_ Virtualprofile Network Properties Response Infra Vnet Profile - ip_
address_ strprefix - IP Address Prefix of the network
- vip_
pool Sequence[VirtualNetwork Properties Response Vip Pool] - 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[VirtualNetwork Properties Response Vmip Pool] - Range of IP Addresses for Kubernetes node VMs
- provisioning
State String - status Property Map
- 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 Property MapProfile - ip
Address StringPrefix - IP Address Prefix of the network
- vip
Pool List<Property Map> - 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<Property Map> - Range of IP Addresses for Kubernetes node VMs
VirtualNetworkPropertiesResponseError
VirtualNetworkPropertiesResponseHci
- Moc
Group string - Group in MOC(Microsoft On-premises Cloud)
- Moc
Location string - Location in MOC(Microsoft On-premises Cloud)
- Moc
Vnet stringName - 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 stringName - 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_ stringname - 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 StringName - 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 stringName - 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_ strname - 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 StringName - Virtual Network name in MOC(Microsoft On-premises Cloud)
VirtualNetworkPropertiesResponseInfraVnetProfile
- Hci
Pulumi.
Azure Native. Hybrid Container Service. Inputs. Virtual Network Properties Response Hci - Infrastructure network profile for HCI platform
- Hci
Virtual
Network Properties Response Hci - Infrastructure network profile for HCI platform
- hci
Virtual
Network Properties Response Hci - Infrastructure network profile for HCI platform
- hci
Virtual
Network Properties Response Hci - Infrastructure network profile for HCI platform
- hci
Virtual
Network Properties Response Hci - Infrastructure network profile for HCI platform
- hci Property Map
- Infrastructure network profile for HCI platform
VirtualNetworkPropertiesResponseOperationStatus
- Error
Pulumi.
Azure Native. Hybrid Container Service. Inputs. Virtual Network Properties Response Error - The error if any from the operation.
- Operation
Id string - The identifier of the operation.
- Status string
- The status of the operation.
- Error
Virtual
Network Properties Response Error - The error if any from the operation.
- Operation
Id 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
Virtual
Network Properties Response Error - The error if any from the operation.
- operation
Id String - The identifier of the operation.
- status String
- The status of the operation.
- error
Virtual
Network Properties Response Error - The error if any from the operation.
- operation
Id string - The identifier of the operation.
- status string
- The status of the operation.
- error
Virtual
Network Properties Response Error - 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.
- operation
Id String - The identifier of the operation.
- status String
- The status of the operation.
VirtualNetworkPropertiesResponseStatus
- Operation
Status Pulumi.Azure Native. Hybrid Container Service. Inputs. Virtual Network Properties Response Operation Status - The detailed status of the long running operation.
- Operation
Status VirtualNetwork Properties Response Operation Status - The detailed status of the long running operation.
- operation_
status object - The detailed status of the long running operation.
- operation
Status VirtualNetwork Properties Response Operation Status - The detailed status of the long running operation.
- operation
Status VirtualNetwork Properties Response Operation Status - The detailed status of the long running operation.
- operation_
status VirtualNetwork Properties Response Operation Status - The detailed status of the long running operation.
- operation
Status Property Map - The detailed status of the long running operation.
VirtualNetworkPropertiesResponseVipPool
VirtualNetworkPropertiesResponseVmipPool
VirtualNetworkResponseExtendedLocation
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
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
published on Thursday, Jul 9, 2026 by Pulumi