Virtual Network Gateways - Get Failover All Test Details

Szolgáltatás:

Network Gateway

API-verzió:

2024-05-01

Ez a művelet lekéri a különböző társviszony-létesítési helyek átjáróján végrehajtott feladatátvételi tesztek részleteit

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.
virtualNetworkGatewayName	path	True	string	A virtuális hálózati átjáró neve.
api-version	query	True	string	Ügyfél API-verziója.
fetchLatest	query	True	boolean	Csak az egyes társviszony-létesítési helyek legújabb tesztjeinek lekérése
type	query	True	string	A feladatátvételi teszt típusa

Válaszok

Name	Típus	Description
200 OK	ExpressRouteFailoverTestDetails[]	Az átjáró feladatátvételi tesztjének részletei
202 Accepted		Elfogadva, és a művelet aszinkron módon fejeződik be. Fejlécek location: string
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

VirtualNetworkGatewayGetFailoverAllTestsDetails

Mintakérelem

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/getFailoverAllTestsDetails?type=SingleSiteFailover&fetchLatest=true&api-version=2024-05-01

Java

/**
 * Samples for VirtualNetworkGateways GetFailoverAllTestDetails.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/
     * VirtualNetworkGatewayGetFailoverAllTestsDetails.json
     */
    /**
     * Sample code: VirtualNetworkGatewayGetFailoverAllTestsDetails.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        virtualNetworkGatewayGetFailoverAllTestsDetails(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getVirtualNetworkGateways().getFailoverAllTestDetails("rg1", "ergw",
            "SingleSiteFailover", true, 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_all_tests_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_all_test_details(
        resource_group_name="rg1",
        virtual_network_gateway_name="ergw",
        type="SingleSiteFailover",
        fetch_latest="true",
    ).result()
    print(response)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/examples/VirtualNetworkGatewayGetFailoverAllTestsDetails.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/VirtualNetworkGatewayGetFailoverAllTestsDetails.json
func ExampleVirtualNetworkGatewaysClient_BeginGetFailoverAllTestDetails() {
	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().BeginGetFailoverAllTestDetails(ctx, "rg1", "ergw", "SingleSiteFailover", true, 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.ExpressRouteFailoverTestDetailsArray = []*armnetwork.ExpressRouteFailoverTestDetails{
	// }
}

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 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/stable/2024-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

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/VirtualNetworkGatewayGetFailoverAllTestsDetails.json
// this example is just showing the usage of "VirtualNetworkGateways_GetFailoverAllTestDetails" 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 type = "SingleSiteFailover";
bool fetchLatest = true;
ArmOperation<IList<ExpressRouteFailoverTestDetails>> lro = await virtualNetworkGateway.GetFailoverAllTestDetailsAsync(WaitUntil.Completed, type, fetchLatest);
IList<ExpressRouteFailoverTestDetails> 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

Mintaválasz

Állapotkód:

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

Állapotkód:

200

[]

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
ExpressRouteFailoverCircuitResourceDetails
ExpressRouteFailoverConnectionResourceDetails
ExpressRouteFailoverTestDetails	ExpressRoute feladatátvételi teszt részletei
FailoverConnectionStatus	A kapcsolat aktuális állapota
FailoverTestStatus	A teszt aktuális állapota
FailoverTestType	A feladatátvételi teszt típusa

CloudError

Objektum

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Felhőbeli hibatörzs.

CloudErrorBody

Objektum

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hiba további részleteinek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a tulajdonság neve hibás.

ExpressRouteFailoverCircuitResourceDetails

Objektum

Name	Típus	Description
connectionName	string	A kapcsolatcsoporthoz társított kapcsolat neve
name	string	Kapcsolatcsoport neve
nrpResourceUri	string (arm-id)	A kapcsolatcsoport NRP-erőforrásának URI-ja

ExpressRouteFailoverConnectionResourceDetails

Objektum

Name	Típus	Description
lastUpdatedTime	string	A kapcsolat legutóbbi frissítésének időpontja
name	string	Kapcsolat neve
nrpResourceUri	string (arm-id)	A kapcsolat NRP-erőforrás-URI-ja
status	FailoverConnectionStatus	A kapcsolat aktuális állapota

ExpressRouteFailoverTestDetails

Objektum

ExpressRoute feladatátvételi teszt részletei

Name	Típus	Description
circuits	ExpressRouteFailoverCircuitResourceDetails[]	A társviszony-létesítési helyen lévő összes kapcsolatcsoport
connections	ExpressRouteFailoverConnectionResourceDetails[]	A társviszony-létesítési helyen lévő kapcsolatcsoportok összes kapcsolata
endTime	string	A teszt befejezésének időpontja
issues	string[]	A teszttel kapcsolatos problémák listája
peeringLocation	string	A teszt társviszony-létesítési helye
startTime	string	A teszt indításának időpontja
status	FailoverTestStatus	A teszt aktuális állapota
testGuid	string	A teszthez társított egyedi GUID
testType	FailoverTestType	A feladatátvételi teszt típusa

FailoverConnectionStatus

Enumerálás

A kapcsolat aktuális állapota

Érték	Description
Connected
Disconnected

FailoverTestStatus

Enumerálás

A teszt aktuális állapota

Érték	Description
Completed
Expired
Invalid
NotStarted
Running
StartFailed
Starting
StopFailed
Stopping

FailoverTestType

Enumerálás

A feladatátvételi teszt típusa

Érték	Description
All
MultiSiteFailover
SingleSiteFailover