Reachability Analysis Runs - List

Serviço:: Virtual Networks

Versão da API:: 2025-05-01

Obtém a lista de execuções de análise de acessibilidade.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces/{workspaceName}/reachabilityAnalysisRuns?api-version=2025-05-01

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces/{workspaceName}/reachabilityAnalysisRuns?api-version=2025-05-01&skipToken={skipToken}&skip={skip}&top={top}&sortKey={sortKey}&sortValue={sortValue}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	O nome do gerenciador de rede.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
workspaceName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	O nome do recurso
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
skip	query		integer (int32)	Entradas num opcionais a serem ignoradas.
skipToken	query		string	Token de ignorar opcional.
sortKey	query		string	Chave opcional pela qual classificar.
sortValue	query		string	Valor de classificação opcional para paginação.
top	query		integer (int32)	Entradas num opcionais a serem exibidas.

Respostas

Nome	Tipo	Description
200 OK	ReachabilityAnalysisRunListResult	A operação do Azure foi concluída com êxito.
Other Status Codes	CommonErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ReachabilityAnalysisRunList

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisRuns?api-version=2025-05-01

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets list of Reachability Analysis Runs.
 *
 * @summary Gets list of Reachability Analysis Runs.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/Network/stable/2025-05-01/examples/ReachabilityAnalysisRunList.json
 */
async function reachabilityAnalysisRunList() {
  const subscriptionId =
    process.env["NETWORK_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const networkManagerName = "testNetworkManager";
  const workspaceName = "testVerifierWorkspace1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.reachabilityAnalysisRuns.list(
    resourceGroupName,
    networkManagerName,
    workspaceName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 200

{
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisRuns?api-version=2025-05-01&$skipToken=10",
  "value": [
    {
      "name": "testReachabilityAnalysisRun1",
      "type": "Microsoft.Network/networkManagers/verifierWorkspaces/reachabilityAnalysisRuns",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisRuns/testReachabilityAnalysisRun1",
      "properties": {
        "description": "A sample  reachability analysis intent",
        "intentContent": {
          "destinationResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest",
          "ipTraffic": {
            "destinationIps": [
              "10.4.0.1"
            ],
            "destinationPorts": [
              "0"
            ],
            "protocols": [
              "Any"
            ],
            "sourceIps": [
              "10.4.0.0"
            ],
            "sourcePorts": [
              "0"
            ]
          },
          "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc"
        },
        "intentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1",
        "provisioningState": "Succeeded"
      },
      "systemData": {
        "createdAt": "2021-01-11T18:52:27Z",
        "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
        "createdByType": "User",
        "lastModifiedAt": "2021-01-11T18:52:27Z",
        "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5",
        "lastModifiedByType": "User"
      }
    }
  ]
}

Definições

Nome	Description
CommonErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
CommonErrorDetail	O detalhe do erro.
CommonErrorResponse	Resposta de erro
createdByType	O tipo de identidade que criou o recurso.
IntentContent	Informações de intenção.
IPTraffic	Informações de tráfego IP.
NetworkProtocol	Protocolo de rede.
ProvisioningState	Provisionando estados de um recurso.
ReachabilityAnalysisRun	Informações de configuração para execução de análise.
ReachabilityAnalysisRunListResult	A resposta de uma operação de lista ReachabilityAnalysisRun.
ReachabilityAnalysisRunProperties	Representa as propriedades da Execução de Análise de Acessibilidade.
systemData	Metadados relativos à criação e última modificação do recurso.

CommonErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

CommonErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	CommonErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CommonErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

CommonErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	CommonErrorDetail	O objeto de erro.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

IntentContent

Objeto

Informações de intenção.

Nome	Tipo	Description
description	string
destinationResourceId	string (arm-id)	ID do recurso de destino da intenção.
ipTraffic	IPTraffic	Informações de tráfego IP.
sourceResourceId	string (arm-id)	ID do recurso de origem da intenção.

IPTraffic

Objeto

Informações de tráfego IP.

Nome	Tipo	Description
destinationIps	string[]	Lista de endereços IP de destino do tráfego..
destinationPorts	string[]	As portas de destino do tráfego.
protocols	NetworkProtocol[]	Protocolo de rede.
sourceIps	string[]	Lista de endereços IP de origem do tráfego..
sourcePorts	string[]	As portas de origem do tráfego.

NetworkProtocol

Enumeração

Protocolo de rede.

Valor	Description
Any	Qualquer
TCP	TCP
UDP	UDP
ICMP	ICMP

ProvisioningState

Enumeração

Provisionando estados de um recurso.

Valor	Description
Failed	Falha
Succeeded	Succeeded
Canceled	Cancelado
Creating	Criando
Updating	Atualização
Deleting	Excluir