Reachability Analysis Runs - List

Service:

Virtual Networks

API-versie:

2024-05-01

Hiermee haalt u een lijst met uitvoeringen van de bereikbaarheidsanalyse op.

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

Met optionele parameters:

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-parameters

Name	In	Vereist	Type	Description
networkManagerName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	De naam van de netwerkbeheerder.
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	De abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
workspaceName	path	True	string pattern: ^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$	Werkruimtenaam.
api-version	query	True	string	Client-API-versie.
skip	query		integer (int32)	Optionele getalitems om over te slaan.
skipToken	query		string	Optioneel skip-token.
sortKey	query		string	Optionele sleutel waarop u wilt sorteren.
sortValue	query		string	Optionele sorteerwaarde voor paginering.
top	query		integer (int32)	Optionele getalitems die moeten worden weergegeven.

Antwoorden

Name	Type	Description
200 OK	ReachabilityAnalysisRunListResult	Lijst met ReachabilityAnalysisRuns
Other Status Codes	CommonErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ReachabilityAnalysisRunList

Voorbeeldaanvraag

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

Voorbeeldrespons

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"
}

Definities

Name	Description
CommonErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
CommonErrorDetail	De foutdetails.
CommonErrorResponse	Foutreactie
createdByType	Het type identiteit waarmee de resource is gemaakt.
IntentContent	Intentie-informatie.
IPTraffic	IP-verkeersinformatie.
NetworkProtocol	Network Protocol.
ProvisioningState	Inrichtingsstatussen van een resource.
ReachabilityAnalysisRun	Configuratie-informatie voor analyseuitvoering.
ReachabilityAnalysisRunListResult	Een lijst met de uitvoer van een bereikanalyse
ReachabilityAnalysisRunProperties	Vertegenwoordigt de eigenschappen van de uitvoer van de bereikbaarheidsanalyse.
SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

CommonErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

CommonErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	CommonErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	CommonErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

CommonErrorResponse

Object

Foutreactie

Name	Type	Description
error	CommonErrorDetail	Het foutobject.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

IntentContent

Object

Intentie-informatie.

Name	Type	Description
description	string
destinationResourceId	string (arm-id)	Doelresource-id van de intentie.
ipTraffic	IPTraffic	IP-verkeersinformatie.
sourceResourceId	string (arm-id)	Bronresource-id van de intentie.

IPTraffic

Object

IP-verkeersinformatie.

Name	Type	Description
destinationIps	string[]	Lijst met doel-IP-adressen van het verkeer..
destinationPorts	string[]	De doelpoorten van het verkeer.
protocols	NetworkProtocol[]	Netwerkprotocol waarop deze resource van toepassing is.
sourceIps	string[]	Lijst met bron-IP-adressen van het verkeer..
sourcePorts	string[]	De bronpoorten van het verkeer.

NetworkProtocol

Inventarisatie

Network Protocol.

Waarde	Description
Any
ICMP
TCP
UDP

ProvisioningState

Inventarisatie

Inrichtingsstatussen van een resource.

Waarde	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ReachabilityAnalysisRun

Object

Configuratie-informatie voor analyseuitvoering.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties	ReachabilityAnalysisRunProperties	Vertegenwoordigt de eigenschappen van de uitvoer van de bereikbaarheidsanalyse.
systemData	SystemData	De systeemmetagegevens die betrekking hebben op deze resource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ReachabilityAnalysisRunListResult

Object

Een lijst met de uitvoer van een bereikanalyse

Name	Type	Description
nextLink	string	Haalt de URL op om de volgende pagina met resultaten op te halen.
value	ReachabilityAnalysisRun[]	Hiermee haalt u een pagina op van de uitvoeringen van de bereikbaarheidsanalyse.

ReachabilityAnalysisRunProperties

Object

Vertegenwoordigt de eigenschappen van de uitvoer van de bereikbaarheidsanalyse.

Name	Type	Description
analysisResult	string
description	string
errorMessage	string
intentContent	IntentContent	Intentie-informatie.
intentId	string	Id van de intentieresource waarop analyse moet worden uitgevoerd.
provisioningState	ProvisioningState	Inrichtingsstatussen van een resource.

SystemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	Het type identiteit dat de resource voor het laatst heeft gewijzigd.
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.