Experiments - List By Profile

Szolgáltatás:

Internet Analyzer

API-verzió:

2019-11-01

Lekéri a kísérletek listáját

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments?api-version=2019-11-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
profileName	path	True	string pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	A bérlőhöz és a partnerhez társított profilazonosító
resourceGroupName	path	True	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	Az Azure-előfizetés erőforráscsoportjának 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.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	ExperimentList	sikeres művelet
Other Status Codes	ErrorResponse	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

Gets a list of Experiments

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments?api-version=2019-11-01

Java

/**
 * Samples for Experiments ListByProfile.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/
     * NetworkExperimentListExperiments.json
     */
    /**
     * Sample code: Gets a list of Experiments.
     * 
     * @param manager Entry point to FrontDoorManager.
     */
    public static void getsAListOfExperiments(com.azure.resourcemanager.frontdoor.FrontDoorManager manager) {
        manager.experiments().listByProfile("MyResourceGroup", "MyProfile", 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.frontdoor import FrontDoorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-frontdoor
# USAGE
    python network_experiment_list_experiments.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 = FrontDoorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.experiments.list_by_profile(
        resource_group_name="MyResourceGroup",
        profile_name="MyProfile",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentListExperiments.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 armfrontdoor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/frontdoor/armfrontdoor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b54ffc9278eff071455b1dbb4ad2e772afce885d/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentListExperiments.json
func ExampleExperimentsClient_NewListByProfilePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armfrontdoor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewExperimentsClient().NewListByProfilePager("MyResourceGroup", "MyProfile", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ExperimentList = armfrontdoor.ExperimentList{
		// 	Value: []*armfrontdoor.Experiment{
		// 		{
		// 			Name: to.Ptr("MyExperiment"),
		// 			ID: to.Ptr("/subscriptions/subId/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments"),
		// 			Properties: &armfrontdoor.ExperimentProperties{
		// 				Description: to.Ptr("this is my first experiment!"),
		// 				EnabledState: to.Ptr(armfrontdoor.StateEnabled),
		// 				EndpointA: &armfrontdoor.Endpoint{
		// 					Name: to.Ptr("endpoint A"),
		// 					Endpoint: to.Ptr("endpointA.net"),
		// 				},
		// 				EndpointB: &armfrontdoor.Endpoint{
		// 					Name: to.Ptr("endpoint B"),
		// 					Endpoint: to.Ptr("endpointB.net"),
		// 				},
		// 				ResourceState: to.Ptr(armfrontdoor.NetworkExperimentResourceStateCreating),
		// 				ScriptFileURI: to.Ptr("www.myScript.com"),
		// 				Status: to.Ptr("ongoing"),
		// 			},
		// 	}},
		// }
	}
}

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 { FrontDoorManagementClient } = require("@azure/arm-frontdoor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a list of Experiments
 *
 * @summary Gets a list of Experiments
 * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentListExperiments.json
 */
async function getsAListOfExperiments() {
  const subscriptionId = process.env["FRONTDOOR_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["FRONTDOOR_RESOURCE_GROUP"] || "MyResourceGroup";
  const profileName = "MyProfile";
  const credential = new DefaultAzureCredential();
  const client = new FrontDoorManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.experiments.listByProfile(resourceGroupName, profileName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.FrontDoor.Models;
using Azure.ResourceManager.FrontDoor;

// Generated from example definition: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentListExperiments.json
// this example is just showing the usage of "Experiments_ListByProfile" 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 FrontDoorNetworkExperimentProfileResource created on azure
// for more information of creating FrontDoorNetworkExperimentProfileResource, please refer to the document of FrontDoorNetworkExperimentProfileResource
string subscriptionId = "subid";
string resourceGroupName = "MyResourceGroup";
string profileName = "MyProfile";
ResourceIdentifier frontDoorNetworkExperimentProfileResourceId = FrontDoorNetworkExperimentProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
FrontDoorNetworkExperimentProfileResource frontDoorNetworkExperimentProfile = client.GetFrontDoorNetworkExperimentProfileResource(frontDoorNetworkExperimentProfileResourceId);

// get the collection of this FrontDoorExperimentResource
FrontDoorExperimentCollection collection = frontDoorNetworkExperimentProfile.GetFrontDoorExperiments();

// invoke the operation and iterate over the result
await foreach (FrontDoorExperimentResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    FrontDoorExperimentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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:

200

{
  "value": [
    {
      "name": "MyExperiment",
      "id": "/subscriptions/subId/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments",
      "properties": {
        "description": "this is my first experiment!",
        "endpointA": {
          "name": "endpoint A",
          "endpoint": "endpointA.net"
        },
        "endpointB": {
          "name": "endpoint B",
          "endpoint": "endpointB.net"
        },
        "enabledState": "Enabled",
        "resourceState": "Creating",
        "status": "ongoing",
        "scriptFileUri": "www.myScript.com"
      }
    }
  ]
}

Definíciók

Name	Description
Endpoint	A végpont tulajdonságainak meghatározása
ErrorResponse	A hibaüzenet azt jelzi, hogy a Front Door szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.
Experiment	Egy kísérlet tulajdonságainak meghatározása
ExperimentList	A kísérletek listáját határozza meg. Tartalmazza a kísérletobjektumok listáját és egy URL-hivatkozást a következő eredménykészlet lekéréséhez.
NetworkExperimentResourceState	Meghatározza a kiszolgálóoldali erőforrás állapotát
state	A kísérlet állapota

Endpoint

Objektum

A végpont tulajdonságainak meghatározása

Name	Típus	Description
endpoint	string	A végpont URL-címe
name	string	A végpont neve

ErrorResponse

Objektum

A hibaüzenet azt jelzi, hogy a Front Door szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Name	Típus	Description
code	string	Hibakód.
message	string	A művelet sikertelen voltát jelző hibaüzenet.

Experiment

Objektum

Egy kísérlet tulajdonságainak meghatározása

Name	Típus	Description
id	string	Erőforrás-azonosító.
location	string	Erőforrás helye.
name	string	A kísérlet neve
properties.description	string	A kísérlet részleteinek vagy szándékainak leírása
properties.enabledState	state	A kísérlet állapota
properties.endpointA	Endpoint	Egy kísérlet A végpontja
properties.endpointB	Endpoint	Egy kísérlet B végpontja
properties.resourceState	NetworkExperimentResourceState	Erőforrás állapota.
properties.scriptFileUri	string	A kísérletben használt szkript uri-ja
properties.status	string	A kísérlet állapotának leírása a kiszolgálóoldalról
tags	object	Erőforráscímkék.
type	string	Erőforrás típusa.

ExperimentList

Objektum

A kísérletek listáját határozza meg. Tartalmazza a kísérletobjektumok listáját és egy URL-hivatkozást a következő eredménykészlet lekéréséhez.

Name	Típus	Description
nextLink	string	Ha vannak ilyenek, az URL-cím a kísérletobjektumok következő készletének lekéréséhez.
value	Experiment[]	Az erőforráscsoporton belüli kísérletek listája.

NetworkExperimentResourceState

Enumerálás

Meghatározza a kiszolgálóoldali erőforrás állapotát

Érték	Description
Creating
Deleting
Disabled
Disabling
Enabled
Enabling

state

Enumerálás

A kísérlet állapota

Érték	Description
Disabled
Enabled