通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Experiments - Create Or Update

  • 参考
服务:
Chaos Studio
API 版本:
2024-01-01

创建或更新试验资源。

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

URI 参数

名称 在 必需 类型 说明
experimentName
 path True

string

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

表示试验资源名称的字符串。
resourceGroupName
 path True

string

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

表示 Azure 资源组的字符串。
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}$

表示 Azure 订阅 ID 的 GUID。
api-version
 query True

string

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

设置 API 版本的字符串。

请求正文

名称 必需 类型 说明
location True

string

资源所在的地理位置
properties.selectors True selector[]:

选择器列表。
properties.steps True

step[]

步骤列表。
identity

resourceIdentity

试验资源的标识。
tags

object

资源标记。

响应

名称 类型 说明
200 OK

experiment

长时间运行的替换试验作。
201 Created

experiment

长时间运行的创建试验作。
Other Status Codes

ErrorResponse

如果请求失败，则返回错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Create/update a Experiment in a resource group.

示例请求

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

示例响应

状态代码:
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"
  }
}
状态代码:
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"
  }
}

定义

名称 说明
branch

表示步骤中的分支的模型。 每个试验总共 9 个。
continuousAction

表示连续作的模型。
createdByType

创建资源的标识的类型。
delayAction

表示延迟操作的模型。
discreteAction

表示离散操作的模型。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
experiment

表示试验资源的模型。
keyValuePair

描述作设置的映射。
listSelector

表示列表选择器的模型。
ProvisioningState

给定试验资源的最新预配状态。
querySelector

表示查询选择器的模型。
resourceIdentity

资源的标识。
ResourceIdentityType

资源标识类型的字符串。
simpleFilter

表示简单目标筛选器的模型。
simpleFilterParameters

表示简单筛选器参数的模型。
step

表示试验资源中的步骤的模型。
systemData

与创建和上次修改资源相关的元数据。
targetReference

表示对选择器中目标的引用的模型。
TargetReferenceType

目标引用类型的枚举。
UserAssignedIdentity

用户分配的标识属性

branch

Object

表示步骤中的分支的模型。 每个试验总共 9 个。

名称 类型 说明
actions action[]:

操作列表。
name

string

minLength: 1

分支名称的字符串。

continuousAction

Object

表示连续作的模型。

名称 类型 说明
duration

string (duration)

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

ISO8601表示持续时间的格式化字符串。
name

string

maxLength: 2048

表示功能 URN 的字符串。
parameters

keyValuePair[]

键值对列表。
selectorId

string

minLength: 1

表示选择器的字符串。
type string:

continuous

区分操作模型的枚举。

createdByType

枚举

创建资源的标识的类型。

值 说明
Application
Key
ManagedIdentity
User

delayAction

Object

表示延迟操作的模型。

名称 类型 说明
duration

string (duration)

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

ISO8601表示持续时间的格式化字符串。
name

string

maxLength: 2048

表示功能 URN 的字符串。
type string:

delay

区分操作模型的枚举。

discreteAction

Object

表示离散操作的模型。

名称 类型 说明
name

string

maxLength: 2048

表示功能 URN 的字符串。
parameters

keyValuePair[]

键值对列表。
selectorId

string

minLength: 1

表示选择器的字符串。
type string:

discrete

区分操作模型的枚举。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

experiment

Object

表示试验资源的模型。

名称 类型 说明
id

string

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

resourceIdentity

试验资源的标识。
location

string

资源所在的地理位置
name

string

资源的名称
properties.provisioningState

ProvisioningState

给定试验资源的最新预配状态。
properties.selectors selector[]:

选择器列表。
properties.steps

step[]

步骤列表。
systemData

systemData

试验资源的系统元数据。
tags

object

资源标记。
type

string

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

keyValuePair

Object

描述作设置的映射。

名称 类型 说明
key

string

minLength: 1

操作的设置的名称。
value

string

minLength: 1

操作设置的值。

listSelector

Object

表示列表选择器的模型。

名称 类型 说明
filter filter:

simpleFilter

表示可应用于目标列表的可用筛选器类型的模型。
id

string

minLength: 1

选择器 ID 的字符串。
targets

targetReference[]

目标引用列表。
type string:

List

选择器类型的枚举。

ProvisioningState

枚举

给定试验资源的最新预配状态。

值 说明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

querySelector

Object

表示查询选择器的模型。

名称 类型 说明
filter filter:

simpleFilter

表示可应用于目标列表的可用筛选器类型的模型。
id

string

minLength: 1

选择器 ID 的字符串。
queryString

string

针对目标资源的 Azure Resource Graph （ARG） 查询语言查询。
subscriptionIds

string[]

用于限定资源查询范围的订阅 ID 列表。
type string:

Query

选择器类型的枚举。

resourceIdentity

Object

资源的标识。

名称 类型 说明
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}$

表示此资源标识的主体 ID 的 GUID。
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}$

表示此资源标识的租户 ID 的 GUID。
type

ResourceIdentityType

资源标识类型的字符串。
userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned 标识
与试验关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

ResourceIdentityType

枚举

资源标识类型的字符串。

值 说明
None
SystemAssigned
UserAssigned

simpleFilter

Object

表示简单目标筛选器的模型。

名称 类型 说明
parameters

simpleFilterParameters

表示简单筛选器参数的模型。
type string:

Simple

区分筛选器类型的枚举。 目前仅支持 Simple 类型。

simpleFilterParameters

Object

表示简单筛选器参数的模型。

名称 类型 说明
zones

string[]

要按其筛选目标的 Azure 可用性区域列表。

step

Object

表示试验资源中的步骤的模型。

名称 类型 说明
branches

branch[]

分支列表。
name

string

minLength: 1

步骤名称的字符串。

systemData

Object

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳（UTC）。
createdBy

string

创建资源的标识。
createdByType

createdByType

创建资源的标识的类型。
lastModifiedAt

string (date-time)

上次修改的资源时间戳（UTC）
lastModifiedBy

string

上次修改资源的标识。
lastModifiedByType

createdByType

上次修改资源的标识的类型。

targetReference

Object

表示对选择器中目标的引用的模型。

名称 类型 说明
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_\-\.]+$

目标资源的资源 ID 的字符串。
type

TargetReferenceType

目标引用类型的枚举。

TargetReferenceType

枚举

目标引用类型的枚举。

值 说明
ChaosTarget

UserAssignedIdentity

Object

用户分配的标识属性

名称 类型 说明
clientId

string (uuid)

分配的标识的客户端 ID。
principalId

string (uuid)

已分配标识的主体 ID。