Virtual Network Gateways - Get Failover All Test Details

Szolgáltatás:

Network Gateway

API-verzió:

2025-05-01

Ez a művelet lekéri a különböző társviszony-létesítési helyek átjáróján végrehajtott feladatátvételi tesztek részleteit

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-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
virtualNetworkGatewayName	path	True	string	A virtuális hálózati átjáró neve.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.
fetchLatest	query	True	boolean	Csak az egyes társviszony-létesítési helyek legújabb tesztjeinek lekérése
type	query	True	string	A feladatátvételi teszt típusa

Válaszok

Name	Típus	Description
200 OK	ExpressRouteFailoverTestDetails[]	Az Azure-művelet sikeresen befejeződött.
202 Accepted		Az erőforrásművelet elfogadott. Fejlécek Location: string Retry-After: integer
Other Status Codes	CloudError	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

VirtualNetworkGatewayGetFailoverAllTestsDetails

Mintakérelem

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

Mintaválasz

Állapotkód:

200

[]

Állapotkód:

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

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
ExpressRouteFailoverCircuitResourceDetails
ExpressRouteFailoverConnectionResourceDetails
ExpressRouteFailoverTestDetails	ExpressRoute feladatátvételi teszt részletei
FailoverConnectionStatus	A kapcsolat aktuális állapota
FailoverTestStatus	A teszt aktuális állapota
FailoverTestType	A feladatátvételi teszt típusa

CloudError

Tárgy

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Felhőhiba törzse.

CloudErrorBody

Tárgy

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hiba további részleteinek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a tulajdonság neve hibás.

ExpressRouteFailoverCircuitResourceDetails

Tárgy

Name	Típus	Description
connectionName	string	Az áramkörhöz társított kapcsolatnév
name	string	Áramkör neve
nrpResourceUri	string (arm-id)	Az áramkör NRP-erőforrás URI-ja

ExpressRouteFailoverConnectionResourceDetails

Tárgy

Name	Típus	Description
lastUpdatedTime	string	A kapcsolat utolsó frissítésének időpontja
name	string	Kapcsolat neve
nrpResourceUri	string (arm-id)	A kapcsolat NRP-erőforrásának URI-ja
status	FailoverConnectionStatus	A kapcsolat aktuális állapota

ExpressRouteFailoverTestDetails

Tárgy

ExpressRoute feladatátvételi teszt részletei

Name	Típus	Description
circuits	ExpressRouteFailoverCircuitResourceDetails[]	A társviszony-létesítési hely összes áramköre
connections	ExpressRouteFailoverConnectionResourceDetails[]	A társviszony-létesítési helyen lévő áramkörökhöz való összes csatlakozás
endTime	string	A teszt befejezésének időpontja
issues	string[]	A teszttel kapcsolatos összes probléma listája
peeringLocation	string	A teszt társviszony-létesítési helye
startTime	string	A teszt megkezdésének időpontja
status	FailoverTestStatus	A teszt aktuális állapota
testGuid	string	A teszthez társított egyedi GUID azonosító
testType	FailoverTestType	A feladatátvételi teszt típusa

FailoverConnectionStatus

Felsorolás

A kapcsolat aktuális állapota

Érték	Description
Connected	Csatlakoztatva
Disconnected	Disconnected

FailoverTestStatus

Felsorolás

A teszt aktuális állapota

Érték	Description
NotStarted	Még nem kezdődött el
Starting	Starting
Running	Futás közben
StartFailed	StartFailed
Stopping	Megállás
Completed	Befejeződött
StopFailed	StopFailed
Invalid	Érvénytelen
Expired	Lejárt

FailoverTestType

Felsorolás

A feladatátvételi teszt típusa

Érték	Description
SingleSiteFailover	SingleSiteFailover
MultiSiteFailover	MultiSiteFailover
All	Összes