published on Friday, Mar 20, 2026 by Pulumi
published on Friday, Mar 20, 2026 by Pulumi
The virtual network resource definition.
Uses Azure REST API version 2023-07-01-preview.
Other available API versions: 2022-12-15-preview, 2025-09-01-preview, 2026-02-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurestackhci [ApiVersion]. See the version guide for details.
Using getVirtualNetwork
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 getVirtualNetwork(args: GetVirtualNetworkArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkResult>
function getVirtualNetworkOutput(args: GetVirtualNetworkOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkResult>def get_virtual_network(resource_group_name: Optional[str] = None,
virtual_network_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkResult
def get_virtual_network_output(resource_group_name: Optional[pulumi.Input[str]] = None,
virtual_network_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkResult]func LookupVirtualNetwork(ctx *Context, args *LookupVirtualNetworkArgs, opts ...InvokeOption) (*LookupVirtualNetworkResult, error)
func LookupVirtualNetworkOutput(ctx *Context, args *LookupVirtualNetworkOutputArgs, opts ...InvokeOption) LookupVirtualNetworkResultOutput> Note: This function is named LookupVirtualNetwork in the Go SDK.
public static class GetVirtualNetwork
{
public static Task<GetVirtualNetworkResult> InvokeAsync(GetVirtualNetworkArgs args, InvokeOptions? opts = null)
public static Output<GetVirtualNetworkResult> Invoke(GetVirtualNetworkInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetVirtualNetworkResult> getVirtualNetwork(GetVirtualNetworkArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkResult> getVirtualNetwork(GetVirtualNetworkArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:azurestackhci:getVirtualNetwork
arguments:
# arguments dictionaryThe following arguments are supported:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Virtual
Network stringName - Name of the virtual network
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Virtual
Network stringName - Name of the virtual network
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- virtual
Network StringName - Name of the virtual network
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- virtual
Network stringName - Name of the virtual network
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- virtual_
network_ strname - Name of the virtual network
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- virtual
Network StringName - Name of the virtual network
getVirtualNetwork 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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Provisioning
State string - Provisioning state of the virtual network.
- Status
Pulumi.
Azure Native. Azure Stack HCI. Outputs. Virtual Network Status Response - The observed state of virtual networks
- System
Data Pulumi.Azure Native. Azure Stack HCI. 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"
- Dhcp
Options Pulumi.Azure Native. Azure Stack HCI. Outputs. Virtual Network Properties Response Dhcp Options - DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.
- Extended
Location Pulumi.Azure Native. Azure Stack HCI. Outputs. Extended Location Response - The extendedLocation of the resource.
- Network
Type string - Type of the network
- Subnets
List<Pulumi.
Azure Native. Azure Stack HCI. Outputs. Virtual Network Properties Response Subnets> - Subnet - list of subnets under the virtual network
- Dictionary<string, string>
- Resource tags.
- Vm
Switch stringName - name of the network switch to be used for VMs
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- Provisioning
State string - Provisioning state of the virtual network.
- Status
Virtual
Network Status Response - The observed state of virtual networks
- 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"
- Dhcp
Options VirtualNetwork Properties Response Dhcp Options - DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.
- Extended
Location ExtendedLocation Response - The extendedLocation of the resource.
- Network
Type string - Type of the network
- Subnets
[]Virtual
Network Properties Response Subnets - Subnet - list of subnets under the virtual network
- map[string]string
- Resource tags.
- Vm
Switch stringName - name of the network switch to be used for VMs
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- provisioning
State String - Provisioning state of the virtual network.
- status
Virtual
Network Status Response - The observed state of virtual networks
- 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"
- dhcp
Options VirtualNetwork Properties Response Dhcp Options - DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.
- extended
Location ExtendedLocation Response - The extendedLocation of the resource.
- network
Type String - Type of the network
- subnets
List<Virtual
Network Properties Response Subnets> - Subnet - list of subnets under the virtual network
- Map<String,String>
- Resource tags.
- vm
Switch StringName - name of the network switch to be used for VMs
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- provisioning
State string - Provisioning state of the virtual network.
- status
Virtual
Network Status Response - The observed state of virtual networks
- 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"
- dhcp
Options VirtualNetwork Properties Response Dhcp Options - DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.
- extended
Location ExtendedLocation Response - The extendedLocation of the resource.
- network
Type string - Type of the network
- subnets
Virtual
Network Properties Response Subnets[] - Subnet - list of subnets under the virtual network
- {[key: string]: string}
- Resource tags.
- vm
Switch stringName - name of the network switch to be used for VMs
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- provisioning_
state str - Provisioning state of the virtual network.
- status
Virtual
Network Status Response - The observed state of virtual networks
- 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"
- dhcp_
options VirtualNetwork Properties Response Dhcp Options - DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.
- extended_
location ExtendedLocation Response - The extendedLocation of the resource.
- network_
type str - Type of the network
- subnets
Sequence[Virtual
Network Properties Response Subnets] - Subnet - list of subnets under the virtual network
- Mapping[str, str]
- Resource tags.
- vm_
switch_ strname - name of the network switch to be used for VMs
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- provisioning
State String - Provisioning state of the virtual network.
- status Property Map
- The observed state of virtual networks
- 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"
- dhcp
Options Property Map - DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options.
- extended
Location Property Map - The extendedLocation of the resource.
- network
Type String - Type of the network
- subnets List<Property Map>
- Subnet - list of subnets under the virtual network
- Map<String>
- Resource tags.
- vm
Switch StringName - name of the network switch to be used for VMs
Supporting Types
ExtendedLocationResponse
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 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.
VirtualNetworkPropertiesResponseDhcpOptions
- Dns
Servers List<string> - The list of DNS servers IP addresses.
- Dns
Servers []string - The list of DNS servers IP addresses.
- dns
Servers List<String> - The list of DNS servers IP addresses.
- dns
Servers string[] - The list of DNS servers IP addresses.
- dns_
servers Sequence[str] - The list of DNS servers IP addresses.
- dns
Servers List<String> - The list of DNS servers IP addresses.
VirtualNetworkPropertiesResponseIpConfigurationReferences
- Id string
- IPConfigurationID
- Id string
- IPConfigurationID
- id String
- IPConfigurationID
- id string
- IPConfigurationID
- id str
- IPConfigurationID
- id String
- IPConfigurationID
VirtualNetworkPropertiesResponseRouteTable
- Id string
- Etag - Gets a unique read-only string that changes whenever the resource is updated.
- Name string
- Name - READ-ONLY; Resource name.
- Routes
List<Pulumi.
Azure Native. Azure Stack HCI. Inputs. Virtual Network Properties Response Routes> - Routes - Collection of routes contained within a route table.
- Type string
- Type - READ-ONLY; Resource type.
- Id string
- Etag - Gets a unique read-only string that changes whenever the resource is updated.
- Name string
- Name - READ-ONLY; Resource name.
- Routes
[]Virtual
Network Properties Response Routes - Routes - Collection of routes contained within a route table.
- Type string
- Type - READ-ONLY; Resource type.
- id String
- Etag - Gets a unique read-only string that changes whenever the resource is updated.
- name String
- Name - READ-ONLY; Resource name.
- routes
List<Virtual
Network Properties Response Routes> - Routes - Collection of routes contained within a route table.
- type String
- Type - READ-ONLY; Resource type.
- id string
- Etag - Gets a unique read-only string that changes whenever the resource is updated.
- name string
- Name - READ-ONLY; Resource name.
- routes
Virtual
Network Properties Response Routes[] - Routes - Collection of routes contained within a route table.
- type string
- Type - READ-ONLY; Resource type.
- id str
- Etag - Gets a unique read-only string that changes whenever the resource is updated.
- name str
- Name - READ-ONLY; Resource name.
- routes
Sequence[Virtual
Network Properties Response Routes] - Routes - Collection of routes contained within a route table.
- type str
- Type - READ-ONLY; Resource type.
- id String
- Etag - Gets a unique read-only string that changes whenever the resource is updated.
- name String
- Name - READ-ONLY; Resource name.
- routes List<Property Map>
- Routes - Collection of routes contained within a route table.
- type String
- Type - READ-ONLY; Resource type.
VirtualNetworkPropertiesResponseRoutes
- Address
Prefix string - AddressPrefix - The destination CIDR to which the route applies.
- Name string
- Name - name of the subnet
- Next
Hop stringIp Address - NextHopIPAddress - The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
- Address
Prefix string - AddressPrefix - The destination CIDR to which the route applies.
- Name string
- Name - name of the subnet
- Next
Hop stringIp Address - NextHopIPAddress - The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
- address
Prefix String - AddressPrefix - The destination CIDR to which the route applies.
- name String
- Name - name of the subnet
- next
Hop StringIp Address - NextHopIPAddress - The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
- address
Prefix string - AddressPrefix - The destination CIDR to which the route applies.
- name string
- Name - name of the subnet
- next
Hop stringIp Address - NextHopIPAddress - The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
- address_
prefix str - AddressPrefix - The destination CIDR to which the route applies.
- name str
- Name - name of the subnet
- next_
hop_ strip_ address - NextHopIPAddress - The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
- address
Prefix String - AddressPrefix - The destination CIDR to which the route applies.
- name String
- Name - name of the subnet
- next
Hop StringIp Address - NextHopIPAddress - The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
VirtualNetworkPropertiesResponseSubnets
- Address
Prefix string - Cidr for this subnet - IPv4, IPv6
- Address
Prefixes List<string> - AddressPrefixes - List of address prefixes for the subnet.
- Ip
Allocation stringMethod - IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- Ip
Configuration List<Pulumi.References Azure Native. Azure Stack HCI. Inputs. Virtual Network Properties Response Ip Configuration References> - IPConfigurationReferences - list of IPConfigurationReferences
- Name string
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- Route
Table Pulumi.Azure Native. Azure Stack HCI. Inputs. Virtual Network Properties Response Route Table - RouteTable for the subnet
- Vlan int
- Vlan to use for the subnet
- Address
Prefix string - Cidr for this subnet - IPv4, IPv6
- Address
Prefixes []string - AddressPrefixes - List of address prefixes for the subnet.
- Ip
Allocation stringMethod - IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- Ip
Configuration []VirtualReferences Network Properties Response Ip Configuration References - IPConfigurationReferences - list of IPConfigurationReferences
- Name string
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- Route
Table VirtualNetwork Properties Response Route Table - RouteTable for the subnet
- Vlan int
- Vlan to use for the subnet
- address
Prefix String - Cidr for this subnet - IPv4, IPv6
- address
Prefixes List<String> - AddressPrefixes - List of address prefixes for the subnet.
- ip
Allocation StringMethod - IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- ip
Configuration List<VirtualReferences Network Properties Response Ip Configuration References> - IPConfigurationReferences - list of IPConfigurationReferences
- name String
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- route
Table VirtualNetwork Properties Response Route Table - RouteTable for the subnet
- vlan Integer
- Vlan to use for the subnet
- address
Prefix string - Cidr for this subnet - IPv4, IPv6
- address
Prefixes string[] - AddressPrefixes - List of address prefixes for the subnet.
- ip
Allocation stringMethod - IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- ip
Configuration VirtualReferences Network Properties Response Ip Configuration References[] - IPConfigurationReferences - list of IPConfigurationReferences
- name string
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- route
Table VirtualNetwork Properties Response Route Table - RouteTable for the subnet
- vlan number
- Vlan to use for the subnet
- address_
prefix str - Cidr for this subnet - IPv4, IPv6
- address_
prefixes Sequence[str] - AddressPrefixes - List of address prefixes for the subnet.
- ip_
allocation_ strmethod - IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- ip_
configuration_ Sequence[Virtualreferences Network Properties Response Ip Configuration References] - IPConfigurationReferences - list of IPConfigurationReferences
- name str
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- route_
table VirtualNetwork Properties Response Route Table - RouteTable for the subnet
- vlan int
- Vlan to use for the subnet
- address
Prefix String - Cidr for this subnet - IPv4, IPv6
- address
Prefixes List<String> - AddressPrefixes - List of address prefixes for the subnet.
- ip
Allocation StringMethod - IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'
- ip
Configuration List<Property Map>References - IPConfigurationReferences - list of IPConfigurationReferences
- name String
- Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.
- route
Table Property Map - RouteTable for the subnet
- vlan Number
- Vlan to use for the subnet
VirtualNetworkStatusResponse
- Error
Code string - VirtualNetwork provisioning error code
- Error
Message string - Descriptive error message
- Provisioning
Status Pulumi.Azure Native. Azure Stack HCI. Inputs. Virtual Network Status Response Provisioning Status
- Error
Code string - VirtualNetwork provisioning error code
- Error
Message string - Descriptive error message
- Provisioning
Status VirtualNetwork Status Response Provisioning Status
- error
Code String - VirtualNetwork provisioning error code
- error
Message String - Descriptive error message
- provisioning
Status VirtualNetwork Status Response Provisioning Status
- error
Code string - VirtualNetwork provisioning error code
- error
Message string - Descriptive error message
- provisioning
Status VirtualNetwork Status Response Provisioning Status
- error_
code str - VirtualNetwork provisioning error code
- error_
message str - Descriptive error message
- provisioning_
status VirtualNetwork Status Response Provisioning Status
- error
Code String - VirtualNetwork provisioning error code
- error
Message String - Descriptive error message
- provisioning
Status Property Map
VirtualNetworkStatusResponseProvisioningStatus
- Operation
Id string - The ID of the operation performed on the virtual network
- Status string
- The status of the operation performed on the virtual network [Succeeded, Failed, InProgress]
- Operation
Id string - The ID of the operation performed on the virtual network
- Status string
- The status of the operation performed on the virtual network [Succeeded, Failed, InProgress]
- operation
Id String - The ID of the operation performed on the virtual network
- status String
- The status of the operation performed on the virtual network [Succeeded, Failed, InProgress]
- operation
Id string - The ID of the operation performed on the virtual network
- status string
- The status of the operation performed on the virtual network [Succeeded, Failed, InProgress]
- operation_
id str - The ID of the operation performed on the virtual network
- status str
- The status of the operation performed on the virtual network [Succeeded, Failed, InProgress]
- operation
Id String - The ID of the operation performed on the virtual network
- status String
- The status of the operation performed on the virtual network [Succeeded, Failed, InProgress]
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
published on Friday, Mar 20, 2026 by Pulumi
