Partager via

Experiments - Create Or Update

  • Référence
Service:
Chaos Studio
Version d'API:
2024-01-01

Créer ou mettre à jour une ressource Experiment.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}?api-version=2024-01-01

Paramètres URI

Nom Dans Obligatoire Type Description
experimentName
 path True

string

Chaîne qui représente un nom de ressource Experiment.

Modèle d’expression régulière: ^[^<>%&:?#/\\]+$
resourceGroupName
 path True

string

Chaîne qui représente un groupe de ressources Azure.

Modèle d’expression régulière: ^[a-zA-Z0-9_\-\.\(\)]*[a-zA-Z0-9_\-\(\)]$
subscriptionId
 path True

string

GUID qui représente un ID d’abonnement Azure.

Modèle d’expression régulière: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
api-version
 query True

string

Chaîne qui définit la version de l’API.

Modèle d’expression régulière: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(|-preview)$

Corps de la demande

Nom Obligatoire Type Description
location True

string

Emplacement géographique où réside la ressource
properties.selectors True selector[]:

Liste des sélecteurs.
properties.steps True

step[]

Liste des étapes.
identity

resourceIdentity

Identité de la ressource d’expérience.
tags

object

Balises de ressource.

Réponses

Nom Type Description
200 OK

experiment

Opération d’expérience de remplacement de longue durée.
201 Created

experiment

Opération de création d’expérience de longue durée.
Other Status Codes

ErrorResponse

Réponse d’erreur retournée si la demande a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Create/update a Experiment in a resource group.

Exemple de requête

PUT https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/experiments/exampleExperiment?api-version=2024-01-01

{
  "location": "eastus2euap",
  "identity": {
    "type": "SystemAssigned"
  },
  "properties": {
    "steps": [
      {
        "name": "step1",
        "branches": [
          {
            "name": "branch1",
            "actions": [
              {
                "type": "continuous",
                "name": "urn:csci:microsoft:virtualMachine:shutdown/1.0",
                "selectorId": "selector1",
                "duration": "PT10M",
                "parameters": [
                  {
                    "key": "abruptShutdown",
                    "value": "false"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "selectors": [
      {
        "type": "List",
        "id": "selector1",
        "targets": [
          {
            "type": "ChaosTarget",
            "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/exampleVM/providers/Microsoft.Chaos/targets/Microsoft-VirtualMachine"
          }
        ]
      }
    ]
  }
}

Exemple de réponse

Code d’état:
201 
Azure-AsyncOperation: https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/myResourceGroup/providers/Microsoft.Chaos/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-01-01
Location: https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/myResourceGroup/providers/Microsoft.Chaos/experiments/00000000-0000-0000-0000-000000000000?api-version=2024-01-01
{
  "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/experiments/exampleExperiment",
  "type": "Microsoft.Chaos/experiments",
  "name": "exampleExperiment",
  "location": "eastus2euap",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "d04ab567-2c07-43ef-a7f4-4527626b7f56",
    "tenantId": "8c3e2fb2-fe7a-4bf1-b779-d73990782fe6"
  },
  "properties": {
    "provisioningState": "Creating",
    "steps": [
      {
        "name": "step1",
        "branches": [
          {
            "name": "branch1",
            "actions": [
              {
                "type": "continuous",
                "name": "urn:csci:microsoft:virtualMachine:shutdown/1.0",
                "selectorId": "selector1",
                "duration": "PT10M",
                "parameters": [
                  {
                    "key": "abruptShutdown",
                    "value": "false"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "selectors": [
      {
        "type": "List",
        "id": "selector1",
        "targets": [
          {
            "type": "ChaosTarget",
            "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/exampleVM/providers/Microsoft.Chaos/targets/Microsoft-VirtualMachine"
          }
        ]
      }
    ]
  },
  "systemData": {
    "createdAt": "2021-07-01T00:00:00.0Z",
    "createdBy": "User",
    "createdByType": "b3a41dba-4415-4d36-9ee8-e5eaa86db976",
    "lastModifiedAt": "2021-07-01T00:00:00.0Z",
    "lastModifiedBy": "User",
    "lastModifiedByType": "b3a41dba-4415-4d36-9ee8-e5eaa86db976"
  }
}
Code d’état:
200 
Azure-AsyncOperation: https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/myResourceGroup/providers/Microsoft.Chaos/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2024-01-01
Location: https://management.azure.com/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/myResourceGroup/providers/Microsoft.Chaos/experiments/00000000-0000-0000-0000-000000000000?api-version=2024-01-01
{
  "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Chaos/experiments/exampleExperiment",
  "type": "Microsoft.Chaos/experiments",
  "name": "exampleExperiment",
  "location": "eastus2euap",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "d04ab567-2c07-43ef-a7f4-4527626b7f56",
    "tenantId": "8c3e2fb2-fe7a-4bf1-b779-d73990782fe6"
  },
  "properties": {
    "provisioningState": "Updating",
    "steps": [
      {
        "name": "step1",
        "branches": [
          {
            "name": "branch1",
            "actions": [
              {
                "type": "continuous",
                "name": "urn:csci:microsoft:virtualMachine:shutdown/1.0",
                "selectorId": "selector1",
                "duration": "PT10M",
                "parameters": [
                  {
                    "key": "abruptShutdown",
                    "value": "false"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "selectors": [
      {
        "type": "List",
        "id": "selector1",
        "targets": [
          {
            "type": "ChaosTarget",
            "id": "/subscriptions/6b052e15-03d3-4f17-b2e1-be7f07588291/resourceGroups/exampleRG/providers/Microsoft.Compute/virtualMachines/exampleVM/providers/Microsoft.Chaos/targets/Microsoft-VirtualMachine"
          }
        ]
      }
    ]
  },
  "systemData": {
    "createdAt": "2021-07-01T00:00:00.0Z",
    "createdBy": "User",
    "createdByType": "b3a41dba-4415-4d36-9ee8-e5eaa86db976",
    "lastModifiedAt": "2021-07-01T00:00:00.0Z",
    "lastModifiedBy": "User",
    "lastModifiedByType": "b3a41dba-4415-4d36-9ee8-e5eaa86db976"
  }
}

Définitions

Nom Description
branch

Modèle qui représente une branche à l’étape. 9 au total par expérience.
continuousAction

Modèle qui représente une action continue.
createdByType

Type d’identité qui a créé la ressource.
delayAction

Modèle qui représente une action de délai.
discreteAction

Modèle qui représente une action discrète.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
experiment

Modèle qui représente une ressource Experiment.
keyValuePair

Carte pour décrire les paramètres d’une action.
listSelector

Modèle qui représente un sélecteur de liste.
ProvisioningState

État d’approvisionnement le plus récent pour la ressource d’expérience donnée.
querySelector

Modèle qui représente un sélecteur de requête.
resourceIdentity

Identité d’une ressource.
ResourceIdentityType

Chaîne du type d’identité de ressource.
simpleFilter

Modèle qui représente un filtre cible simple.
simpleFilterParameters

Modèle qui représente les paramètres de filtre Simple.
step

Modèle qui représente une étape dans la ressource Experiment.
systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.
targetReference

Modèle qui représente une référence à une cible dans le sélecteur.
TargetReferenceType

Énumération du type de référence cible.
UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

branch

Modèle qui représente une branche à l’étape. 9 au total par expérience.

Nom Type Description
actions action[]:

Liste d’actions.
name

string

Chaîne du nom de la branche.

continuousAction

Modèle qui représente une action continue.

Nom Type Description
duration

string

ISO8601 chaîne mise en forme qui représente une durée.
name

string

Chaîne qui représente un URN de capacité.
parameters

keyValuePair[]

Liste des paires de valeurs de clé.
selectorId

string

Chaîne qui représente un sélecteur.
type string:

continuous

Énumération qui fait la distinction entre les modèles d’action.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

delayAction

Modèle qui représente une action de délai.

Nom Type Description
duration

string

ISO8601 chaîne mise en forme qui représente une durée.
name

string

Chaîne qui représente un URN de capacité.
type string:

delay

Énumération qui fait la distinction entre les modèles d’action.

discreteAction

Modèle qui représente une action discrète.

Nom Type Description
name

string

Chaîne qui représente un URN de capacité.
parameters

keyValuePair[]

Liste des paires de valeurs de clé.
selectorId

string

Chaîne qui représente un sélecteur.
type string:

discrete

Énumération qui fait la distinction entre les modèles d’action.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires
type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d'erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

experiment

Modèle qui représente une ressource Experiment.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

resourceIdentity

Identité de la ressource d’expérience.
location

string

Emplacement géographique où réside la ressource
name

string

nom de la ressource.
properties.provisioningState

ProvisioningState

État d’approvisionnement le plus récent pour la ressource d’expérience donnée.
properties.selectors selector[]:

Liste des sélecteurs.
properties.steps

step[]

Liste des étapes.
systemData

systemData

Métadonnées système de la ressource d’expérience.
tags

object

Balises de ressource.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

keyValuePair

Carte pour décrire les paramètres d’une action.

Nom Type Description
key

string

Nom du paramètre de l’action.
value

string

Valeur du paramètre de l’action.

listSelector

Modèle qui représente un sélecteur de liste.

Nom Type Description
filter filter:

simpleFilter

Modèle qui représente les types de filtres disponibles qui peuvent être appliqués à une liste de cibles.
id

string

Chaîne de l’ID du sélecteur.
targets

targetReference[]

Liste des références cibles.
type string:

List

Énumération du type de sélecteur.

ProvisioningState

État d’approvisionnement le plus récent pour la ressource d’expérience donnée.

Nom Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

querySelector

Modèle qui représente un sélecteur de requête.

Nom Type Description
filter filter:

simpleFilter

Modèle qui représente les types de filtres disponibles qui peuvent être appliqués à une liste de cibles.
id

string

Chaîne de l’ID du sélecteur.
queryString

string

Requête De langage de requête Azure Resource Graph (ARG) pour les ressources cibles.
subscriptionIds

string[]

Liste d’ID d’abonnement à la requête de ressources d’étendue.
type string:

Query

Énumération du type de sélecteur.

resourceIdentity

Identité d’une ressource.

Nom Type Description
principalId

string

GUID qui représente l’ID principal de cette identité de ressource.
tenantId

string

GUID qui représente l’ID de locataire de cette identité de ressource.
type

ResourceIdentityType

Chaîne du type d’identité de ressource.
userAssignedIdentities

<string,  UserAssignedIdentity>

identités User-Assigned
Liste des identités utilisateur associées à l’expérience. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

ResourceIdentityType

Chaîne du type d’identité de ressource.

Nom Type Description
None

string

SystemAssigned

string

UserAssigned

string

simpleFilter

Modèle qui représente un filtre cible simple.

Nom Type Description
parameters

simpleFilterParameters

Modèle qui représente les paramètres de filtre Simple.
type string:

Simple

Énumération qui établit une distinction entre les types de filtres. Actuellement, seul le Simple type est pris en charge.

simpleFilterParameters

Modèle qui représente les paramètres de filtre Simple.

Nom Type Description
zones

string[]

Liste des zones de disponibilité Azure par lesquelles filtrer les cibles.

step

Modèle qui représente une étape dans la ressource Experiment.

Nom Type Description
branches

branch[]

Liste des branches.
name

string

Chaîne du nom de l’étape.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la dernière ressource.
lastModifiedByType

createdByType

Type d’identité qui a modifié la dernière ressource.

targetReference

Modèle qui représente une référence à une cible dans le sélecteur.

Nom Type Description
id

string

Chaîne de l’ID de ressource d’une ressource cible.
type

TargetReferenceType

Énumération du type de référence cible.

TargetReferenceType

Énumération du type de référence cible.

Nom Type Description
ChaosTarget

string

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

Nom Type Description
clientId

string

ID client de l’identité affectée.
principalId

string

ID principal de l’identité affectée.