Virtual Network Gateways - Get Failover All Test Details

Dienst:

Network Gateway

API-Version:

2024-05-01

Dieser Vorgang ruft die Details aller Failovertests ab, die auf dem Gateway für verschiedene Peeringstandorte ausgeführt wurden.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverAllTestsDetails?type={type}&fetchLatest={fetchLatest}&api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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.
virtualNetworkGatewayName	path	True	string	Der Name des virtuellen Netzwerkgateways.
api-version	query	True	string	Client-API-Version.
fetchLatest	query	True	boolean	Abrufen der neuesten Tests für jeden Peeringspeicherort
type	query	True	string	Der Typ des Failovertests

Antworten

Name	Typ	Beschreibung
200 OK	ExpressRouteFailoverTestDetails[]	Failovertestdetails für das Gateway
202 Accepted		Angenommen und der Vorgang wird asynchron abgeschlossen. Header location: string
Other Status Codes	CloudError	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

VirtualNetworkGatewayGetFailoverAllTestsDetails

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/getFailoverAllTestsDetails?type=SingleSiteFailover&fetchLatest=true&api-version=2024-05-01

Java

/**
 * Samples for VirtualNetworkGateways GetFailoverAllTestDetails.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * VirtualNetworkGatewayGetFailoverAllTestsDetails.json
     */
    /**
     * Sample code: VirtualNetworkGatewayGetFailoverAllTestsDetails.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualNetworkGatewayGetFailoverAllTestsDetails(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().getFailoverAllTestDetails("rg1", "ergw",
            "SingleSiteFailover", true, 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 virtual_network_gateway_get_failover_all_tests_details.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="subid",
    )

    response = client.virtual_network_gateways.begin_get_failover_all_test_details(
        resource_group_name="rg1",
        virtual_network_gateway_name="ergw",
        type="SingleSiteFailover",
        fetch_latest="true",
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualNetworkGatewayGetFailoverAllTestsDetails.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/VirtualNetworkGatewayGetFailoverAllTestsDetails.json
func ExampleVirtualNetworkGatewaysClient_BeginGetFailoverAllTestDetails() {
	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)
	}
	poller, err := clientFactory.NewVirtualNetworkGatewaysClient().BeginGetFailoverAllTestDetails(ctx, "rg1", "ergw", "SingleSiteFailover", true, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExpressRouteFailoverTestDetailsArray = []*armnetwork.ExpressRouteFailoverTestDetails{
	// }
}

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 This operation retrieves the details of all the failover tests performed on the gateway for different peering locations
 *
 * @summary This operation retrieves the details of all the failover tests performed on the gateway for different peering locations
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualNetworkGatewayGetFailoverAllTestsDetails.json
 */
async function virtualNetworkGatewayGetFailoverAllTestsDetails() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "ergw";
  const typeParam = "SingleSiteFailover";
  const fetchLatest = true;
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.beginGetFailoverAllTestDetailsAndWait(
    resourceGroupName,
    virtualNetworkGatewayName,
    typeParam,
    fetchLatest,
  );
  console.log(result);
}

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.Collections.Generic;
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/VirtualNetworkGatewayGetFailoverAllTestsDetails.json
// this example is just showing the usage of "VirtualNetworkGateways_GetFailoverAllTestDetails" 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 VirtualNetworkGatewayResource created on azure
// for more information of creating VirtualNetworkGatewayResource, please refer to the document of VirtualNetworkGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualNetworkGatewayName = "ergw";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);

// invoke the operation
string type = "SingleSiteFailover";
bool fetchLatest = true;
ArmOperation<IList<ExpressRouteFailoverTestDetails>> lro = await virtualNetworkGateway.GetFailoverAllTestDetailsAsync(WaitUntil.Completed, type, fetchLatest);
IList<ExpressRouteFailoverTestDetails> result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-05-01

Statuscode:

200

[]

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Diensts.
ExpressRouteFailoverCircuitResourceDetails
ExpressRouteFailoverConnectionResourceDetails
ExpressRouteFailoverTestDetails	ExpressRoute-Failovertestdetails
FailoverConnectionStatus	Der aktuelle Status der Verbindung
FailoverTestStatus	Der aktuelle Status des Tests
FailoverTestType	Der Typ des Failovertests

CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloudfehlertext.

CloudErrorBody

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

ExpressRouteFailoverCircuitResourceDetails

Objekt

Name	Typ	Beschreibung
connectionName	string	Dem Schaltkreis zugeordneter Verbindungsname
name	string	Schaltkreisname
nrpResourceUri	string (arm-id)	NRP-Ressourcen-URI des Schaltkreises

ExpressRouteFailoverConnectionResourceDetails

Objekt

Name	Typ	Beschreibung
lastUpdatedTime	string	Zeitpunkt der letzten Aktualisierung der Verbindung
name	string	Verbindungsname
nrpResourceUri	string (arm-id)	NRP-Ressourcen-URI der Verbindung
status	FailoverConnectionStatus	Der aktuelle Status der Verbindung

ExpressRouteFailoverTestDetails

Objekt

ExpressRoute-Failovertestdetails

Name	Typ	Beschreibung
circuits	ExpressRouteFailoverCircuitResourceDetails[]	Alle Schaltkreise an der Peeringposition
connections	ExpressRouteFailoverConnectionResourceDetails[]	Alle Verbindungen mit den Schaltkreisen an der Peeringposition
endTime	string	Zeitpunkt, zu dem der Test abgeschlossen wurde
issues	string[]	Eine Liste aller Probleme mit dem Test
peeringLocation	string	Peeringstandort des Tests
startTime	string	Zeitpunkt, zu dem der Test gestartet wurde
status	FailoverTestStatus	Der aktuelle Status des Tests
testGuid	string	Die eindeutige GUID, die dem Test zugeordnet ist
testType	FailoverTestType	Der Typ des Failovertests

FailoverConnectionStatus

Enumeration

Der aktuelle Status der Verbindung

Wert	Beschreibung
Connected
Disconnected

FailoverTestStatus

Enumeration

Der aktuelle Status des Tests

Wert	Beschreibung
Completed
Expired
Invalid
NotStarted
Running
StartFailed
Starting
StopFailed
Stopping

FailoverTestType

Enumeration

Der Typ des Failovertests

Wert	Beschreibung
All
MultiSiteFailover
SingleSiteFailover