Freigeben über

Experiments - Create Or Update

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

Erstellen oder Aktualisieren einer Experimentressource

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

Zeichenfolge, die einen Experiment-Ressourcennamen darstellt.

RegEx-Muster: ^[^<>%&:?#/\\]+$
resourceGroupName
 path True

string

Zeichenfolge, die eine Azure-Ressourcengruppe darstellt.

RegEx-Muster: ^[a-zA-Z0-9_\-\.\(\)]*[a-zA-Z0-9_\-\(\)]$
subscriptionId
 path True

string

GUID, die eine Azure-Abonnement-ID darstellt.

RegEx-Muster: ^[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

Zeichenfolge, die die API-Version festlegt.

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

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

Ersetzungsexperiment wird mit langer Ausführungsdauer ausgeführt.
201 Created

experiment

Erstellung eines Experimentvorgangs mit langer Ausführungsdauer.
Other Status Codes

ErrorResponse

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

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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 einen Branch 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

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail

Die Fehlerdetails.
ErrorResponse

Fehlerantwort
experiment

Modell, das eine Experimentressource darstellt.
keyValuePair

Eine Karte, um die Einstellungen einer Aktion zu beschreiben.
listSelector

Modell, das eine Listenauswahl darstellt.
ProvisioningState

Der neueste 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 Einfachen Filterparameter darstellt.
step

Modell, das einen Schritt in der Experimentressource darstellt.
systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
targetReference

Modell, das einen Verweis auf ein Ziel im Selektor darstellt.
TargetReferenceType

Enumeration des Zielverweistyps.
UserAssignedIdentity

Benutzerseitig zugewiesene Identitätseigenschaften

branch

Modell, das einen Branch im Schritt darstellt. Insgesamt 9 pro Experiment.

Name Typ Beschreibung
actions action[]:

Liste der Aktionen.
name

string

Zeichenfolge des Branchnamens.

continuousAction

Modell, das eine fortlaufende Aktion darstellt.

Name Typ Beschreibung
duration

string

ISO8601 formatierte Zeichenfolge, die eine Dauer darstellt.
name

string

Zeichenfolge, die einen Funktions-URN darstellt.
parameters

keyValuePair[]

Liste der Schlüsselwertpaare.
selectorId

string

Zeichenfolge, die einen Selektor darstellt.
type string:

continuous

Aufzählung, die zwischen Aktionsmodellen diskriminiert.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

delayAction

Modell, das eine Verzögerungsaktion darstellt.

Name Typ Beschreibung
duration

string

ISO8601 formatierte Zeichenfolge, die eine Dauer darstellt.
name

string

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

delay

Aufzählung, die zwischen Aktionsmodellen diskriminiert.

discreteAction

Modell, das eine diskrete Aktion darstellt.

Name Typ Beschreibung
name

string

Zeichenfolge, die einen Funktions-URN darstellt.
parameters

keyValuePair[]

Liste der Schlüsselwertpaare.
selectorId

string

Zeichenfolge, die einen Selektor darstellt.
type string:

discrete

Aufzählung, die zwischen Aktionsmodellen diskriminiert.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.
type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

experiment

Modell, das eine Experimentressource darstellt.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /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 neueste 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

Eine Karte, um die Einstellungen einer Aktion zu beschreiben.

Name Typ Beschreibung
key

string

Der Name der Einstellung für die Aktion.
value

string

Der Wert der Einstellung für die Aktion.

listSelector

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

Zeichenfolge der Selektor-ID.
targets

targetReference[]

Liste der Zielverweise.
type string:

List

Enumeration des Selektortyps.

ProvisioningState

Der neueste Bereitstellungsstatus für die angegebene Experimentressource.

Name Typ Beschreibung
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

querySelector

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

Zeichenfolge der Selektor-ID.
queryString

string

Azure Resource Graph (ARG) Query Language-Abfrage für Zielressourcen.
subscriptionIds

string[]

Abonnement-ID-Liste für die Ressourcenabfrage.
type string:

Query

Enumeration des Selektortyps.

resourceIdentity

Die Identität einer Ressource.

Name Typ Beschreibung
principalId

string

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

string

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. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ResourceIdentityType

Zeichenfolge des Ressourcenidentitätstyps.

Name Typ Beschreibung
None

string

SystemAssigned

string

UserAssigned

string

simpleFilter

Modell, das einen einfachen Zielfilter darstellt.

Name Typ Beschreibung
parameters

simpleFilterParameters

Modell, das die Einfachen Filterparameter darstellt.
type string:

Simple

Aufzählung, die zwischen Filtertypen diskriminiert. Derzeit wird nur Simple typ unterstützt.

simpleFilterParameters

Modell, das die Einfachen Filterparameter darstellt.

Name Typ Beschreibung
zones

string[]

Liste der Azure-Verfügbarkeitszonen, nach der Ziele gefiltert werden sollen.

step

Modell, das einen Schritt in der Experimentressource darstellt.

Name Typ Beschreibung
branches

branch[]

Liste der Verzweigungen.
name

string

Zeichenfolge des Schrittnamens.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

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

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

Modell, das einen Verweis auf ein Ziel im Selektor darstellt.

Name Typ Beschreibung
id

string

Zeichenfolge der Ressourcen-ID einer Zielressource.
type

TargetReferenceType

Enumeration des Zielverweistyps.

TargetReferenceType

Enumeration des Zielverweistyps.

Name Typ Beschreibung
ChaosTarget

string

UserAssignedIdentity

Benutzerseitig zugewiesene Identitätseigenschaften

Name Typ Beschreibung
clientId

string

Die Client-ID der zugewiesenen Identität.
principalId

string

Die Prinzipal-ID der zugewiesenen Identität.