Share via


Virtual Hubs - List By Resource Group

Listas todos os VirtualHubs num grupo de recursos.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs?api-version=2023-09-01

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos do VirtualHub.

subscriptionId
path True

string

As credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.

api-version
query True

string

Versão da API de Cliente.

Respostas

Name Tipo Description
200 OK

ListVirtualHubsResult

Pedido com êxito. Devolve os detalhes de todos os VirtualHubs no grupo de recursos.

Other Status Codes

CloudError

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

VirtualHubListByResourceGroup

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs?api-version=2023-09-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "name": "virtualHub1",
      "type": "Microsoft.Network/virtualHubs",
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
        },
        "virtualHubRouteTableV2s": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "name": "rt2a",
            "properties": {
              "provisioningState": "Succeeded",
              "routes": [
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "20.10.0.0/16",
                    "20.20.0.0/16"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                },
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "0.0.0.0/0"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                }
              ],
              "attachedConnections": [
                "All_Vnets"
              ]
            }
          }
        ],
        "addressPrefix": "10.10.1.0/24",
        "sku": "Basic",
        "routingState": "Provisioned",
        "virtualRouterAsn": 65515,
        "virtualRouterIps": [
          "10.10.1.12",
          "10.10.1.13"
        ],
        "allowBranchToBranchTraffic": false,
        "preferredRoutingGateway": "ExpressRoute",
        "hubRoutingPreference": "ExpressRoute",
        "virtualRouterAutoScaleConfiguration": {
          "minCapacity": 2
        }
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "East US",
      "name": "virtualHub2",
      "type": "Microsoft.Network/virtualHubs",
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1"
        },
        "virtualHubRouteTableV2s": [
          {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2",
            "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
            "name": "rt2a",
            "properties": {
              "provisioningState": "Succeeded",
              "routes": [
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "20.10.0.0/16",
                    "20.20.0.0/16"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                },
                {
                  "destinationType": "CIDR",
                  "destinations": [
                    "0.0.0.0/0"
                  ],
                  "nextHopType": "IPAddress",
                  "nextHops": [
                    "10.0.0.68"
                  ]
                }
              ],
              "attachedConnections": [
                "All_Vnets"
              ]
            }
          }
        ],
        "addressPrefix": "210.10.1.0/24",
        "sku": "Basic",
        "routingState": "Provisioned",
        "virtualRouterAsn": 65515,
        "virtualRouterIps": [
          "10.10.1.12",
          "10.10.1.13"
        ],
        "allowBranchToBranchTraffic": false,
        "preferredRoutingGateway": "ExpressRoute",
        "hubRoutingPreference": "ExpressRoute",
        "virtualRouterAutoScaleConfiguration": {
          "minCapacity": 2
        }
      }
    }
  ]
}

Definições

Name Description
CloudError

Uma resposta de erro do serviço.

CloudErrorBody

Uma resposta de erro do serviço.

HubRoutingPreference

Os tipos de gateway de preferência de encaminhamento do hub

ListVirtualHubsResult

Resultado do pedido para listar VirtualHubs. Contém uma lista de VirtualHubs e um URL nextLink para obter o próximo conjunto de resultados.

PreferredRoutingGateway

Os tipos de gateway de encaminhamento preferenciais

ProvisioningState

O estado de aprovisionamento atual.

RoutingState

O estado de encaminhamento atual do VirtualHub.

SubResource

Referência a outra sub-origem.

VirtualHub

Recurso VirtualHub.

VirtualHubRoute

Rota do VirtualHub.

VirtualHubRouteTable

Tabela de rotas do VirtualHub.

VirtualHubRouteTableV2

Recurso VirtualHubRouteTableV2.

VirtualHubRouteV2

Rota VirtualHubRouteTableV2.

VirtualRouterAutoScaleConfiguration

A configuração de dimensionamento automático do VirtualHub Router.

CloudError

Uma resposta de erro do serviço.

Name Tipo Description
error

CloudErrorBody

Corpo do erro da cloud.

CloudErrorBody

Uma resposta de erro do serviço.

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

details

CloudErrorBody[]

Uma lista de detalhes adicionais sobre o erro.

message

string

Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.

target

string

O destino do erro específico. Por exemplo, o nome da propriedade em erro.

HubRoutingPreference

Os tipos de gateway de preferência de encaminhamento do hub

Name Tipo Description
ASPath

string

ExpressRoute

string

VpnGateway

string

ListVirtualHubsResult

Resultado do pedido para listar VirtualHubs. Contém uma lista de VirtualHubs e um URL nextLink para obter o próximo conjunto de resultados.

Name Tipo Description
nextLink

string

URL para obter o próximo conjunto de resultados da lista de operações, se existirem.

value

