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.13.0 published on Wednesday, Jan 28, 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.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
The operation to get a virtual network subnet.
Uses Azure REST API version 2025-09-01-preview.
Using getVirtualNetworkSubnet
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 getVirtualNetworkSubnet(args: GetVirtualNetworkSubnetArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkSubnetResult>
function getVirtualNetworkSubnetOutput(args: GetVirtualNetworkSubnetOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkSubnetResult>def get_virtual_network_subnet(resource_group_name: Optional[str] = None,
subnet_name: Optional[str] = None,
virtual_network_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkSubnetResult
def get_virtual_network_subnet_output(resource_group_name: Optional[pulumi.Input[str]] = None,
subnet_name: Optional[pulumi.Input[str]] = None,
virtual_network_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkSubnetResult]func LookupVirtualNetworkSubnet(ctx *Context, args *LookupVirtualNetworkSubnetArgs, opts ...InvokeOption) (*LookupVirtualNetworkSubnetResult, error)
func LookupVirtualNetworkSubnetOutput(ctx *Context, args *LookupVirtualNetworkSubnetOutputArgs, opts ...InvokeOption) LookupVirtualNetworkSubnetResultOutput> Note: This function is named LookupVirtualNetworkSubnet in the Go SDK.
public static class GetVirtualNetworkSubnet
{
public static Task<GetVirtualNetworkSubnetResult> InvokeAsync(GetVirtualNetworkSubnetArgs args, InvokeOptions? opts = null)
public static Output<GetVirtualNetworkSubnetResult> Invoke(GetVirtualNetworkSubnetInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetVirtualNetworkSubnetResult> getVirtualNetworkSubnet(GetVirtualNetworkSubnetArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkSubnetResult> getVirtualNetworkSubnet(GetVirtualNetworkSubnetArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:azurestackhci:getVirtualNetworkSubnet
arguments:
# arguments dictionaryThe following arguments are supported:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Subnet
Name string - Name of the virtual network subnet
- Virtual
Network stringName - Name of the virtual network
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Subnet
Name string - Name of the virtual network subnet
- Virtual
Network stringName - Name of the virtual network
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- subnet
Name String - Name of the virtual network subnet
- virtual
Network StringName - Name of the virtual network
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- subnet
Name string - Name of the virtual network subnet
- virtual
Network stringName - Name of the virtual network
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- subnet_
name str - Name of the virtual network subnet
- virtual_
network_ strname - Name of the virtual network
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- subnet
Name String - Name of the virtual network subnet
- virtual
Network StringName - Name of the virtual network
getVirtualNetworkSubnet 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}"
- Name string
- The name of the resource
- Properties
Pulumi.
Azure Native. Azure Stack HCI. Outputs. Virtual Network Subnet Properties Response - The resource-specific properties for this resource.
- 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"
- Extended
Location Pulumi.Azure Native. Azure Stack HCI. Outputs. Extended Location Response - The extendedLocation of the resource.
- 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}"
- Name string
- The name of the resource
- Properties
Virtual
Network Subnet Properties Response - The resource-specific properties for this 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 ExtendedLocation Response - The extendedLocation of the resource.
- 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}"
- name String
- The name of the resource
- properties
Virtual
Network Subnet Properties Response - The resource-specific properties for this 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 ExtendedLocation Response - The extendedLocation of the resource.
- 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}"
- name string
- The name of the resource
- properties
Virtual
Network Subnet Properties Response - The resource-specific properties for this 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 ExtendedLocation Response - The extendedLocation of the resource.
- 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}"
- name str
- The name of the resource
- properties
Virtual
Network Subnet Properties Response - The resource-specific properties for this 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 ExtendedLocation Response - The extendedLocation of the resource.
- 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}"
- name String
- The name of the resource
- properties Property Map
- The resource-specific properties for this 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 - The extendedLocation of the resource.
Supporting Types
ExtendedLocationResponse
NatGatewayArmReferenceResponse
- Resource
Id string - The ARM ID for a Network Security Group.
- Resource
Id string - The ARM ID for a Network Security Group.
- resource
Id String - The ARM ID for a Network Security Group.
- resource
Id string - The ARM ID for a Network Security Group.
- resource_
id str - The ARM ID for a Network Security Group.
- resource
Id String - The ARM ID for a Network Security Group.
NetworkSecurityGroupArmReferenceResponse
- Id string
- The Azure Resource ID for a Network Security Group.
- Id string
- The Azure Resource ID for a Network Security Group.
- id String
- The Azure Resource ID for a Network Security Group.
- id string
- The Azure Resource ID for a Network Security Group.
- id str
- The Azure Resource ID for a Network Security Group.
- id String
- The Azure Resource ID for a Network Security Group.
RouteResponse
- Address
Prefix string - The destination CIDR to which the route applies.
- Name string
- Name - name of the subnet
- Next
Hop stringIp Address - 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 - The destination CIDR to which the route applies.
- Name string
- Name - name of the subnet
- Next
Hop stringIp Address - 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 - The destination CIDR to which the route applies.
- name String
- Name - name of the subnet
- next
Hop StringIp Address - 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 - The destination CIDR to which the route applies.
- name string
- Name - name of the subnet
- next
Hop stringIp Address - 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 - The destination CIDR to which the route applies.
- name str
- Name - name of the subnet
- next_
hop_ strip_ address - 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 - The destination CIDR to which the route applies.
- name String
- Name - name of the subnet
- next
Hop StringIp Address - The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
RouteTableResponse
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Name string
- Resource name.
- Type string
- Resource type.
- Routes
List<Pulumi.
Azure Native. Azure Stack HCI. Inputs. Route Response> - Collection of routes contained within a route table.
- Etag string
- A unique read-only string that changes whenever the resource is updated.
- Name string
- Resource name.
- Type string
- Resource type.
- Routes
[]Route
Response - Collection of routes contained within a route table.
- etag String
- A unique read-only string that changes whenever the resource is updated.
- name String
- Resource name.
- type String
- Resource type.
- routes
List<Route
Response> - Collection of routes contained within a route table.
- etag string
- A unique read-only string that changes whenever the resource is updated.
- name string
- Resource name.
- type string
- Resource type.
- routes
Route
Response[] - Collection of routes contained within a route table.
- etag str
- A unique read-only string that changes whenever the resource is updated.
- name str
- Resource name.
- type str
- Resource type.
- routes
Sequence[Route
Response] - Collection of routes contained within a route table.
- etag String
- A unique read-only string that changes whenever the resource is updated.
- name String
- Resource name.
- type String
- Resource type.
- routes List<Property Map>
- Collection of routes contained within a route table.
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.
VirtualNetworkSubnetIpConfigurationReferenceResponse
- Id string
- The Azure Resource ID for a Network Interface.
- Id string
- The Azure Resource ID for a Network Interface.
- id String
- The Azure Resource ID for a Network Interface.
- id string
- The Azure Resource ID for a Network Interface.
- id str
- The Azure Resource ID for a Network Interface.
- id String
- The Azure Resource ID for a Network Interface.
VirtualNetworkSubnetPropertiesResponse
- Address
Prefix string - Subnet CIDR
- Ip
Configurations List<Pulumi.Azure Native. Azure Stack HCI. Inputs. Virtual Network Subnet Ip Configuration Reference Response> - List of ip configurations for the subnet
- Provisioning
State string - The provisioning state of the virtual network subnet resource.
- Status
Pulumi.
Azure Native. Azure Stack HCI. Inputs. Virtual Network Subnet Status Response - The observed status of the virtual network subnet resource.
- Nat
Gateway Pulumi.Azure Native. Azure Stack HCI. Inputs. Nat Gateway Arm Reference Response - Nat Gateway attached to the subnet for non-vnet traffic.
- Network
Security Pulumi.Group Azure Native. Azure Stack HCI. Inputs. Network Security Group Arm Reference Response - Network Security Group attached to the subnet.
- Route
Table Pulumi.Azure Native. Azure Stack HCI. Inputs. Route Table Response - RouteTable defining custom routes for the subnet.
- Address
Prefix string - Subnet CIDR
- Ip
Configurations []VirtualNetwork Subnet Ip Configuration Reference Response - List of ip configurations for the subnet
- Provisioning
State string - The provisioning state of the virtual network subnet resource.
- Status
Virtual
Network Subnet Status Response - The observed status of the virtual network subnet resource.
- Nat
Gateway NatGateway Arm Reference Response - Nat Gateway attached to the subnet for non-vnet traffic.
- Network
Security NetworkGroup Security Group Arm Reference Response - Network Security Group attached to the subnet.
- Route
Table RouteTable Response - RouteTable defining custom routes for the subnet.
- address
Prefix String - Subnet CIDR
- ip
Configurations List<VirtualNetwork Subnet Ip Configuration Reference Response> - List of ip configurations for the subnet
- provisioning
State String - The provisioning state of the virtual network subnet resource.
- status
Virtual
Network Subnet Status Response - The observed status of the virtual network subnet resource.
- nat
Gateway NatGateway Arm Reference Response - Nat Gateway attached to the subnet for non-vnet traffic.
- network
Security NetworkGroup Security Group Arm Reference Response - Network Security Group attached to the subnet.
- route
Table RouteTable Response - RouteTable defining custom routes for the subnet.
- address
Prefix string - Subnet CIDR
- ip
Configurations VirtualNetwork Subnet Ip Configuration Reference Response[] - List of ip configurations for the subnet
- provisioning
State string - The provisioning state of the virtual network subnet resource.
- status
Virtual
Network Subnet Status Response - The observed status of the virtual network subnet resource.
- nat
Gateway NatGateway Arm Reference Response - Nat Gateway attached to the subnet for non-vnet traffic.
- network
Security NetworkGroup Security Group Arm Reference Response - Network Security Group attached to the subnet.
- route
Table RouteTable Response - RouteTable defining custom routes for the subnet.
- address_
prefix str - Subnet CIDR
- ip_
configurations Sequence[VirtualNetwork Subnet Ip Configuration Reference Response] - List of ip configurations for the subnet
- provisioning_
state str - The provisioning state of the virtual network subnet resource.
- status
Virtual
Network Subnet Status Response - The observed status of the virtual network subnet resource.
- nat_
gateway NatGateway Arm Reference Response - Nat Gateway attached to the subnet for non-vnet traffic.
- network_
security_ Networkgroup Security Group Arm Reference Response - Network Security Group attached to the subnet.
- route_
table RouteTable Response - RouteTable defining custom routes for the subnet.
- address
Prefix String - Subnet CIDR
- ip
Configurations List<Property Map> - List of ip configurations for the subnet
- provisioning
State String - The provisioning state of the virtual network subnet resource.
- status Property Map
- The observed status of the virtual network subnet resource.
- nat
Gateway Property Map - Nat Gateway attached to the subnet for non-vnet traffic.
- network
Security Property MapGroup - Network Security Group attached to the subnet.
- route
Table Property Map - RouteTable defining custom routes for the subnet.
VirtualNetworkSubnetStatusProvisioningStatusResponse
- Status string
- The status of the operation performed on the virtual network subnet [Succeeded, Failed, InProgress]
- Operation
Id string - The ID of the operation performed on the virtual network subnet
- Status string
- The status of the operation performed on the virtual network subnet [Succeeded, Failed, InProgress]
- Operation
Id string - The ID of the operation performed on the virtual network subnet
- status String
- The status of the operation performed on the virtual network subnet [Succeeded, Failed, InProgress]
- operation
Id String - The ID of the operation performed on the virtual network subnet
- status string
- The status of the operation performed on the virtual network subnet [Succeeded, Failed, InProgress]
- operation
Id string - The ID of the operation performed on the virtual network subnet
- status str
- The status of the operation performed on the virtual network subnet [Succeeded, Failed, InProgress]
- operation_
id str - The ID of the operation performed on the virtual network subnet
- status String
- The status of the operation performed on the virtual network subnet [Succeeded, Failed, InProgress]
- operation
Id String - The ID of the operation performed on the virtual network subnet
VirtualNetworkSubnetStatusResponse
- Error
Code string - VirtualNetworkSubnet provisioning error code
- Error
Message string - Descriptive error message
- Provisioning
Status Pulumi.Azure Native. Azure Stack HCI. Inputs. Virtual Network Subnet Status Provisioning Status Response - Public IP provisioning status
- Error
Code string - VirtualNetworkSubnet provisioning error code
- Error
Message string - Descriptive error message
- Provisioning
Status VirtualNetwork Subnet Status Provisioning Status Response - Public IP provisioning status
- error
Code String - VirtualNetworkSubnet provisioning error code
- error
Message String - Descriptive error message
- provisioning
Status VirtualNetwork Subnet Status Provisioning Status Response - Public IP provisioning status
- error
Code string - VirtualNetworkSubnet provisioning error code
- error
Message string - Descriptive error message
- provisioning
Status VirtualNetwork Subnet Status Provisioning Status Response - Public IP provisioning status
- error_
code str - VirtualNetworkSubnet provisioning error code
- error_
message str - Descriptive error message
- provisioning_
status VirtualNetwork Subnet Status Provisioning Status Response - Public IP provisioning status
- error
Code String - VirtualNetworkSubnet provisioning error code
- error
Message String - Descriptive error message
- provisioning
Status Property Map - Public IP provisioning status
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.
Azure Native v3.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
