Freigeben über

Experiments - Create Or Update

  • Referenz
Dienst:
Chaos Studio
API-Version:
2024-01-01

Erstellen oder Aktualisieren einer Experiment-Ressource.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
experimentName
 path True

string

minLength: 1
pattern: ^[^<>%&:?#/\\]+$

Zeichenfolge, die einen Experiment-Ressourcennamen darstellt.
resourceGroupName
 path True

string

pattern: ^[a-zA-Z0-9_\-\.\(\)]*[a-zA-Z0-9_\-\(\)]$

Zeichenfolge, die eine Azure-Ressourcengruppe darstellt.
subscriptionId
 path True

string

pattern: ^[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}$

GUID, die eine Azure-Abonnement-ID darstellt.
api-version
 query True

string

pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(|-preview)$

Zeichenfolge, die die API-Version festlegt.

Anforderungstext

Name Erforderlich Typ Beschreibung
location True

string

Der geografische Standort, an dem sich die Ressource befindet
properties.selectors True selector[]:

Liste der Selektoren.
properties.steps True

step[]

Liste der Schritte.
identity

resourceIdentity

Die Identität der Experimentressource.
tags

object

Ressourcentags.

Antworten

Name Typ Beschreibung
200 OK

experiment

Experimentvorgang mit langer Ausführungsdauer.
201 Created

experiment

Experimentvorgang mit langer Ausführungsdauer.
Other Status Codes

ErrorResponse

Fehlerantwort, die zurückgegeben wurde, wenn die Anforderung nicht erfolgreich war.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

Create/update a Experiment in a resource group.

Beispielanforderung

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"
          }
        ]
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:
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"
  }
}
Statuscode:
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"
  }
}

Definitionen

Name Beschreibung
branch

Modell, das eine Verzweigung im Schritt darstellt. Insgesamt 9 pro Experiment.
continuousAction

Modell, das eine fortlaufende Aktion darstellt.
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
delayAction

Modell, das eine Verzögerungsaktion darstellt.
discreteAction

Modell, das eine diskrete Aktion darstellt.
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort
experiment

Modell, das eine Experiment-Ressource darstellt.
keyValuePair

Eine Karte zur Beschreibung der Einstellungen einer Aktion.
listSelector

Modell, das eine Listenauswahl darstellt.
ProvisioningState

Der letzte Bereitstellungsstatus für die angegebene Experimentressource.
querySelector

Modell, das eine Abfrageauswahl darstellt.
resourceIdentity

Die Identität einer Ressource.
ResourceIdentityType

Zeichenfolge des Ressourcenidentitätstyps.
simpleFilter

Modell, das einen einfachen Zielfilter darstellt.
simpleFilterParameters

Modell, das die Parameter "Einfacher Filter" darstellt.
step

Modell, das einen Schritt in der Experiment-Ressource darstellt.
systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.
targetReference

Modell, das einen Verweis auf ein Ziel in der Auswahl darstellt.
TargetReferenceType

Enumeration des Zielverweistyps.
UserAssignedIdentity

Benutzer zugewiesene Identitätseigenschaften

branch

Objekt

Modell, das eine Verzweigung im Schritt darstellt. Insgesamt 9 pro Experiment.

Name Typ Beschreibung
actions action[]:

Liste der Aktionen.
name

string

minLength: 1

Zeichenfolge des Verzweigungsnamens.

continuousAction

Objekt

Modell, das eine fortlaufende Aktion darstellt.

Name Typ Beschreibung
duration

string (duration)

pattern: ^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$

ISO8601 formatierte Zeichenfolge, die eine Dauer darstellt.
name

string

maxLength: 2048

Zeichenfolge, die einen Funktions-URN darstellt.
parameters

keyValuePair[]

Liste der Schlüsselwertpaare.
selectorId

string

minLength: 1

Zeichenfolge, die eine Auswahl darstellt.
type string:

continuous

Enumeration, die zwischen Aktionsmodellen diskriminiert.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
Application
Key
ManagedIdentity
User

delayAction

Objekt

Modell, das eine Verzögerungsaktion darstellt.

Name Typ Beschreibung
duration

string (duration)

pattern: ^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$

ISO8601 formatierte Zeichenfolge, die eine Dauer darstellt.
name

string

maxLength: 2048

Zeichenfolge, die einen Funktions-URN darstellt.
type string:

delay

Enumeration, die zwischen Aktionsmodellen diskriminiert.

discreteAction

Objekt

Modell, das eine diskrete Aktion darstellt.

Name Typ Beschreibung
name

string

maxLength: 2048

Zeichenfolge, die einen Funktions-URN darstellt.
parameters

keyValuePair[]

Liste der Schlüsselwertpaare.
selectorId

string

minLength: 1

Zeichenfolge, die eine Auswahl darstellt.
type string:

discrete

Enumeration, die zwischen Aktionsmodellen diskriminiert.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

experiment

Objekt

Modell, das eine Experiment-Ressource darstellt.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

resourceIdentity

Die Identität der Experimentressource.
location

string

Der geografische Standort, an dem sich die Ressource befindet
name

string

