Reachability Analysis Runs - List

サービス:: Virtual Networks

API バージョン:: 2025-03-01

到達可能性分析実行のリストを取得します。

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

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces/{workspaceName}/reachabilityAnalysisRuns?api-version=2025-03-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	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
workspaceName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	ワークスペース名。
api-version	query	True	string	クライアント API のバージョン。
skip	query		integer (int32)	省略可能なスキップするエントリ数。
skipToken	query		string	省略可能なスキップトークン。
sortKey	query		string	並べ替えに使用する省略可能なキー。
sortValue	query		string	改ページ位置のオプションの並べ替え値。
top	query		integer (int32)	表示するオプションの num エントリ。

応答

名前	型	説明
200 OK	ReachabilityAnalysisRunListResult	ReachabilityAnalysisRuns のリスト
Other Status Codes	CommonErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 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-03-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python reachability_analysis_run_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.reachability_analysis_runs.list(
        resource_group_name="rg1",
        network_manager_name="testNetworkManager",
        workspace_name="testVerifierWorkspace1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunList.json
if __name__ == "__main__":
    main()

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

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/stable/2025-03-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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunList.json
// this example is just showing the usage of "ReachabilityAnalysisRuns_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this NetworkVerifierWorkspaceResource created on azure
// for more information of creating NetworkVerifierWorkspaceResource, please refer to the document of NetworkVerifierWorkspaceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string networkManagerName = "testNetworkManager";
string workspaceName = "testVerifierWorkspace1";
ResourceIdentifier networkVerifierWorkspaceResourceId = NetworkVerifierWorkspaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, networkManagerName, workspaceName);
NetworkVerifierWorkspaceResource networkVerifierWorkspace = client.GetNetworkVerifierWorkspaceResource(networkVerifierWorkspaceResourceId);

// get the collection of this ReachabilityAnalysisRunResource
ReachabilityAnalysisRunCollection collection = networkVerifierWorkspace.GetReachabilityAnalysisRuns();

// invoke the operation and iterate over the result
await foreach (ReachabilityAnalysisRunResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ReachabilityAnalysisRunData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

応答のサンプル

状態コード:: 200

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

定義

名前	説明
CommonErrorAdditionalInfo	リソース管理エラーの追加情報。
CommonErrorDetail	エラーの詳細。
CommonErrorResponse	エラー応答
createdByType	リソースを作成した ID の種類。
IntentContent	意図情報。
IPTraffic	IP トラフィック情報。
NetworkProtocol	ネットワークプロトコル。
ProvisioningState	リソースのプロビジョニング状態。
ReachabilityAnalysisRun	分析実行の構成情報。
ReachabilityAnalysisRunListResult	到達可能性分析の実行の一覧
ReachabilityAnalysisRunProperties	到達可能性分析の実行プロパティを表します。
SystemData	リソースの作成と最後の変更に関連するメタデータ。

CommonErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報タイプ。

CommonErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	CommonErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	CommonErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラー・ターゲット。

CommonErrorResponse

Object

エラー応答

名前	型	説明
error	CommonErrorDetail	エラーオブジェクト。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

IntentContent

Object

意図情報。

名前	型	説明
description	string
destinationResourceId	string (arm-id)	意図の宛先リソース ID。
ipTraffic	IPTraffic	IP トラフィック情報。
sourceResourceId	string (arm-id)	インテントのソースリソースID。

IPTraffic

Object

IP トラフィック情報。

名前	型	説明
destinationIps	string[]	トラフィックの宛先 IP アドレスの一覧。.
destinationPorts	string[]	トラフィックの宛先ポート。
protocols	NetworkProtocol[]	このリソースが適用されるネットワークプロトコル。
sourceIps	string[]	トラフィックの送信元 IP アドレスの一覧。.
sourcePorts	string[]	トラフィックのソースポート。

NetworkProtocol

列挙

ネットワークプロトコル。

値	説明
Any
TCP
UDP
ICMP

ProvisioningState

列挙

リソースのプロビジョニング状態。

値	説明
Failed
Succeeded
Canceled
Creating
Updating
Deleting