Virtual Network Gateways - Get Failover All Test Details

Tjänst:

Network Gateway

API-version:

2025-05-01

Den här åtgärden hämtar information om alla redundanstester som utförs på gatewayen för olika peeringplatser

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
virtualNetworkGatewayName	path	True	string	Namnet på den virtuella nätverksgatewayen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
fetchLatest	query	True	boolean	Hämta endast de senaste testerna för varje peeringplats
type	query	True	string	Typen av redundanstest

Svar

Name	Typ	Description
200 OK	ExpressRouteFailoverTestDetails[]	Azure-operationen slutfördes framgångsrikt.
202 Accepted		Resursåtgärden har godkänts. Sidhuvuden Location: string Retry-After: integer
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

VirtualNetworkGatewayGetFailoverAllTestsDetails

Exempelbegäran

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

Exempelsvar

Statuskod:

200

[]

Statuskod:

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

Definitioner

Name	Description
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
ExpressRouteFailoverCircuitResourceDetails
ExpressRouteFailoverConnectionResourceDetails
ExpressRouteFailoverTestDetails	Information om ExpressRoute-redundanstest
FailoverConnectionStatus	Anslutningens aktuella status
FailoverTestStatus	Testets aktuella status
FailoverTestType	Typen av redundanstest

CloudError

Objekt

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Brödtext för molnfel.

CloudErrorBody

Objekt

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

ExpressRouteFailoverCircuitResourceDetails

Objekt

Name	Typ	Description
connectionName	string	Anslutningsnamn som är associerat med kretsen
name	string	Kretsens namn
nrpResourceUri	string (arm-id)	NRP-resurs-URI för kretsen

ExpressRouteFailoverConnectionResourceDetails

Objekt

Name	Typ	Description
lastUpdatedTime	string	Tid då anslutningen senast uppdaterades
name	string	Anslutningsnamn
nrpResourceUri	string (arm-id)	NRP-resurs-URI för anslutningen
status	FailoverConnectionStatus	Anslutningens aktuella status

ExpressRouteFailoverTestDetails

Objekt

Information om ExpressRoute-redundanstest

Name	Typ	Description
circuits	ExpressRouteFailoverCircuitResourceDetails[]	Alla kretsar på peeringplatsen
connections	ExpressRouteFailoverConnectionResourceDetails[]	Alla anslutningar till kretsarna på peeringplatsen
endTime	string	Tidpunkt då testet slutfördes
issues	string[]	En lista över alla problem med testet
peeringLocation	string	Peeringplats för testet
startTime	string	Tidpunkt då testet startades
status	FailoverTestStatus	Testets aktuella status
testGuid	string	Det unika GUID som är associerat med testet
testType	FailoverTestType	Typen av redundanstest

FailoverConnectionStatus

Uppräkning

Anslutningens aktuella status

Värde	Description
Connected	Connected
Disconnected	Frånkopplad

FailoverTestStatus

Uppräkning

Testets aktuella status

Värde	Description
NotStarted	Ej påbörjad
Starting	Startar
Running	Springa
StartFailed	StartFailed
Stopping	Stoppa
Completed	Har slutförts
StopFailed	StopFailed
Invalid	Ogiltig
Expired	Expired

FailoverTestType

Uppräkning

Typen av redundanstest

Värde	Description
SingleSiteFailover	SingleSiteFailover
MultiSiteFailover	MultiSiteFailover
All	Allt