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)	目标订阅的 ID。 该值必须是 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

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ReachabilityAnalysisRunList

示例请求

HTTP

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

JavaScript

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 列表操作的响应。
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)	意向的目标资源 ID。
ipTraffic	IPTraffic	IP 流量信息。
sourceResourceId	string (arm-id)	意向的源资源 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	Failed
Succeeded	成功
Canceled	已取消
Creating	创建
Updating	更新
Deleting	正在删除

ReachabilityAnalysisRun

对象

用于分析运行的配置信息。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	ReachabilityAnalysisRunProperties	表示“可达性分析运行”属性。
systemData	systemData	与此资源相关的系统元数据。
type	string	资源类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ReachabilityAnalysisRunListResult

对象

ReachabilityAnalysisRun 列表操作的响应。

名称	类型	说明
nextLink	string (uri)	指向下一页项的链接
value	ReachabilityAnalysisRun[]	本页的ReachabilityAnalysisRun项目

ReachabilityAnalysisRunProperties

对象

表示“可达性分析运行”属性。

名称	类型	说明
analysisResult	string
description	string
errorMessage	string
intentContent	IntentContent	意向信息。
intentId	string	要运行分析的意向资源的 ID。
provisioningState	ProvisioningState	资源的预配状态。

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳 （UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。