Reachability Analysis Runs - List

Dienst:

Virtual Networks

API-Version:

2024-05-01

Ruft eine Liste der Ausführung der Reichweitenanalyse ab.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces/{workspaceName}/reachabilityAnalysisRuns?api-version=2024-05-01

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Der Name des Netzwerk-Managers.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
workspaceName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Arbeitsbereichsname.
api-version	query	True	string	Client-API-Version.
skip	query		integer (int32)	Optionale Anzahl einträge, die übersprungen werden sollen.
skipToken	query		string	Optionales Skip-Token.
sortKey	query		string	Optionaler Schlüssel, nach dem sortiert werden soll.
sortValue	query		string	Optionaler Sortierwert für die Paginierung.
top	query		integer (int32)	Optionale Anzahl einträge, die angezeigt werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	ReachabilityAnalysisRunListResult	Liste der ReachabilityAnalysisRuns
Other Status Codes	CommonErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ReachabilityAnalysisRunList

Beispielanforderung

HTTP

GET /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisRuns?api-version=2024-05-01

Java

/**
 * Samples for ReachabilityAnalysisRuns List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ReachabilityAnalysisRunList.
     * json
     */
    /**
     * Sample code: ReachabilityAnalysisRunList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void reachabilityAnalysisRunList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getReachabilityAnalysisRuns().list("rg1", "testNetworkManager",
            "testVerifierWorkspace1", null, null, null, null, null, com.azure.core.util.Context.NONE);
    }
}

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

Python

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/2024-05-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

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/ReachabilityAnalysisRunList.json
func ExampleReachabilityAnalysisRunsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewReachabilityAnalysisRunsClient().NewListPager("rg1", "testNetworkManager", "testVerifierWorkspace1", &armnetwork.ReachabilityAnalysisRunsClientListOptions{SkipToken: nil,
		Skip:      nil,
		Top:       nil,
		SortKey:   nil,
		SortValue: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ReachabilityAnalysisRunListResult = armnetwork.ReachabilityAnalysisRunListResult{
		// 	Value: []*armnetwork.ReachabilityAnalysisRun{
		// 		{
		// 			Name: to.Ptr("testReachabilityAnalysisRun1"),
		// 			Type: to.Ptr("Microsoft.Network/networkManagers/verifierWorkspaces/reachabilityAnalysisRuns"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisRuns/testReachabilityAnalysisRun1"),
		// 			SystemData: &armnetwork.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
		// 				CreatedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
		// 				CreatedByType: to.Ptr(armnetwork.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-11T18:52:27.000Z"); return t}()),
		// 				LastModifiedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef5"),
		// 				LastModifiedByType: to.Ptr(armnetwork.CreatedByTypeUser),
		// 			},
		// 			Properties: &armnetwork.ReachabilityAnalysisRunProperties{
		// 				Description: to.Ptr("A sample  reachability analysis intent"),
		// 				IntentContent: &armnetwork.IntentContent{
		// 					DestinationResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest"),
		// 					IPTraffic: &armnetwork.IPTraffic{
		// 						DestinationIPs: []*string{
		// 							to.Ptr("10.4.0.1")},
		// 							DestinationPorts: []*string{
		// 								to.Ptr("0")},
		// 								Protocols: []*armnetwork.NetworkProtocol{
		// 									to.Ptr(armnetwork.NetworkProtocolAny)},
		// 									SourceIPs: []*string{
		// 										to.Ptr("10.4.0.0")},
		// 										SourcePorts: []*string{
		// 											to.Ptr("0")},
		// 										},
		// 										SourceResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc"),
		// 									},
		// 									IntentID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1"),
		// 									ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 								},
		// 						}},
		// 					}
	}
}

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

JavaScript

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

/**
 * 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/2024-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 (let 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

dotnet

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/2024-05-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

Beispiel für eine Antwort

Statuscode:

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=2024-05-01&$skipToken=10"
}

Definitionen

Name	Beschreibung
CommonErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
CommonErrorDetail	Das Fehlerdetails.
CommonErrorResponse	Fehlerantwort
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
IntentContent	Absichtsinformationen.
IPTraffic	IP-Datenverkehrsinformationen.
NetworkProtocol	Datenübertragungsprotokoll.
ProvisioningState	Bereitstellungszustände einer Ressource.
ReachabilityAnalysisRun	Konfigurationsinformationen für die Ausführung der Analyse.
ReachabilityAnalysisRunListResult	Eine Liste der Ausführung der Reichweitenanalyse
ReachabilityAnalysisRunProperties	Represents the Reachability Analysis Run properties.
SystemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

CommonErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

CommonErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	CommonErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	CommonErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

CommonErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	CommonErrorDetail	Das Fehlerobjekt.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

IntentContent

Objekt

Absichtsinformationen.

Name	Typ	Beschreibung
description	string
destinationResourceId	string (arm-id)	Zielressourcen-ID der Absicht.
ipTraffic	IPTraffic	IP-Datenverkehrsinformationen.
sourceResourceId	string (arm-id)	Quellressourcen-ID der Absicht.

IPTraffic

Objekt

IP-Datenverkehrsinformationen.

Name	Typ	Beschreibung
destinationIps	string[]	Liste der Ziel-IP-Adressen des Datenverkehrs.
destinationPorts	string[]	Die Zielports des Datenverkehrs.
protocols	NetworkProtocol[]	Dieses Netzwerkprotokoll gilt für diese Ressource.
sourceIps	string[]	Liste der Quell-IP-Adressen des Datenverkehrs.
sourcePorts	string[]	Die Quellports des Datenverkehrs.

NetworkProtocol

Enumeration

Datenübertragungsprotokoll.

Wert	Beschreibung
Any
ICMP
TCP
UDP

ProvisioningState

Enumeration

Bereitstellungszustände einer Ressource.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ReachabilityAnalysisRun

Objekt

Konfigurationsinformationen für die Ausführung der Analyse.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties	ReachabilityAnalysisRunProperties	Represents the Reachability Analysis Run properties.
systemData	SystemData	Die Systemmetadaten im Zusammenhang mit dieser Ressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ReachabilityAnalysisRunListResult

Objekt

Eine Liste der Ausführung der Reichweitenanalyse

Name	Typ	Beschreibung
nextLink	string	Ruft die URL ab, um die nächste Seite der Ergebnisse abzurufen.
value	ReachabilityAnalysisRun[]	Ruft eine Seite der Reichweitenanalyseausführung ab.

ReachabilityAnalysisRunProperties

Objekt

Represents the Reachability Analysis Run properties.

Name	Typ	Beschreibung
analysisResult	string
description	string
errorMessage	string
intentContent	IntentContent	Absichtsinformationen.
intentId	string	ID der Absichtsressource, für die Analyse ausgeführt werden soll.
provisioningState	ProvisioningState	Bereitstellungszustände einer Ressource.

SystemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.