Virtual Network Gateways - Get Failover All Test Details

Servicio:

Network Gateway

Versión de la API:

2025-05-01

Esta operación recupera los detalles de todas las pruebas de conmutación por error realizadas en la puerta de enlace para diferentes ubicaciones de emparejamiento.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
virtualNetworkGatewayName	path	True	string	Nombre de la puerta de enlace de red virtual.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.
fetchLatest	query	True	boolean	Capturar solo las pruebas más recientes para cada ubicación de emparejamiento
type	query	True	string	Tipo de prueba de conmutación por error

Respuestas

Nombre	Tipo	Description
200 OK	ExpressRouteFailoverTestDetails[]	La operación de Azure se completó correctamente.
202 Accepted		Operación de recursos aceptada. Encabezados Location: string Retry-After: integer
Other Status Codes	CloudError	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

VirtualNetworkGatewayGetFailoverAllTestsDetails

Solicitud de ejemplo

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

Respuesta de muestra

status code:

200

[]

status code:

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

Definiciones

Nombre	Description
CloudError	Una respuesta de error del servicio.
CloudErrorBody	Una respuesta de error del servicio.
ExpressRouteFailoverCircuitResourceDetails
ExpressRouteFailoverConnectionResourceDetails
ExpressRouteFailoverTestDetails	Detalles de la prueba de conmutación por error de ExpressRoute
FailoverConnectionStatus	El estado actual de la conexión
FailoverTestStatus	El estado actual de la prueba
FailoverTestType	Tipo de prueba de conmutación por error

CloudError

Objeto

Una respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo de error de nube.

CloudErrorBody

Objeto

Una respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Una lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

ExpressRouteFailoverCircuitResourceDetails

Objeto

Nombre	Tipo	Description
connectionName	string	Nombre de conexión asociado al circuito
name	string	Nombre del circuito
nrpResourceUri	string (arm-id)	NRP Resource URI del circuito

ExpressRouteFailoverConnectionResourceDetails

Objeto

Nombre	Tipo	Description
lastUpdatedTime	string	Hora en que se actualizó la conexión por última vez
name	string	Nombre de la conexión
nrpResourceUri	string (arm-id)	NRP Recurso URI de la conexión
status	FailoverConnectionStatus	El estado actual de la conexión

ExpressRouteFailoverTestDetails

Objeto

Detalles de la prueba de conmutación por error de ExpressRoute

Nombre	Tipo	Description
circuits	ExpressRouteFailoverCircuitResourceDetails[]	Todos los circuitos de la ubicación de emparejamiento
connections	ExpressRouteFailoverConnectionResourceDetails[]	Todas las conexiones a los circuitos en la ubicación de emparejamiento
endTime	string	Hora en que se completó la prueba
issues	string[]	Una lista de todos los problemas con la prueba
peeringLocation	string	Ubicación de emparejamiento de la prueba
startTime	string	Hora en que se inició la prueba
status	FailoverTestStatus	El estado actual de la prueba
testGuid	string	El GUID único asociado a la prueba
testType	FailoverTestType	Tipo de prueba de conmutación por error

FailoverConnectionStatus

Enumeración

El estado actual de la conexión

Valor	Description
Connected	Conectado
Disconnected	Desconectado

FailoverTestStatus

Enumeración

El estado actual de la prueba

Valor	Description
NotStarted	No iniciado
Starting	Iniciando
Running	Correr
StartFailed	StartFailed
Stopping	Parar
Completed	Completado
StopFailed	ParaDeFracasado
Invalid	No válido
Expired	Caducado

FailoverTestType

Enumeración

Tipo de prueba de conmutación por error

Valor	Description
SingleSiteFailover	Failover SingleSite
MultiSiteFailover	MultiSiteFailover
All	Todos