Virtual Network Gateways - Get Failover All Test Details

Hizmet:

Network Gateway

API Sürümü:

2025-05-01

Bu işlem, farklı eşleme konumları için ağ geçidinde gerçekleştirilen tüm yük devretme testlerinin ayrıntılarını alır

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. İsim büyük/küçük harfe duyarsızdır.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
virtualNetworkGatewayName	path	True	string	Sanal ağ geçidinin adı.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
fetchLatest	query	True	boolean	Her eşleme konumu için yalnızca en son testleri getirme
type	query	True	string	Yük devretme testinin türü

Yanıtlar

Name	Tür	Description
200 OK	ExpressRouteFailoverTestDetails[]	Azure işlemi başarıyla tamamlandı.
202 Accepted		Kaynak işlemi kabul edildi. Üst Bilgiler Location: string Retry-After: integer
Other Status Codes	CloudError	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

VirtualNetworkGatewayGetFailoverAllTestsDetails

Örnek isteği

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

Örnek yanıt

Durum kodu:

200

[]

Durum kodu:

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

Tanımlar

Name	Description
CloudError	Hizmetten bir hata yanıtı.
CloudErrorBody	Hizmetten bir hata yanıtı.
ExpressRouteFailoverCircuitResourceDetails
ExpressRouteFailoverConnectionResourceDetails
ExpressRouteFailoverTestDetails	ExpressRoute yük devretme testi ayrıntıları
FailoverConnectionStatus	Bağlantının mevcut durumu
FailoverTestStatus	Testin mevcut durumu
FailoverTestType	Yük devretme testinin türü

CloudError

Nesne

Hizmetten bir hata yanıtı.

Name	Tür	Description
error	CloudErrorBody	Bulut hata gövdesi.

CloudErrorBody

Nesne

Hizmetten bir hata yanıtı.

Name	Tür	Description
code	string	Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
details	CloudErrorBody[]	Hatayla ilgili ek ayrıntıların listesi.
message	string	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
target	string	Belirli bir hatanın hedefi. Örneğin, özelliğin adı hatalı.

ExpressRouteFailoverCircuitResourceDetails

Nesne

Name	Tür	Description
connectionName	string	Devreyle ilişkili bağlantı adı
name	string	Devre Adı
nrpResourceUri	string (arm-id)	Devrenin NRP Kaynak URI'si

ExpressRouteFailoverConnectionResourceDetails

Nesne

Name	Tür	Description
lastUpdatedTime	string	Bağlantının en son güncellendiği saat
name	string	Bağlantı Adı
nrpResourceUri	string (arm-id)	Bağlantının NRP Kaynak URI'si
status	FailoverConnectionStatus	Bağlantının mevcut durumu

ExpressRouteFailoverTestDetails

Nesne

ExpressRoute yük devretme testi ayrıntıları

Name	Tür	Description
circuits	ExpressRouteFailoverCircuitResourceDetails[]	Eşleme konumundaki tüm devreler
connections	ExpressRouteFailoverConnectionResourceDetails[]	Eşleme konumundaki devrelere yapılan tüm bağlantılar
endTime	string	Testin tamamlandığı zaman
issues	string[]	Testle ilgili tüm sorunların listesi
peeringLocation	string	Testin eşleme konumu
startTime	string	Testin başlatıldığı zaman
status	FailoverTestStatus	Testin mevcut durumu
testGuid	string	Testle ilişkili benzersiz GUID
testType	FailoverTestType	Yük devretme testinin türü

FailoverConnectionStatus

Numaralandırma

Bağlantının mevcut durumu

Değer	Description
Connected	Bağlandı
Disconnected	Disconnected

FailoverTestStatus

Numaralandırma

Testin mevcut durumu

Değer	Description
NotStarted	Henüz Başlamadı
Starting	Starting
Running	Koşmak
StartFailed	StartFailed
Stopping	Durduruluyor
Completed	Tamamlandı
StopFailed	StopFailed
Invalid	Geçersiz
Expired	Süresi doldu

FailoverTestType

Numaralandırma

Yük devretme testinin türü

Değer	Description
SingleSiteFailover	SingleSiteFailover
MultiSiteFailover	MultiSiteFailover
All	Tümü