Share via

Experiments - Create Or Update

  • Referência
Service:
Chaos Studio
API Version:
2024-01-01

Criar ou atualizar um recurso de Experimentação.

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

Parâmetros do URI

Name Em Necessário Tipo Description
experimentName
 path True

string

Cadeia que representa um nome de recurso de Experimentação.

Regex pattern: ^[^<>%&:?#/\\]+$
resourceGroupName
 path True

string

Cadeia que representa um grupo de recursos do Azure.

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

string

GUID que representa um ID de subscrição do Azure.

Regex 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}$
api-version
 query True

string

Cadeia que define a versão da API.

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

Corpo do Pedido

Name Necessário Tipo Description
location True

string

A localização geográfica onde reside o recurso
properties.selectors True selector[]:

Lista de seletores.
properties.steps True

step[]

Lista de passos.
identity

resourceIdentity

A identidade do recurso de experimentação.
tags

object

Etiquetas de recursos.

Respostas

Name Tipo Description
200 OK

experiment

A execução prolongada substitui a operação de experimentação.
201 Created

experiment

Operação de criação de experimentação de execução prolongada.
Other Status Codes

ErrorResponse

Resposta de erro devolvida se o pedido não tiver sido bem-sucedido.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Representar a sua conta de utilizador

Exemplos

Create/update a Experiment in a resource group.

Sample Request

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

Sample Response

Status code:
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
Response Body
{
  "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"
  }
}
Status code:
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
Response Body
{
  "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"
  }
}

Definições

Name Description
branch

Modelo que representa um ramo no passo . 9 no total por experimentação.
continuousAction

Modelo que representa uma ação contínua.
createdByType

O tipo de identidade que criou o recurso.
delayAction

Modelo que representa uma ação de atraso.
discreteAction

Modelo que representa uma ação discreta.
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
experiment

Modelo que representa um recurso de Experimentação.
keyValuePair

Um mapa para descrever as definições de uma ação.
listSelector

Modelo que representa um seletor de lista.
ProvisioningState

O estado de aprovisionamento mais recente do recurso de experimentação especificado.
querySelector

Modelo que representa um seletor de consultas.
resourceIdentity

A identidade de um recurso.
ResourceIdentityType

Cadeia do tipo de identidade do recurso.
simpleFilter

Modelo que representa um filtro de destino simples.
simpleFilterParameters

Modelo que representa os parâmetros de filtro Simples.
step

Modelo que representa um passo no recurso experimentação.
systemData

Metadados relativos à criação e última modificação do recurso.
targetReference

Modelo que representa uma referência a um Destino no seletor.
TargetReferenceType

Enumeração do tipo de referência Destino.
UserAssignedIdentity

Propriedades de identidade atribuídas pelo utilizador

branch

Modelo que representa um ramo no passo . 9 no total por experimentação.

Name Tipo Description
actions action[]:

Lista de ações.
name

string

Cadeia do nome do ramo.

continuousAction

Modelo que representa uma ação contínua.

Name Tipo Description
duration

string

ISO8601 cadeia formatada que representa uma duração.
name

string

Cadeia que representa um URN de Capacidade.
parameters

keyValuePair[]

Lista de pares chave-valor.
selectorId

string

Cadeia que representa um seletor.
type string:

continuous

Enumeração que discrimina entre modelos de ação.

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

delayAction

Modelo que representa uma ação de atraso.

Name Tipo Description
duration

string

ISO8601 cadeia formatada que representa uma duração.
name

string

Cadeia que representa um URN de Capacidade.
type string:

delay

Enumeração que discrimina entre modelos de ação.

discreteAction

Modelo que representa uma ação discreta.

Name Tipo Description
name

string

Cadeia que representa um URN de Capacidade.
parameters

keyValuePair[]

Lista de pares chave-valor.
selectorId

string

Cadeia que representa um seletor.
type string:

discrete

Enumeração que discrimina entre modelos de ação.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

experiment

Modelo que representa um recurso de Experimentação.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

resourceIdentity

A identidade do recurso de experimentação.
location

string

A localização geográfica onde reside o recurso
name

string

O nome do recurso
properties.provisioningState

ProvisioningState

O estado de aprovisionamento mais recente do recurso de experimentação especificado.
properties.selectors selector[]:

Lista de seletores.
properties.steps

step[]

Lista de passos.
systemData

systemData

Os metadados do sistema do recurso de experimentação.
tags

object

Etiquetas de recursos.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

keyValuePair

Um mapa para descrever as definições de uma ação.

Name Tipo Description
key

string

O nome da definição da ação.
value

string

O valor da definição da ação.

listSelector

Modelo que representa um seletor de lista.

Name Tipo Description
filter filter:

simpleFilter

Modelo que representa tipos de filtro disponíveis que podem ser aplicados a uma lista de destinos.
id

string

Cadeia do ID do seletor.
targets

targetReference[]

Lista de Referências de destino.
type string:

List

Enumeração do tipo de seletor.

ProvisioningState

O estado de aprovisionamento mais recente do recurso de experimentação especificado.

Name Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

querySelector

Modelo que representa um seletor de consultas.

Name Tipo Description
filter filter:

simpleFilter

Modelo que representa tipos de filtro disponíveis que podem ser aplicados a uma lista de destinos.
id

string

Cadeia do ID do seletor.
queryString

string

Consulta da Linguagem de Consulta do Azure Resource Graph (ARG) para recursos de destino.
subscriptionIds

string[]

Lista de IDs de subscrição para definir o âmbito da consulta de recursos.
type string:

Query

Enumeração do tipo de seletor.

resourceIdentity

A identidade de um recurso.

Name Tipo Description
principalId

string

GUID que representa o ID principal desta identidade de recurso.
tenantId

string

GUID que representa o ID de inquilino desta identidade de recurso.
type

ResourceIdentityType

Cadeia do tipo de identidade do recurso.
userAssignedIdentities

<string,  UserAssignedIdentity>

Identidades de User-Assigned
A lista de identidades de utilizador associadas à Experimentação. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ResourceIdentityType

Cadeia do tipo de identidade do recurso.

Name Tipo Description
None

string

SystemAssigned

string

UserAssigned

string

simpleFilter

Modelo que representa um filtro de destino simples.

Name Tipo Description
parameters

simpleFilterParameters

Modelo que representa os parâmetros de filtro Simples.
type string:

Simple

Enumeração que discrimina os tipos de filtro. Atualmente, apenas Simple o tipo é suportado.

simpleFilterParameters

Modelo que representa os parâmetros de filtro Simples.

Name Tipo Description
zones

string[]

Lista de zonas de disponibilidade do Azure para filtrar destinos.

step

Modelo que representa um passo no recurso experimentação.

Name Tipo Description
branches

branch[]

Lista de ramos.
name

string

Cadeia do nome do passo.

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

targetReference

Modelo que representa uma referência a um Destino no seletor.

Name Tipo Description
id

string

Cadeia do ID de recurso de um recurso de Destino.
type

TargetReferenceType

Enumeração do tipo de referência Destino.

TargetReferenceType

Enumeração do tipo de referência Destino.

Name Tipo Description
ChaosTarget

string

UserAssignedIdentity

Propriedades de identidade atribuídas pelo utilizador

Name Tipo Description
clientId

string

O ID de cliente da identidade atribuída.
principalId

string

O ID principal da identidade atribuída.