Experiments - Update

Szolgáltatás:

Internet Analyzer

API-verzió:

2019-11-01

Kísérlet frissítése kísérletazonosító alapján

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
experimentName	path	True	string pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	A kísérlethez társított kísérletazonosító
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.

Kérelem törzse

Name	Típus	Description
properties.description	string	A kísérlet szándékának vagy részleteinek leírása
properties.enabledState	state	A kísérlet állapota
tags	object	Erőforráscímkék.

Válaszok

Name	Típus	Description
200 OK	Experiment	OKÉ. sikeres művelet
202 Accepted	Experiment	Elfogadott. A kérelem feldolgozásra lett elfogadva, és a művelet aszinkron módon fejeződik be.
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

Updates an Experiment

Mintakérelem

HTTP

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

{
  "properties": {
    "description": "string",
    "enabledState": "Enabled"
  }
}

Java

import com.azure.resourcemanager.frontdoor.models.Experiment;
import com.azure.resourcemanager.frontdoor.models.State;

/**
 * Samples for Experiments Update.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/
     * NetworkExperimentUpdateExperiment.json
     */
    /**
     * Sample code: Updates an Experiment.
     * 
     * @param manager Entry point to FrontDoorManager.
     */
    public static void updatesAnExperiment(com.azure.resourcemanager.frontdoor.FrontDoorManager manager) {
        Experiment resource = manager.experiments()
            .getWithResponse("MyResourceGroup", "MyProfile", "MyExperiment", com.azure.core.util.Context.NONE)
            .getValue();
        resource.update().withDescription("string").withEnabledState(State.ENABLED).apply();
    }
}

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_update_experiment.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.begin_update(
        resource_group_name="MyResourceGroup",
        profile_name="MyProfile",
        experiment_name="MyExperiment",
        parameters={"properties": {"description": "string", "enabledState": "Enabled"}},
    ).result()
    print(response)


# x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentUpdateExperiment.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/azcore/to"
	"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/NetworkExperimentUpdateExperiment.json
func ExampleExperimentsClient_BeginUpdate() {
	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)
	}
	poller, err := clientFactory.NewExperimentsClient().BeginUpdate(ctx, "MyResourceGroup", "MyProfile", "MyExperiment", armfrontdoor.ExperimentUpdateModel{
		Properties: &armfrontdoor.ExperimentUpdateProperties{
			Description:  to.Ptr("string"),
			EnabledState: to.Ptr(armfrontdoor.StateEnabled),
		},
	}, 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.Experiment = armfrontdoor.Experiment{
	// 	Name: to.Ptr("MyExperiment"),
	// 	Type: to.Ptr("Microsoft.Network/NetworkExperimentprofiles"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment"),
	// 	Location: to.Ptr("WestUs"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	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 Updates an Experiment
 *
 * @summary Updates an Experiment
 * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-11-01/examples/NetworkExperimentUpdateExperiment.json
 */
async function updatesAnExperiment() {
  const subscriptionId = process.env["FRONTDOOR_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["FRONTDOOR_RESOURCE_GROUP"] || "MyResourceGroup";
  const profileName = "MyProfile";
  const experimentName = "MyExperiment";
  const parameters = {
    description: "string",
    enabledState: "Enabled",
  };
  const credential = new DefaultAzureCredential();
  const client = new FrontDoorManagementClient(credential, subscriptionId);
  const result = await client.experiments.beginUpdateAndWait(
    resourceGroupName,
    profileName,
    experimentName,
    parameters,
  );
  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.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/NetworkExperimentUpdateExperiment.json
// this example is just showing the usage of "Experiments_Update" 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 FrontDoorExperimentResource created on azure
// for more information of creating FrontDoorExperimentResource, please refer to the document of FrontDoorExperimentResource
string subscriptionId = "subid";
string resourceGroupName = "MyResourceGroup";
string profileName = "MyProfile";
string experimentName = "MyExperiment";
ResourceIdentifier frontDoorExperimentResourceId = FrontDoorExperimentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, experimentName);
FrontDoorExperimentResource frontDoorExperiment = client.GetFrontDoorExperimentResource(frontDoorExperimentResourceId);

// invoke the operation
FrontDoorExperimentPatch patch = new FrontDoorExperimentPatch
{
    Description = "string",
    EnabledState = FrontDoorExperimentState.Enabled,
};
ArmOperation<FrontDoorExperimentResource> lro = await frontDoorExperiment.UpdateAsync(WaitUntil.Completed, patch);
FrontDoorExperimentResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment",
  "name": "MyExperiment",
  "type": "Microsoft.Network/NetworkExperimentprofiles",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "location": "WestUs",
  "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"
  }
}

Állapotkód:

202

{
  "id": "/subscriptions/subid/resourceGroups/MyResourceGroup/providers/Microsoft.Network/NetworkExperimentProfiles/MyProfile/Experiments/MyExperiment",
  "name": "MyExperiment",
  "type": "Microsoft.Network/NetworkExperimentprofiles",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "location": "WestUs",
  "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
ExperimentUpdateModel	Egy kísérlet módosítható attribútumait határozza meg
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.

ExperimentUpdateModel

Objektum

Egy kísérlet módosítható attribútumait határozza meg

Name	Típus	Description
properties.description	string	A kísérlet szándékának vagy részleteinek leírása
properties.enabledState	state	A kísérlet állapota
tags	object	Erőforráscímkék.

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