Virtual Network Gateways - Get Failover All Test Details

Служба:

Network Gateway

Версия API:

2025-05-01

Эта операция извлекает сведения обо всех тестах отработки отказа, выполняемых в шлюзе для разных расположений пиринга.

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

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
virtualNetworkGatewayName	path	True	string	Имя шлюза виртуальной сети.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
fetchLatest	query	True	boolean	Получение только последних тестов для каждого расположения пиринга
type	query	True	string	Тип теста отработки отказа

Ответы

Имя	Тип	Описание
200 OK	ExpressRouteFailoverTestDetails[]	Операция Azure успешно завершена.
202 Accepted		Операция ресурса принята. Заголовки Location: string Retry-After: integer
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

VirtualNetworkGatewayGetFailoverAllTestsDetails

Образец запроса

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

Пример ответа

Код состояния:

200

[]

Код состояния:

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

Определения

Имя	Описание
CloudError	Ответ об ошибке от сервиса.
CloudErrorBody	Ответ об ошибке от сервиса.
ExpressRouteFailoverCircuitResourceDetails
ExpressRouteFailoverConnectionResourceDetails
ExpressRouteFailoverTestDetails	Сведения о тестовом тестировании отработки отказа ExpressRoute
FailoverConnectionStatus	Текущий статус подключения
FailoverTestStatus	Текущий статус теста
FailoverTestType	Тип теста отработки отказа

CloudError

Объект

Ответ об ошибке от сервиса.

Имя	Тип	Описание
error	CloudErrorBody	Тело ошибки облака.

CloudErrorBody

Объект

Ответ об ошибке от сервиса.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

ExpressRouteFailoverCircuitResourceDetails

Объект

Имя	Тип	Описание
connectionName	string	Имя соединения, связанного с цепью
name	string	Название цепи
nrpResourceUri	string (arm-id)	URI ресурса NRP канала

ExpressRouteFailoverConnectionResourceDetails

Объект

Имя	Тип	Описание
lastUpdatedTime	string	Время последнего обновления соединения
name	string	Имя подключения
nrpResourceUri	string (arm-id)	URI ресурса NRP подключения
status	FailoverConnectionStatus	Текущий статус подключения

ExpressRouteFailoverTestDetails

Объект

Сведения о тестовом тестировании отработки отказа ExpressRoute

Имя	Тип	Описание
circuits	ExpressRouteFailoverCircuitResourceDetails[]	Все каналы в месте пиринга
connections	ExpressRouteFailoverConnectionResourceDetails[]	Все подключения к цепям в месте пиринга
endTime	string	Время завершения теста
issues	string[]	Список всех проблем с тестом
peeringLocation	string	Расположение пиринга теста
startTime	string	Время начала теста
status	FailoverTestStatus	Текущий статус теста
testGuid	string	Уникальный идентификатор GUID, связанный с тестом
testType	FailoverTestType	Тип теста отработки отказа

FailoverConnectionStatus

Перечисление

Текущий статус подключения

Значение	Описание
Connected	Подключен
Disconnected	Отключен

FailoverTestStatus

Перечисление

Текущий статус теста

Значение	Описание
NotStarted	Не начато
Starting	Запуск
Running	Бег
StartFailed	StartFailed
Stopping	Остановка
Completed	Завершено
StopFailed	СтопНеудача
Invalid	Недопустимо
Expired	Срок действия истек

FailoverTestType

Перечисление

Тип теста отработки отказа

Значение	Описание
SingleSiteFailover	SingleSiteFailover
MultiSiteFailover	MultiSiteFailover
All	Все