Virtual Network Gateways - Get Failover All Test Details

Usługa:

Network Gateway

Wersja interfejsu API:

2025-05-01

Ta operacja pobiera szczegóły wszystkich testów trybu failover wykonywanych w bramie dla różnych lokalizacji komunikacji równorzędnej

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
virtualNetworkGatewayName	path	True	string	Nazwa bramy sieci wirtualnej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
fetchLatest	query	True	boolean	Pobieranie tylko najnowszych testów dla każdej lokalizacji komunikacji równorzędnej
type	query	True	string	Typ testu trybu failover

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ExpressRouteFailoverTestDetails[]	Operacja platformy Azure została zakończona pomyślnie.
202 Accepted		Zaakceptowano operację zasobu. Nagłówki Location: string Retry-After: integer
Other Status Codes	CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

VirtualNetworkGatewayGetFailoverAllTestsDetails

Przykładowe żądanie

HTTP

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

JavaScript

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

/**
 * 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/Network/stable/2025-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

Przykładowa odpowiedź

Kod stanu:

200

[]

Kod stanu:

202

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

Definicje

Nazwa	Opis
CloudError	Odpowiedź o błędzie z usługi.
CloudErrorBody	Odpowiedź o błędzie z usługi.
ExpressRouteFailoverCircuitResourceDetails
ExpressRouteFailoverConnectionResourceDetails
ExpressRouteFailoverTestDetails	Szczegóły testu trybu failover usługi ExpressRoute
FailoverConnectionStatus	Bieżący stan połączenia
FailoverTestStatus	Aktualny status testu
FailoverTestType	Typ testu trybu failover

CloudError

Objekt

Odpowiedź o błędzie z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Ciało błędu chmury.

CloudErrorBody

Objekt

Odpowiedź o błędzie z usługi.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

ExpressRouteFailoverCircuitResourceDetails

Objekt

Nazwa	Typ	Opis
connectionName	string	Nazwa połączenia skojarzona z obwodem
name	string	Nazwa obwodu
nrpResourceUri	string (arm-id)	Identyfikator URI zasobu NRP obwodu

ExpressRouteFailoverConnectionResourceDetails

Objekt

Nazwa	Typ	Opis
lastUpdatedTime	string	Czas ostatniej aktualizacji połączenia
name	string	Nazwa połączenia
nrpResourceUri	string (arm-id)	Identyfikator URI zasobu NRP połączenia
status	FailoverConnectionStatus	Bieżący stan połączenia

ExpressRouteFailoverTestDetails

Objekt

Szczegóły testu trybu failover usługi ExpressRoute

Nazwa	Typ	Opis
circuits	ExpressRouteFailoverCircuitResourceDetails[]	Wszystkie obwody w lokalizacji komunikacji równorzędnej
connections	ExpressRouteFailoverConnectionResourceDetails[]	Wszystkie połączenia z obwodami w lokalizacji komunikacji równorzędnej
endTime	string	Godzina zakończenia testu
issues	string[]	Lista wszystkich problemów z testem
peeringLocation	string	Lokalizacja komunikacji równorzędnej testu
startTime	string	Godzina rozpoczęcia badania
status	FailoverTestStatus	Aktualny status testu
testGuid	string	Unikatowy identyfikator GUID skojarzony z testem
testType	FailoverTestType	Typ testu trybu failover

FailoverConnectionStatus

Wyliczenie

Bieżący stan połączenia

Wartość	Opis
Connected	Połączono
Disconnected	Disconnected

FailoverTestStatus

Wyliczenie

Aktualny status testu

Wartość	Opis
NotStarted	Nierozpoczęty
Starting	Rozpoczęcie
Running	Bieganie
StartFailed	StartFailed
Stopping	Zatrzymanie
Completed	Zakończono
StopFailed	StopFailed
Invalid	Nieprawidłowy
Expired	Wygasła

FailoverTestType

Wyliczenie

Typ testu trybu failover

Wartość	Opis
SingleSiteFailover	SingleSiteFailover
MultiSiteFailover	MultiSiteFailover
All	Wszystko