Experiments - Create Or Update

実験リソースを作成または更新します。

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

URI パラメーター

名前 / 必須 説明
experimentName
path True

string

実験リソース名を表す文字列。

正規表現パターン: ^[^<>%&:?#/\\]+$

resourceGroupName
path True

string

Azure リソース グループを表す文字列。

正規表現パターン: ^[a-zA-Z0-9_\-\.\(\)]*[a-zA-Z0-9_\-\(\)]$

subscriptionId
path True

string

Azure サブスクリプション ID を表す GUID。

正規表現パターン: ^[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

API バージョンを設定する文字列。

正規表現パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(|-preview)$

要求本文

名前 必須 説明
location True

string

リソースが保存されている地理的な場所

properties.selectors True selector[]:

セレクターの一覧。

properties.steps True

step[]

手順の一覧。

identity

resourceIdentity

実験リソースの ID。

tags

object

リソース タグ。

応答

名前 説明
200 OK

experiment

実行時間の長い実験の置換操作。

201 Created

experiment

実行時間の長い実験の作成操作。

Other Status Codes

ErrorResponse

要求が失敗した場合に返されるエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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"
          }
        ]
      }
    ]
  }
}

応答のサンプル

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

リソースを作成した ID の種類。

delayAction

遅延アクションを表すモデル。

discreteAction

不連続アクションを表すモデル。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

experiment

実験リソースを表すモデル。

keyValuePair

アクションの設定を記述するマップ。

listSelector

リスト セレクターを表すモデル。

ProvisioningState

指定された実験リソースの最新のプロビジョニング状態。

querySelector

クエリ セレクターを表すモデル。

resourceIdentity

リソースの ID。

ResourceIdentityType

リソース ID の種類の文字列。

simpleFilter

単純なターゲット フィルターを表すモデル。

simpleFilterParameters

単純フィルター パラメーターを表すモデル。

step

実験リソースのステップを表すモデル。

systemData

リソースの作成と最後の変更に関連するメタデータ。

targetReference

セレクター内の Target への参照を表すモデル。

TargetReferenceType

ターゲット参照型の列挙型。

UserAssignedIdentity

ユーザー割り当て ID プロパティ

branch

ステップの分岐を表すモデル。 実験ごとに合計 9。

名前 説明
actions action[]:

アクションの一覧。

name

string

ブランチ名の文字列。

continuousAction

連続アクションを表すモデル。

名前 説明
duration

string

期間を表す書式設定された文字列をISO8601します。

name

string

機能 URN を表す文字列。

parameters

keyValuePair[]

キー値のペアの一覧。

selectorId

string

セレクターを表す文字列。

type string:

continuous

アクション モデルを区別する列挙型。

createdByType

リソースを作成した ID の種類。

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

delayAction

遅延アクションを表すモデル。

名前 説明
duration

string

期間を表す書式設定された文字列をISO8601します。

name

string

機能 URN を表す文字列。

type string:

delay

アクション モデルを区別する列挙型。

discreteAction

不連続アクションを表すモデル。

名前 説明
name

string

機能 URN を表す文字列。

parameters

keyValuePair[]

キー値のペアの一覧。

selectorId

string

セレクターを表す文字列。

type string:

discrete

アクション モデルを区別する列挙型。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

experiment

実験リソースを表すモデル。

名前 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

resourceIdentity

実験リソースの ID。

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

アクションの設定を記述するマップ。

名前 説明
key

string

アクションの設定の名前。

value

string

アクションの設定の値。

listSelector

リスト セレクターを表すモデル。

名前 説明
filter filter:

simpleFilter

ターゲット リストに適用できる使用可能なフィルターの種類を表すモデル。

id

string

セレクター ID の文字列。

targets

targetReference[]

ターゲット参照の一覧。

type string:

List

セレクター型の列挙型。

ProvisioningState

指定された実験リソースの最新のプロビジョニング状態。

名前 説明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

querySelector

クエリ セレクターを表すモデル。

名前 説明
filter filter:

simpleFilter

ターゲット リストに適用できる使用可能なフィルターの種類を表すモデル。

id

string

セレクター ID の文字列。

queryString

string

ターゲット リソースの Azure Resource Graph (ARG) クエリ言語クエリ。

subscriptionIds

string[]

スコープ リソース クエリのサブスクリプション ID リスト。

type string:

Query

セレクター型の列挙型。

resourceIdentity

リソースの ID。

名前 説明
principalId

string

このリソース ID のプリンシパル ID を表す GUID。

tenantId

string

このリソース ID のテナント ID を表す GUID。

type

ResourceIdentityType

リソース ID の種類の文字列。

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned ID
実験に関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。

ResourceIdentityType

リソース ID の種類の文字列。

名前 説明
None

string

SystemAssigned

string

UserAssigned

string

simpleFilter

単純なターゲット フィルターを表すモデル。

名前 説明
parameters

simpleFilterParameters

単純フィルター パラメーターを表すモデル。

type string:

Simple

フィルターの種類を区別する列挙型。 現在、サポートされているのは型のみです Simple

simpleFilterParameters

単純フィルター パラメーターを表すモデル。

名前 説明
zones

string[]

ターゲットをフィルター処理する Azure 可用性ゾーンの一覧。

step

実験リソースのステップを表すモデル。

名前 説明
branches

branch[]

ブランチの一覧。

name

string

ステップ名の文字列。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

targetReference

セレクター内の Target への参照を表すモデル。

名前 説明
id

string

ターゲット リソースのリソース ID の文字列。

type

TargetReferenceType

ターゲット参照型の列挙型。

TargetReferenceType

ターゲット参照型の列挙型。

名前 説明
ChaosTarget

string

UserAssignedIdentity

ユーザー割り当て ID プロパティ

名前 説明
clientId

string

割り当てられた ID のクライアント ID。

principalId

string

割り当てられた ID のプリンシパル ID。