Virtual Network Gateways - Get Failover Single Test Details

Service:

Network Gateway

API Version:

2024-05-01

This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverSingleTestDetails?peeringLocation={peeringLocation}&failoverTestId={failoverTestId}&api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
virtualNetworkGatewayName	path	True	string	The name of the virtual network gateway.
api-version	query	True	string	Client API version.
failoverTestId	query	True	string	The unique Guid value which identifies the test
peeringLocation	query	True	string	Peering location of the test

Responses

Name	Type	Description
200 OK	ExpressRouteFailoverSingleTestDetails[]	Details of the failover test
202 Accepted		Accepted and the operation will complete asynchronously. Headers location: string
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

VirtualNetworkGatewayGetFailoverSingleTestDetails

Sample request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/getFailoverSingleTestDetails?peeringLocation=Vancouver&failoverTestId=fe458ae8-d2ae-4520-a104-44bc233bde7e&api-version=2024-05-01

Java

/**
 * Samples for VirtualNetworkGateways GetFailoverSingleTestDetails.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * VirtualNetworkGatewayGetFailoverSingleTestDetails.json
     */
    /**
     * Sample code: VirtualNetworkGatewayGetFailoverSingleTestDetails.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualNetworkGatewayGetFailoverSingleTestDetails(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().getFailoverSingleTestDetails("rg1",
            "ergw", "Vancouver", "fe458ae8-d2ae-4520-a104-44bc233bde7e", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python virtual_network_gateway_get_failover_single_test_details.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.virtual_network_gateways.begin_get_failover_single_test_details(
        resource_group_name="rg1",
        virtual_network_gateway_name="ergw",
        peering_location="Vancouver",
        failover_test_id="fe458ae8-d2ae-4520-a104-44bc233bde7e",
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualNetworkGatewayGetFailoverSingleTestDetails.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualNetworkGatewayGetFailoverSingleTestDetails.json
func ExampleVirtualNetworkGatewaysClient_BeginGetFailoverSingleTestDetails() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVirtualNetworkGatewaysClient().BeginGetFailoverSingleTestDetails(ctx, "rg1", "ergw", "Vancouver", "fe458ae8-d2ae-4520-a104-44bc233bde7e", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ExpressRouteFailoverSingleTestDetailsArray = []*armnetwork.ExpressRouteFailoverSingleTestDetails{
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid
 *
 * @summary This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualNetworkGatewayGetFailoverSingleTestDetails.json
 */
async function virtualNetworkGatewayGetFailoverSingleTestDetails() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const virtualNetworkGatewayName = "ergw";
  const peeringLocation = "Vancouver";
  const failoverTestId = "fe458ae8-d2ae-4520-a104-44bc233bde7e";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.virtualNetworkGateways.beginGetFailoverSingleTestDetailsAndWait(
    resourceGroupName,
    virtualNetworkGatewayName,
    peeringLocation,
    failoverTestId,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualNetworkGatewayGetFailoverSingleTestDetails.json
// this example is just showing the usage of "VirtualNetworkGateways_GetFailoverSingleTestDetails" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VirtualNetworkGatewayResource created on azure
// for more information of creating VirtualNetworkGatewayResource, please refer to the document of VirtualNetworkGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string virtualNetworkGatewayName = "ergw";
ResourceIdentifier virtualNetworkGatewayResourceId = VirtualNetworkGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualNetworkGatewayName);
VirtualNetworkGatewayResource virtualNetworkGateway = client.GetVirtualNetworkGatewayResource(virtualNetworkGatewayResourceId);

// invoke the operation
string peeringLocation = "Vancouver";
string failoverTestId = "fe458ae8-d2ae-4520-a104-44bc233bde7e";
ArmOperation<IList<ExpressRouteFailoverSingleTestDetails>> lro = await virtualNetworkGateway.GetFailoverSingleTestDetailsAsync(WaitUntil.Completed, peeringLocation, failoverTestId);
IList<ExpressRouteFailoverSingleTestDetails> result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

202

Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2024-05-01

Status code:

200

[]

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
ExpressRouteFailoverRedundantRoute
ExpressRouteFailoverSingleTestDetails	ExpressRoute failover single test details
FailoverConnectionDetails
FailoverTestStatusForSingleTest	The current status of the test

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ExpressRouteFailoverRedundantRoute

Object

Name	Type	Description
peeringLocations	string[]	A list of all the peering locations for the redundant routes
routes	string[]	A list of all the redundant routes in the peering locations

ExpressRouteFailoverSingleTestDetails

Object

ExpressRoute failover single test details

Name	Type	Description
endTimeUtc	string	Time when the test was completed
failoverConnectionDetails	FailoverConnectionDetails[]	List of all the failover connections for this peering location
nonRedundantRoutes	string[]	List of al the routes that were received only from this peering location
peeringLocation	string	Peering location of the test
redundantRoutes	ExpressRouteFailoverRedundantRoute[]	List of routes received from this peering as well as some other peering location
startTimeUtc	string	Time when the test was started
status	FailoverTestStatusForSingleTest	The current status of the test
wasSimulationSuccessful	boolean	Whether the failover simulation was successful or not

FailoverConnectionDetails

Object

Name	Type	Description
failoverConnectionName	string	Name of the failover connection
failoverLocation	string	Location of the failover connection
isVerified	boolean	Whether the customer was able to establish connectivity through this failover connection or not

FailoverTestStatusForSingleTest

Enumeration

The current status of the test

Value	Description
NotStarted
Starting
Running
StartFailed
Stopping
Completed
StopFailed
Invalid
Expired