VirtualHub[]

Lista de VirtualHubs.

PreferredRoutingGateway

Os tipos de gateway de encaminhamento preferenciais

Name Tipo Description
ExpressRoute

string

None

string

VpnGateway

string

ProvisioningState

O estado de aprovisionamento atual.

Name Tipo Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

RoutingState

O estado de encaminhamento atual do VirtualHub.

Name Tipo Description
Failed

string

None

string

Provisioned

string

Provisioning

string

SubResource

Referência a outra sub-origem.

Name Tipo Description
id

string

ID do Recurso.

VirtualHub

Recurso VirtualHub.

Name Tipo Description
etag

string

Uma cadeia só de leitura exclusiva que é alterada sempre que o recurso é atualizado.

id

string

ID do Recurso.

kind

string

Tipo de hub virtual de serviço. Estes são os metadados utilizados para a experiência de portal do Azure para o Route Server.

location

string

Localização do recurso.

name

string

Nome do recurso.

properties.addressPrefix

string

Prefixo de endereço para este VirtualHub.

properties.allowBranchToBranchTraffic

boolean

Sinalizador para controlar o trânsito do hub do VirtualRouter.

properties.azureFirewall

SubResource

O azureFirewall associado a este VirtualHub.

properties.bgpConnections

SubResource[]

Lista de referências ao bgp Connections.

properties.expressRouteGateway

SubResource

O expressRouteGateway associado a este VirtualHub.

properties.hubRoutingPreference

HubRoutingPreference

HubRoutingPreference deste VirtualHub.

properties.ipConfigurations

SubResource[]

Lista de referências a IpConfigurations.

properties.p2SVpnGateway

SubResource

O P2SVpnGateway associado a este VirtualHub.

properties.preferredRoutingGateway

PreferredRoutingGateway

O gateway preferencial para encaminhar o tráfego no local

properties.provisioningState

ProvisioningState

O estado de aprovisionamento do recurso do hub virtual.

properties.routeMaps

SubResource[]

Lista de referências a RouteMaps.

properties.routeTable

VirtualHubRouteTable

A routeTable associada a este hub virtual.

properties.routingState

RoutingState

O estado de encaminhamento.

properties.securityPartnerProvider

SubResource

O securityPartnerProvider associado a este VirtualHub.

properties.securityProviderName

string

O nome do Fornecedor de Segurança.

properties.sku

string

O SKU deste VirtualHub.

properties.virtualHubRouteTableV2s

VirtualHubRouteTableV2[]

Lista de todas as tabelas de rotas do hub virtual v2s associadas a este VirtualHub.

properties.virtualRouterAsn

integer

VirtualRouter ASN.

properties.virtualRouterAutoScaleConfiguration

VirtualRouterAutoScaleConfiguration

A configuração de dimensionamento automático do VirtualHub Router.

properties.virtualRouterIps

string[]

IPs do VirtualRouter.

properties.virtualWan

SubResource

A VirtualWAN à qual pertence o VirtualHub.

properties.vpnGateway

SubResource

O VpnGateway associado a este VirtualHub.

tags

object

Etiquetas de recursos.

type

string

Tipo de recurso.

VirtualHubRoute

Rota do VirtualHub.

Name Tipo Description
addressPrefixes

string[]

Lista de todos os endereçosPrefixos.

nextHopIpAddress

string

Endereço IP nextHop.

VirtualHubRouteTable

Tabela de rotas do VirtualHub.

Name Tipo Description
routes

VirtualHubRoute[]

Lista de todas as rotas.

VirtualHubRouteTableV2

Recurso VirtualHubRouteTableV2.

Name Tipo Description
etag

string

Uma cadeia só de leitura exclusiva que é alterada sempre que o recurso é atualizado.

id

string

ID do Recurso.

name

string

O nome do recurso que é exclusivo num grupo de recursos. Este nome pode ser utilizado para aceder ao recurso.

properties.attachedConnections

string[]

Lista de todas as ligações anexadas a esta tabela de rotas v2.

properties.provisioningState

ProvisioningState

O estado de aprovisionamento do recurso da tabela de rotas do hub virtual v2.

properties.routes

VirtualHubRouteV2[]

Lista de todas as rotas.

VirtualHubRouteV2

Rota VirtualHubRouteTableV2.

Name Tipo Description
destinationType

string

O tipo de destinos.

destinations

string[]

Lista de todos os destinos.

nextHopType

string

O tipo de saltos seguintes.

nextHops

string[]

Endereço IP NextHops.

VirtualRouterAutoScaleConfiguration

A configuração de dimensionamento automático do VirtualHub Router.

Name Tipo Description
minCapacity

integer

O número mínimo de unidades de escala para o Router do VirtualHub.