Share via


virtual Networks - List By Resource Group

Lists the virtual networks in the specified resource group

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridContainerService/virtualNetworks?api-version=2024-01-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string (uuid)

The ID of the target subscription. The value must be an UUID.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

virtualNetworksListResult

Lists the virtual networks in the specified resource group

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ListVirtualNetworkByResourceGroup

Sample request

GET https://management.azure.com/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.HybridContainerService/virtualNetworks?api-version=2024-01-01

Sample response

{
  "value": [
    {
      "location": "westus",
      "id": "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourceGroups/test-arcappliance-resgrp/providers/Microsoft.HybridContainerService/virtualNetworks/test-vnet-static",
      "name": "test-vnet-static",
      "type": "microsoft.hybridcontainerservice/virtualnetworks",
      "extendedLocation": {
        "type": "CustomLocation",
        "name": "/subscriptions/a3e42606-29b1-4d7d-b1d9-9ff6b9d3c71b/resourcegroups/test-arcappliance-resgrp/providers/microsoft.extendedlocation/customlocations/testcustomlocation"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "infraVnetProfile": {
          "hci": {
            "mocGroup": "target-group",
            "mocLocation": "MocLocation",
            "mocVnetName": "vnet1"
          }
        },
        "vipPool": [
          {
            "startIP": "192.168.0.10",
            "endIP": "192.168.0.50"
          }
        ],
        "vmipPool": [
          {
            "startIP": "192.168.0.110",
            "endIP": "192.168.0.130"
          }
        ],
        "dnsServers": [
          "192.168.0.1"
        ],
        "gateway": "192.168.0.1",
        "ipAddressPrefix": "192.168.0.0/16",
        "vlanID": 10
      }
    }
  ]
}

Definitions

Name Description
createdByType

The type of identity that created the resource.

Error

The error if any from the operation.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ExtendedLocation

Extended location pointing to the underlying infrastructure

ExtendedLocationTypes

The extended location type. Allowed value: 'CustomLocation'

Hci

Infrastructure network profile for HCI platform

InfraVnetProfile
OperationStatus

The detailed status of the long running operation.

provisioningState
Status

Status of the virtual network resource

systemData

Metadata pertaining to creation and last modification of the resource.

VipPool

Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer

virtualNetwork

The Virtual Network resource definition.

virtualNetworksListResult

A list of virtual network resources.

VmipPool

Range of IP Addresses for Kubernetes node VMs

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

Error

The error if any from the operation.

Name Type Description
code

string

The error code from the operation.

message

string

The error message from the operation.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

ExtendedLocation

Extended location pointing to the underlying infrastructure

Name Type Description
name

string

ARM Id of the extended location.

type

ExtendedLocationTypes

The extended location type. Allowed value: 'CustomLocation'

ExtendedLocationTypes

The extended location type. Allowed value: 'CustomLocation'

Value Description
CustomLocation

Hci

Infrastructure network profile for HCI platform

Name Type Description
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)

InfraVnetProfile

Name Type Description
hci

Hci

Infrastructure network profile for HCI platform

OperationStatus

The detailed status of the long running operation.

Name Type Description
error

Error

The error if any from the operation.

operationId

string

The identifier of the operation.

status

string

The status of the operation.

provisioningState

Value Description
Succeeded
Failed
Canceled
Pending
Creating
Deleting
Updating
Accepted

Status

Status of the virtual network resource

Name Type Description
operationStatus

OperationStatus

The detailed status of the long running operation.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

VipPool

Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer

Name Type Description
endIP

string

Ending IP address for the IP Pool

startIP

string

Starting IP address for the IP Pool

virtualNetwork

The Virtual Network resource definition.

Name Type Description
extendedLocation

ExtendedLocation

Extended location pointing to the underlying infrastructure

id

string (arm-id)

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.dnsServers

string[]

List of DNS server IP Addresses associated with the network

properties.gateway

string

IP Address of the Gateway associated with the network

properties.infraVnetProfile

InfraVnetProfile

properties.ipAddressPrefix

string

IP Address Prefix of the network

properties.provisioningState

provisioningState

properties.status

Status

Status of the virtual network resource

properties.vipPool

VipPool[]

Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer

properties.vlanID

integer (int32)

VLAN Id used by the network

properties.vmipPool

VmipPool[]

Range of IP Addresses for Kubernetes node VMs

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

virtualNetworksListResult

A list of virtual network resources.

Name Type Description
nextLink

string

value

virtualNetwork[]

The Virtual Network resource definition.

VmipPool

Range of IP Addresses for Kubernetes node VMs

Name Type Description
endIP

string

Ending IP address for the IP Pool

startIP

string

Starting IP address for the IP Pool