Der Name der Ressource
properties.provisioningState

ProvisioningState

Der letzte Bereitstellungsstatus für die angegebene Experimentressource.
properties.selectors selector[]:

Liste der Selektoren.
properties.steps

step[]

Liste der Schritte.
systemData

systemData

Die Systemmetadaten der Experimentressource.
tags

object

Ressourcentags.
type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

keyValuePair

Objekt

Eine Karte zur Beschreibung der Einstellungen einer Aktion.

Name Typ Beschreibung
key

string

minLength: 1

Der Name der Einstellung für die Aktion.
value

string

minLength: 1

Der Wert der Einstellung für die Aktion.

listSelector

Objekt

Modell, das eine Listenauswahl darstellt.

Name Typ Beschreibung
filter filter:

simpleFilter

Modell, das verfügbare Filtertypen darstellt, die auf eine Zielliste angewendet werden können.
id

string

minLength: 1

Zeichenfolge der Selektor-ID.
targets

targetReference[]

Liste der Zielverweise.
type string:

List

Enumeration des Selektortyps.

ProvisioningState

Enumeration

Der letzte Bereitstellungsstatus für die angegebene Experimentressource.

Wert Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded
Updating

querySelector

Objekt

Modell, das eine Abfrageauswahl darstellt.

Name Typ Beschreibung
filter filter:

simpleFilter

Modell, das verfügbare Filtertypen darstellt, die auf eine Zielliste angewendet werden können.
id

string

minLength: 1

Zeichenfolge der Selektor-ID.
queryString

string

Abfragespracheabfrage für Azure Resource Graph (ARG) für Zielressourcen.
subscriptionIds

string[]

Abonnement-ID-Liste zum Bereich der Ressourcenabfrage.
type string:

Query

Enumeration des Selektortyps.

resourceIdentity

Objekt

Die Identität einer Ressource.

Name Typ Beschreibung
principalId

string

pattern: ^[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}$

GUID, die die Prinzipal-ID dieser Ressourcenidentität darstellt.
tenantId

string

pattern: ^[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}$

GUID, die die Mandanten-ID dieser Ressourcenidentität darstellt.
type

ResourceIdentityType

Zeichenfolge des Ressourcenidentitätstyps.
userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned Identitäten
Die Liste der Benutzeridentitäten, die dem Experiment zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ResourceIdentityType

Enumeration

Zeichenfolge des Ressourcenidentitätstyps.

Wert Beschreibung
None
SystemAssigned
UserAssigned

simpleFilter

Objekt

Modell, das einen einfachen Zielfilter darstellt.

Name Typ Beschreibung
parameters

simpleFilterParameters

Modell, das die Parameter "Einfacher Filter" darstellt.
type string:

Simple

Enumeration, die zwischen Filtertypen diskriminiert. Derzeit wird nur Simple Typ unterstützt.

simpleFilterParameters

Objekt

Modell, das die Parameter "Einfacher Filter" darstellt.

Name Typ Beschreibung
zones

string[]

Liste der Azure-Verfügbarkeitszonen zum Filtern von Zielen nach.

step

Objekt

Modell, das einen Schritt in der Experiment-Ressource darstellt.

Name Typ Beschreibung
branches

branch[]

Liste der Verzweigungen.
name

string

minLength: 1

Zeichenfolge des Schrittnamens.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string (date-time)

Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

targetReference

Objekt

Modell, das einen Verweis auf ein Ziel in der Auswahl darstellt.

Name Typ Beschreibung
id

string

pattern: ^\/[Ss][Uu][Bb][Ss][Cc][Rr][Ii][Pp][Tt][Ii][Oo][Nn][Ss]\/[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}\/[Rr][Ee][Ss][Oo][Uu][Rr][Cc][Ee][Gg][Rr][Oo][Uu][Pp][Ss]\/[a-zA-Z0-9_\-\.\(\)]*[a-zA-Z0-9_\-\(\)]\/[Pp][Rr][Oo][Vv][Ii][Dd][Ee][Rr][Ss]\/[a-zA-Z0-9]+\.[a-zA-Z0-9]+\/[a-zA-Z0-9_\-\.]+\/[a-zA-Z0-9_\-\.]+\/[Pp][Rr][Oo][Vv][Ii][Dd][Ee][Rr][Ss]\/[Mm][Ii][Cc][Rr][Oo][Ss][Oo][Ff][Tt]\.[Cc][Hh][Aa][Oo][Ss]\/[Tt][Aa][Rr][Gg][Ee][Tt][Ss]\/[a-zA-Z0-9_\-\.]+$

Zeichenfolge der Ressourcen-ID einer Zielressource.
type

TargetReferenceType

Enumeration des Zielverweistyps.

TargetReferenceType

Enumeration

Enumeration des Zielverweistyps.

Wert Beschreibung
ChaosTarget

UserAssignedIdentity

Objekt

Benutzer zugewiesene Identitätseigenschaften

Name Typ Beschreibung
clientId

string (uuid)

Die Client-ID der zugewiesenen Identität.
principalId

string (uuid)

Die Prinzipal-ID der zugewiesenen Identität.