Virtual Network Gateways - Get Failover All Test Details

Layanan:

Network Gateway

Versi API:

2025-05-01

Operasi ini mengambil detail semua pengujian failover yang dilakukan pada gateway untuk lokasi peering yang berbeda

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
virtualNetworkGatewayName	path	True	string	Nama gateway jaringan virtual.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.
fetchLatest	query	True	boolean	Ambil hanya tes terbaru untuk setiap lokasi peering
type	query	True	string	Jenis pengujian failover

Respons

Nama	Jenis	Deskripsi
200 OK	ExpressRouteFailoverTestDetails[]	Operasi Azure berhasil diselesaikan.
202 Accepted		Operasi sumber daya diterima. Header Location: string Retry-After: integer
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

VirtualNetworkGatewayGetFailoverAllTestsDetails

Permintaan sampel

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

Respon sampel

Kode status:

200

[]

Kode status:

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

Definisi

Nama	Deskripsi
CloudError	Respons kesalahan dari layanan.
CloudErrorBody	Respons kesalahan dari layanan.
ExpressRouteFailoverCircuitResourceDetails
ExpressRouteFailoverConnectionResourceDetails
ExpressRouteFailoverTestDetails	Detail pengujian failover ExpressRoute
FailoverConnectionStatus	Status koneksi saat ini
FailoverTestStatus	Status pengujian saat ini
FailoverTestType	Jenis pengujian failover

CloudError

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Badan kesalahan cloud.

CloudErrorBody

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

ExpressRouteFailoverCircuitResourceDetails

Objek

Nama	Jenis	Deskripsi
connectionName	string	Nama koneksi yang terkait dengan sirkuit
name	string	Nama Sirkuit
nrpResourceUri	string (arm-id)	URI Sumber Daya NRP dari sirkuit

ExpressRouteFailoverConnectionResourceDetails

Objek

Nama	Jenis	Deskripsi
lastUpdatedTime	string	Waktu saat koneksi terakhir diperbarui
name	string	Nama Koneksi
nrpResourceUri	string (arm-id)	URI Sumber Daya NRP koneksi
status	FailoverConnectionStatus	Status koneksi saat ini

ExpressRouteFailoverTestDetails

Objek

Detail pengujian failover ExpressRoute

Nama	Jenis	Deskripsi
circuits	ExpressRouteFailoverCircuitResourceDetails[]	Semua sirkuit di lokasi peering
connections	ExpressRouteFailoverConnectionResourceDetails[]	Semua koneksi ke sirkuit di lokasi peering
endTime	string	Waktu tes selesai
issues	string[]	Daftar semua masalah dengan pengujian
peeringLocation	string	Lokasi peering pengujian
startTime	string	Waktu saat tes dimulai
status	FailoverTestStatus	Status pengujian saat ini
testGuid	string	GUID unik yang terkait dengan pengujian
testType	FailoverTestType	Jenis pengujian failover

FailoverConnectionStatus

Enumerasi

Status koneksi saat ini

Nilai	Deskripsi
Connected	Tersambung
Disconnected	Terputus

FailoverTestStatus

Enumerasi

Status pengujian saat ini

Nilai	Deskripsi
NotStarted	Belum Mulai
Starting	Memulai
Running	Running
StartFailed	StartFailed
Stopping	Menghentikan
Completed	Selesai
StopFailed	BerhentiGagal
Invalid	Tidak valid
Expired	Kedaluwarsa

FailoverTestType

Enumerasi

Jenis pengujian failover

Nilai	Deskripsi
SingleSiteFailover	SingleSiteFailover
MultiSiteFailover	MultiSiteFailover
All	All