Reachability Analysis Runs - List

Служба:: Virtual Networks

Версия API:: 2025-05-01

Получает список прогонов анализа доступности.

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

С использованием необязательных параметров:

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}

Параметры URI

Имя	В	Обязательно	Тип	Описание
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Имя сетевого диспетчера.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
workspaceName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Имя ресурса
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
skip	query		integer (int32)	Необязательные записи числовых элементов для пропуска.
skipToken	query		string	Необязательный маркер пропуска.
sortKey	query		string	Необязательный ключ для сортировки.
sortValue	query		string	Необязательное значение сортировки для разбиения на страницы.
top	query		integer (int32)	Необязательные записи числовых элементов для отображения.

Ответы

Имя	Тип	Описание
200 OK	ReachabilityAnalysisRunListResult	Операция Azure успешно завершена.
Other Status Codes	CommonErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Пример ответа

Код состояния:: 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"
      }
    }
  ]
}

Определения

Имя	Описание
CommonErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
CommonErrorDetail	Сведения об ошибке.
CommonErrorResponse	Ответ на ошибку
createdByType	Тип удостоверения, создавшего ресурс.
IntentContent	Сведения о намерении.
IPTraffic	Информация об IP-трафике.
NetworkProtocol	Сетевой протокол.
ProvisioningState	Инициализация состояний ресурса.
ReachabilityAnalysisRun	Сведения о конфигурации для выполнения анализа.
ReachabilityAnalysisRunListResult	Ответ операции ReachabilityAnalysisRun list.
ReachabilityAnalysisRunProperties	Представляет свойства прогона анализа достижимости.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

CommonErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info		Дополнительные сведения.
type	string	Дополнительный тип сведений.

CommonErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	CommonErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	CommonErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

CommonErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	CommonErrorDetail	Объект ошибки.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

IntentContent

Объект

Сведения о намерении.

Имя	Тип	Описание
description	string
destinationResourceId	string (arm-id)	Идентификатор целевого ресурса намерения.
ipTraffic	IPTraffic	Информация об IP-трафике.
sourceResourceId	string (arm-id)	Идентификатор исходного ресурса намерения.

IPTraffic

Объект

Информация об IP-трафике.

Имя	Тип	Описание
destinationIps	string[]	Список IP-адресов назначения трафика.
destinationPorts	string[]	Конечные порты трафика.
protocols	NetworkProtocol[]	Сетевой протокол.
sourceIps	string[]	Список исходных IP-адресов трафика.
sourcePorts	string[]	Исходные порты трафика.

NetworkProtocol

Перечисление

Сетевой протокол.

Значение	Описание
Any	Любое
TCP	Протокол tcp
UDP	UDP
ICMP	ICMP

ProvisioningState

Перечисление

Инициализация состояний ресурса.

Значение	Описание
Failed	Неудача
Succeeded	Succeeded
Canceled	Отменено
Creating	Создавать
Updating	Обновление
Deleting	Удаление