{ "swagger": "2.0", "info": { "title": "ChaosManagementClient", "version": "2026-11-01", "description": "Chaos Management Client", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Capabilities" }, { "name": "Operations" }, { "name": "Targets" }, { "name": "CapabilityTypes" }, { "name": "Experiments" }, { "name": "ExperimentExecutions" }, { "name": "Actions" }, { "name": "ActionVersions" }, { "name": "TargetTypes" }, { "name": "OperationStatuses" }, { "name": "Workspaces" }, { "name": "WorkspaceDiscoveries" }, { "name": "WorkspaceEvaluations" }, { "name": "DiscoveredResources" }, { "name": "Scenarios" }, { "name": "ScenarioTemplates" }, { "name": "ScenarioTemplateVersions" }, { "name": "ScenarioConfigurations" }, { "name": "ScenarioRuns" }, { "name": "Connections" } ], "paths": { "/providers/Microsoft.Chaos/operations": { "get": { "operationId": "Operations_ListAll", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Lists all Chaos Studio operations.": { "$ref": "./examples/Operations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Chaos/scenarioTemplates": { "get": { "operationId": "ScenarioTemplates_List", "tags": [ "ScenarioTemplates" ], "description": "Get a list of the scenario templates published by Microsoft.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ScenarioTemplateListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List the built-in scenario templates.": { "$ref": "./examples/ScenarioTemplates_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Chaos/scenarioTemplates/{scenarioTemplateName}": { "get": { "operationId": "ScenarioTemplates_Get", "tags": [ "ScenarioTemplates" ], "description": "Get a scenario template, described by its newest published version.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "scenarioTemplateName", "in": "path", "description": "Name of the scenario template.", "required": true, "type": "string", "minLength": 1, "pattern": "^[A-Za-z0-9\\-._~]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScenarioTemplate" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the latest version of a built-in scenario template.": { "$ref": "./examples/ScenarioTemplates_Get.json" } } } }, "/providers/Microsoft.Chaos/scenarioTemplates/{scenarioTemplateName}/versions": { "get": { "operationId": "ScenarioTemplateVersions_List", "tags": [ "ScenarioTemplateVersions" ], "description": "Get a list of the published versions of a scenario template, including superseded ones.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "scenarioTemplateName", "in": "path", "description": "Name of the scenario template.", "required": true, "type": "string", "minLength": 1, "pattern": "^[A-Za-z0-9\\-._~]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ScenarioTemplateVersionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List the published versions of a built-in scenario template.": { "$ref": "./examples/ScenarioTemplateVersions_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Chaos/scenarioTemplates/{scenarioTemplateName}/versions/{version}": { "get": { "operationId": "ScenarioTemplateVersions_Get", "tags": [ "ScenarioTemplateVersions" ], "description": "Get a single published version of a scenario template.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "scenarioTemplateName", "in": "path", "description": "Name of the scenario template.", "required": true, "type": "string", "minLength": 1, "pattern": "^[A-Za-z0-9\\-._~]+$" }, { "name": "version", "in": "path", "description": "The version of the scenario template, for example 1.2.", "required": true, "type": "string", "minLength": 1, "pattern": "^[A-Za-z0-9\\-._~]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScenarioTemplateVersion" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a specific version of a built-in scenario template.": { "$ref": "./examples/ScenarioTemplateVersions_Get.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/experiments": { "get": { "operationId": "Experiments_ListAll", "tags": [ "Experiments" ], "description": "Get a list of Experiment resources in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "running", "in": "query", "description": "Optional value that indicates whether to filter results based on if the Experiment is currently running. If null, then the results will not be filtered.", "required": false, "type": "boolean" }, { "name": "continuationToken", "in": "query", "description": "String that sets the continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExperimentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all Experiments in a subscription.": { "$ref": "./examples/Experiments_ListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/actions": { "get": { "operationId": "Actions_List", "tags": [ "Actions" ], "description": "Get a list of Action resources for a given location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { "name": "continuationToken", "in": "query", "description": "String that sets the continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ActionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all Actions for westus2 location.": { "$ref": "./examples/Actions_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/actions/{actionName}": { "get": { "operationId": "Actions_Get", "tags": [ "Actions" ], "description": "Get an Action resource for a given location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { "name": "actionName", "in": "path", "description": "String that represents an Action resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9\\-]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Action" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an Action for westus2 location": { "$ref": "./examples/Actions_Get.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/actions/{actionName}/versions": { "get": { "operationId": "ActionVersions_List", "tags": [ "ActionVersions" ], "description": "Get a list of Action Version resources for a given location and action.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { "name": "actionName", "in": "path", "description": "String that represents an Action resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9\\-]+$" }, { "name": "continuationToken", "in": "query", "description": "String that sets the continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ActionVersionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all Action Versions for a given action.": { "$ref": "./examples/ActionVersions_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/actions/{actionName}/versions/{versionName}": { "get": { "operationId": "ActionVersions_Get", "tags": [ "ActionVersions" ], "description": "Get an Action Version resource for a given location and action.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { "name": "actionName", "in": "path", "description": "String that represents an Action resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9\\-]+$" }, { "name": "versionName", "in": "path", "description": "String that represents an Action Version resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ActionVersion" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an Action Version for westus2 location": { "$ref": "./examples/ActionVersions_Get.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/operationStatuses/{operationId}": { "get": { "operationId": "OperationStatuses_Get", "tags": [ "OperationStatuses" ], "description": "Returns the current status of an async operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/OperationIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationStatusResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a failed Workspace encryption operation status": { "$ref": "./examples/OperationStatuses_Get_CustomerKeyAccessFailed.json" }, "Gets Chaos Studio async operation status.": { "$ref": "./examples/OperationStatuses_Get.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/targetTypes": { "get": { "operationId": "TargetTypes_List", "tags": [ "TargetTypes" ], "description": "Get a list of Target Type resources for given location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { "name": "continuationToken", "in": "query", "description": "String that sets the continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TargetTypeListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all Target Types for westus2 location.": { "$ref": "./examples/TargetTypes_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/targetTypes/{targetTypeName}": { "get": { "operationId": "TargetTypes_Get", "tags": [ "TargetTypes" ], "description": "Get a Target Type resources for given location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { "name": "targetTypeName", "in": "path", "description": "String that represents a Target Type resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TargetType" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a Target Type for westus2 location": { "$ref": "./examples/TargetTypes_Get.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/targetTypes/{targetTypeName}/capabilityTypes": { "get": { "operationId": "CapabilityTypes_List", "tags": [ "CapabilityTypes" ], "description": "Get a list of Capability Type resources for given Target Type and location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { "name": "targetTypeName", "in": "path", "description": "String that represents a Target Type resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "continuationToken", "in": "query", "description": "String that sets the continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/CapabilityTypeListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all Capability Types for a virtual machine Target resource on westus2 location.": { "$ref": "./examples/CapabilityTypes_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/locations/{location}/targetTypes/{targetTypeName}/capabilityTypes/{capabilityTypeName}": { "get": { "operationId": "CapabilityTypes_Get", "tags": [ "CapabilityTypes" ], "description": "Get a Capability Type resource for given Target Type and location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { "name": "targetTypeName", "in": "path", "description": "String that represents a Target Type resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "capabilityTypeName", "in": "path", "description": "String that represents a Capability Type resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9\\-\\.]+-\\d\\.\\d$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/CapabilityType" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a Capability Type for a virtual machine Target resource on westus2 location.": { "$ref": "./examples/CapabilityTypes_Get.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Chaos/workspaces": { "get": { "operationId": "Workspaces_ListAll", "tags": [ "Workspaces" ], "description": "Get a list of all Workspace resources in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "continuationToken", "in": "query", "description": "String that sets the continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/WorkspaceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all Workspaces in a subscription.": { "$ref": "./examples/Workspaces_ListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets": { "get": { "operationId": "Targets_List", "tags": [ "Targets" ], "description": "Get a list of Target resources that extend a tracked regional resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "parentProviderNamespace", "in": "path", "description": "The parent resource provider namespace.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceType", "in": "path", "description": "The parent resource type.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceName", "in": "path", "description": "The parent resource name.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "continuationToken", "in": "query", "description": "String that sets the continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TargetListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all Targets that extend a virtual machine resource.": { "$ref": "./examples/Targets_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}": { "get": { "operationId": "Targets_Get", "tags": [ "Targets" ], "description": "Get a Target resource that extends a tracked regional resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "parentProviderNamespace", "in": "path", "description": "The parent resource provider namespace.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceType", "in": "path", "description": "The parent resource type.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceName", "in": "path", "description": "The parent resource name.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "targetName", "in": "path", "description": "String that represents a Target resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Target" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a Target that extends a virtual machine resource.": { "$ref": "./examples/Targets_Get.json" } } }, "put": { "operationId": "Targets_CreateOrUpdate", "tags": [ "Targets" ], "description": "Create or update a Target resource that extends a tracked regional resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "parentProviderNamespace", "in": "path", "description": "The parent resource provider namespace.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceType", "in": "path", "description": "The parent resource type.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceName", "in": "path", "description": "The parent resource name.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "targetName", "in": "path", "description": "String that represents a Target resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "resource", "in": "body", "description": "Target resource to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/Target" } } ], "responses": { "200": { "description": "Resource 'Target' update operation succeeded", "schema": { "$ref": "#/definitions/Target" } }, "201": { "description": "Resource 'Target' create operation succeeded", "schema": { "$ref": "#/definitions/Target" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create/update a Target that extends a virtual machine resource.": { "$ref": "./examples/Targets_CreateOrUpdate.json" } } }, "delete": { "operationId": "Targets_Delete", "tags": [ "Targets" ], "description": "Delete a Target resource that extends a tracked regional resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "parentProviderNamespace", "in": "path", "description": "The parent resource provider namespace.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceType", "in": "path", "description": "The parent resource type.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceName", "in": "path", "description": "The parent resource name.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "targetName", "in": "path", "description": "String that represents a Target resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a Target that extends a virtual machine resource.": { "$ref": "./examples/Targets_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities": { "get": { "operationId": "Capabilities_List", "tags": [ "Capabilities" ], "description": "Get a list of Capability resources that extend a Target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "parentProviderNamespace", "in": "path", "description": "The parent resource provider namespace.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceType", "in": "path", "description": "The parent resource type.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceName", "in": "path", "description": "The parent resource name.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "continuationToken", "in": "query", "description": "String that sets the continuation token.", "required": false, "type": "string" }, { "name": "targetName", "in": "path", "description": "String that represents a Target resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/CapabilityListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all Capabilities that extend a virtual machine Target resource.": { "$ref": "./examples/Capabilities_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{parentProviderNamespace}/{parentResourceType}/{parentResourceName}/providers/Microsoft.Chaos/targets/{targetName}/capabilities/{capabilityName}": { "get": { "operationId": "Capabilities_Get", "tags": [ "Capabilities" ], "description": "Get a Capability resource that extends a Target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "parentProviderNamespace", "in": "path", "description": "The parent resource provider namespace.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceType", "in": "path", "description": "The parent resource type.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceName", "in": "path", "description": "The parent resource name.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "targetName", "in": "path", "description": "String that represents a Target resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "capabilityName", "in": "path", "description": "String that represents a Capability resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9\\-\\.]+-\\d\\.\\d$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Capability" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a Capability that extends a virtual machine Target resource.": { "$ref": "./examples/Capabilities_Get.json" } } }, "put": { "operationId": "Capabilities_CreateOrUpdate", "tags": [ "Capabilities" ], "description": "Create or update a Capability resource that extends a Target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "parentProviderNamespace", "in": "path", "description": "The parent resource provider namespace.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceType", "in": "path", "description": "The parent resource type.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceName", "in": "path", "description": "The parent resource name.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "targetName", "in": "path", "description": "String that represents a Target resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "capabilityName", "in": "path", "description": "String that represents a Capability resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9\\-\\.]+-\\d\\.\\d$" }, { "name": "resource", "in": "body", "description": "Capability resource to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/Capability" } } ], "responses": { "200": { "description": "Resource 'Capability' update operation succeeded", "schema": { "$ref": "#/definitions/Capability" } }, "201": { "description": "Resource 'Capability' create operation succeeded", "schema": { "$ref": "#/definitions/Capability" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create/update a Capability that extends a virtual machine Target resource.": { "$ref": "./examples/Capabilities_CreateOrUpdate.json" } } }, "delete": { "operationId": "Capabilities_Delete", "tags": [ "Capabilities" ], "description": "Delete a Capability that extends a Target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "parentProviderNamespace", "in": "path", "description": "The parent resource provider namespace.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceType", "in": "path", "description": "The parent resource type.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "parentResourceName", "in": "path", "description": "The parent resource name.", "required": true, "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" }, { "name": "targetName", "in": "path", "description": "String that represents a Target resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_\\-\\.]+$" }, { "name": "capabilityName", "in": "path", "description": "String that represents a Capability resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9\\-\\.]+-\\d\\.\\d$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a Capability that extends a virtual machine Target resource.": { "$ref": "./examples/Capabilities_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments": { "get": { "operationId": "Experiments_List", "tags": [ "Experiments" ], "description": "Get a list of Experiment resources in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "running", "in": "query", "description": "Optional value that indicates whether to filter results based on if the Experiment is currently running. If null, then the results will not be filtered.", "required": false, "type": "boolean" }, { "name": "continuationToken", "in": "query", "description": "String that sets the continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExperimentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all Experiments in a resource group.": { "$ref": "./examples/Experiments_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}": { "get": { "operationId": "Experiments_Get", "tags": [ "Experiments" ], "description": "Get a Experiment resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "experimentName", "in": "path", "description": "String that represents a Experiment resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Experiment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a Experiment in a resource group.": { "$ref": "./examples/Experiments_Get.json" } } }, "put": { "operationId": "Experiments_CreateOrUpdate", "tags": [ "Experiments" ], "description": "Create or update a Experiment resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "experimentName", "in": "path", "description": "String that represents a Experiment resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "resource", "in": "body", "description": "Experiment resource to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/Experiment" } } ], "responses": { "200": { "description": "Resource 'Experiment' update operation succeeded", "schema": { "$ref": "#/definitions/Experiment" } }, "201": { "description": "Resource 'Experiment' create operation succeeded", "schema": { "$ref": "#/definitions/Experiment" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create/update a Experiment in a resource group.": { "$ref": "./examples/Experiments_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Experiments_Update", "tags": [ "Experiments" ], "description": "Update an experiment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "experimentName", "in": "path", "description": "String that represents a Experiment resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "properties", "in": "body", "description": "Parameters supplied to the Update experiment operation.", "required": true, "schema": { "$ref": "#/definitions/ExperimentUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Experiment" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an Experiment in a resource group.": { "$ref": "./examples/Experiments_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Experiments_Delete", "tags": [ "Experiments" ], "description": "Delete a Experiment resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "experimentName", "in": "path", "description": "String that represents a Experiment resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a Experiment in a resource group.": { "$ref": "./examples/Experiments_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/cancel": { "post": { "operationId": "Experiments_Cancel", "tags": [ "Experiments" ], "description": "Cancel a running Experiment resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "experimentName", "in": "path", "description": "String that represents a Experiment resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Cancel a running Experiment.": { "$ref": "./examples/Experiments_Cancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions": { "get": { "operationId": "Experiments_ListAllExecutions", "tags": [ "ExperimentExecutions" ], "description": "Get a list of executions of an Experiment resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "experimentName", "in": "path", "description": "String that represents a Experiment resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExperimentExecutionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all executions of an Experiment.": { "$ref": "./examples/Experiments_ListAllExecutions.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions/{executionId}": { "get": { "operationId": "Experiments_GetExecution", "tags": [ "ExperimentExecutions" ], "description": "Get an execution of an Experiment resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "experimentName", "in": "path", "description": "String that represents a Experiment resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "executionId", "in": "path", "description": "GUID that represents a Experiment execution detail.", "required": true, "type": "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}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExperimentExecution" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the execution of a Experiment.": { "$ref": "./examples/Experiments_GetExecution.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/executions/{executionId}/getExecutionDetails": { "post": { "operationId": "Experiments_ExecutionDetails", "tags": [ "ExperimentExecutions" ], "description": "Execution details of an experiment resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "experimentName", "in": "path", "description": "String that represents a Experiment resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "executionId", "in": "path", "description": "GUID that represents a Experiment execution detail.", "required": true, "type": "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}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExperimentExecutionDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get experiment execution details.": { "$ref": "./examples/Experiments_ExecutionDetails.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/start": { "post": { "operationId": "Experiments_Start", "tags": [ "Experiments" ], "description": "Start a Experiment resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "experimentName", "in": "path", "description": "String that represents a Experiment resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Start a Experiment.": { "$ref": "./examples/Experiments_Start.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces": { "get": { "operationId": "Workspaces_List", "tags": [ "Workspaces" ], "description": "Get a list of Workspace resources in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "continuationToken", "in": "query", "description": "String that sets the continuation token.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/WorkspaceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List CMK-created Workspaces with customer key replacement pending": { "$ref": "./examples/Workspaces_List_EncryptionPending.json" }, "List all Workspaces in a resource group.": { "$ref": "./examples/Workspaces_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}": { "get": { "operationId": "Workspaces_Get", "tags": [ "Workspaces" ], "description": "Get a Workspace resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Workspace" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a CMK-created Workspace while its customer key is being replaced": { "$ref": "./examples/Workspaces_Get_EncryptionPending.json" }, "Get a Workspace after a customer key replacement fails": { "$ref": "./examples/Workspaces_Get_EncryptionFailed.json" }, "Get a Workspace in a resource group.": { "$ref": "./examples/Workspaces_Get.json" }, "Get a Workspace service application before customer key enrollment": { "$ref": "./examples/Workspaces_Get_EncryptionNotConfigured.json" }, "Get a Workspace when active encryption protection is unknown": { "$ref": "./examples/Workspaces_Get_EncryptionUnknown.json" } } }, "put": { "operationId": "Workspaces_CreateOrUpdate", "tags": [ "Workspaces" ], "description": "Create or update a Workspace resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "$ref": "#/parameters/PutPreconditionHeaders.ifNoneMatch" }, { "$ref": "#/parameters/PutPreconditionHeaders.ifMatch" }, { "name": "resource", "in": "body", "description": "Workspace resource to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/Workspace" } } ], "responses": { "200": { "description": "Resource 'Workspace' update operation succeeded", "schema": { "$ref": "#/definitions/Workspace" } }, "201": { "description": "Resource 'Workspace' create operation succeeded", "schema": { "$ref": "#/definitions/Workspace" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a workspace only when absent, or return 412 when it already exists": { "$ref": "./examples/Workspaces_CreateOrUpdate_CreateOnly.json" }, "Create or update a Microsoft-managed Workspace with empty encryption settings": { "$ref": "./examples/Workspaces_CreateOrUpdate_EmptyEncryption.json" }, "Create or update a Microsoft-managed Workspace without encryption settings": { "$ref": "./examples/Workspaces_CreateOrUpdate_OmitEncryption.json" }, "Create or update a Workspace with a customer-managed key": { "$ref": "./examples/Workspaces_CreateOrUpdate_WithCustomerKey.json" }, "Create/update a workspace in a resource group.": { "$ref": "./examples/Workspaces_CreateOrUpdate.json" }, "Update a workspace only when present, or return 412 when it does not exist": { "$ref": "./examples/Workspaces_CreateOrUpdate_UpdateOnly.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Workspaces_Update", "tags": [ "Workspaces" ], "description": "Update a Workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "properties", "in": "body", "description": "Parameters supplied to the Update Workspace operation.", "required": true, "schema": { "$ref": "#/definitions/WorkspaceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Workspace" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update Workspace tags without changing customer-managed encryption": { "$ref": "./examples/Workspaces_Update_OmitEncryption.json" }, "Update a Workspace in a resource group.": { "$ref": "./examples/Workspaces_Update.json" }, "Update a Workspace with a validated key and resource ID in another vault": { "$ref": "./examples/Workspaces_Update_ChangeKeyVault.json" }, "Update a Workspace with an empty CMK patch and retain its existing key URL": { "$ref": "./examples/Workspaces_Update_EmptyCustomerKeyPatch.json" }, "Update only the customer key URI of an encrypted Workspace": { "$ref": "./examples/Workspaces_Update_ReplaceCustomerKey.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Workspaces_Delete", "tags": [ "Workspaces" ], "description": "Delete a Workspace resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a Workspace in a resource group.": { "$ref": "./examples/Workspaces_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/connections": { "get": { "operationId": "Connections_ListAll", "tags": [ "Connections" ], "description": "Get a list of connections.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of connections.": { "$ref": "./examples/Connections_ListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/connections/{connectionName}": { "get": { "operationId": "Connections_Get", "tags": [ "Connections" ], "description": "Get a connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "connectionName", "in": "path", "description": "Name of the connection.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Connection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a connection.": { "$ref": "./examples/Connections_Get.json" } } }, "put": { "operationId": "Connections_CreateOrUpdate", "tags": [ "Connections" ], "description": "Create or update a connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "connectionName", "in": "path", "description": "Name of the connection.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "resource", "in": "body", "description": "Connection resource to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/Connection" } } ], "responses": { "200": { "description": "Resource 'Connection' update operation succeeded", "schema": { "$ref": "#/definitions/Connection" } }, "201": { "description": "Resource 'Connection' create operation succeeded", "schema": { "$ref": "#/definitions/Connection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a connection.": { "$ref": "./examples/Connections_CreateOrUpdate.json" } } }, "delete": { "operationId": "Connections_Delete", "tags": [ "Connections" ], "description": "Delete a connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "connectionName", "in": "path", "description": "Name of the connection.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a connection in a workspace.": { "$ref": "./examples/Connections_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/discover": { "post": { "operationId": "Workspaces_Discover", "tags": [ "Workspaces" ], "description": "Starts discovery for the workspace. The initial 202 has no body. Poll the operation-bound Location URL until completion: a successful or partially successful discovery returns the typed result; failed or canceled processing returns an Azure error whose target identifies the discovery resource. Ordinary discovery reads return the current resource, including failed or canceled results, while retained.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceDiscovery" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Trigger resource discovery for the workspace.": { "$ref": "./examples/Workspaces_Discover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/discoveredResources": { "get": { "operationId": "DiscoveredResources_ListByWorkspace", "tags": [ "DiscoveredResources" ], "description": "Get a list of discovered resources for a workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DiscoveredResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of discovered resources for a workspace.": { "$ref": "./examples/DiscoveredResources_ListByWorkspace.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/discoveredResources/{discoveredResourceName}": { "get": { "operationId": "DiscoveredResources_Get", "tags": [ "DiscoveredResources" ], "description": "Get a discovered resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "discoveredResourceName", "in": "path", "description": "Name of the discovered resource.", "required": true, "type": "string", "minLength": 1, "pattern": "^[a-zA-Z0-9-]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DiscoveredResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a discovered resource.": { "$ref": "./examples/DiscoveredResources_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/discoveries": { "get": { "operationId": "WorkspaceDiscoveries_List", "tags": [ "WorkspaceDiscoveries" ], "description": "Lists retained discovery results under the workspace. Each result has its canonical ID; latest is an alias and is not a separate collection entry. This operation does not extend result retention.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "continuationToken", "in": "query", "description": "Opaque continuation token supplied by the returned nextLink.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceDiscoveryListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List retained workspace discoveries using canonical IDs and an opaque nextLink.": { "$ref": "./examples/WorkspaceDiscoveries_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/discoveries/{discoveryName}": { "get": { "operationId": "WorkspaceDiscoveries_Get", "tags": [ "WorkspaceDiscoveries" ], "description": "Gets a retained discovery result by its ID, or uses latest to select the most recently durably admitted discovery. Returns 200 with the current representation while processing or terminal. A Failed result can contain errors without a snapshot. Returns 404 if no qualifying retained result exists. This is not an LRO polling endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "discoveryName", "in": "path", "description": "The service-generated discovery result ID. Use latest in the request path for the most recently durably admitted discovery; responses contain the canonical result ID.", "required": true, "type": "string", "pattern": "^(latest|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceDiscovery" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a healthy container scan with a structurally unknown inventory denominator.": { "$ref": "./examples/WorkspaceDiscoveries_Get_BaselineUnknown.json" }, "Get a partially succeeded result with classified guidance, system uncertainty, and a truncated warning sample.": { "$ref": "./examples/WorkspaceDiscoveries_Get_PartialMixed.json" }, "Get a terminal failed discovery without an accepted inventory result.": { "$ref": "./examples/WorkspaceDiscoveries_Get_Failed.json" }, "Get an established discovery result with a known resource population.": { "$ref": "./examples/WorkspaceDiscoveries_Get_Established.json" }, "Get an established discovery result with an authoritatively empty expected set.": { "$ref": "./examples/WorkspaceDiscoveries_Get_KnownEmpty.json" }, "Read a running discovery with HTTP 200 without inventing accepted coverage.": { "$ref": "./examples/WorkspaceDiscoveries_Get_InProgress.json" }, "Read latest as an alias while returning the canonical discovery identity.": { "$ref": "./examples/WorkspaceDiscoveries_Get_Latest.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/evaluate": { "post": { "operationId": "Workspaces_Evaluate", "tags": [ "Workspaces" ], "description": "Starts evaluation of published scenario-template versions, including when the workspace has no scenarios. Acceptance fixes the selected template membership and total count, qualified resource snapshot and canonical discovery result reference. Without a usable discovery snapshot or valid catalog input, the request is rejected synchronously with an Azure error and no evaluation result is created. A valid empty catalog completes successfully with zero counts and an empty results array. Outcome counts reflect processing after acceptance. The initial 202 has no body. Poll the operation-bound Location URL until completion: a completed successful or partially successful assessment returns the typed result; failed or canceled processing returns an Azure error whose target identifies the evaluation resource. Ordinary evaluation reads return the current resource, including failed or canceled results, while retained.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceEvaluation" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Start evaluation of published scenario-template versions.": { "$ref": "./examples/Workspaces_Evaluate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/evaluations": { "get": { "operationId": "WorkspaceEvaluations_List", "tags": [ "WorkspaceEvaluations" ], "description": "Lists retained GA template evaluations under the workspace. Each result has its canonical ID; latest is an alias and is not a separate collection entry. This operation does not extend retention or convert scenario-backed legacy evaluations.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "continuationToken", "in": "query", "description": "Opaque continuation token supplied by the returned nextLink.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceEvaluationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List retained workspace evaluations using canonical IDs and an opaque nextLink.": { "$ref": "./examples/WorkspaceEvaluations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/evaluations/{evaluationName}": { "get": { "operationId": "WorkspaceEvaluations_Get", "tags": [ "WorkspaceEvaluations" ], "description": "Gets a retained template evaluation by its ID, or uses latest to select the most recently durably admitted GA template evaluation. Returns 200 with the current representation while processing or terminal. Returns 404 if no qualifying retained result exists; scenario-backed legacy operations are not substituted. This is not an LRO polling endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "evaluationName", "in": "path", "description": "The stable service-generated evaluation result ID in hyphenated GUID form. Use latest in the request path for the most recently durably admitted GA template evaluation; responses contain the canonical result ID, not the protected polling identifier.", "required": true, "type": "string", "pattern": "^(latest|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WorkspaceEvaluation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "A valid empty published catalog succeeds with zero counts and no aggregate recommendation.": { "$ref": "./examples/WorkspaceEvaluations_Get_EmptyCatalog.json" }, "Read a Canceled template evaluation independently of workspace scenarios.": { "$ref": "./examples/WorkspaceEvaluations_Get_Canceled.json" }, "Read a Failed template evaluation independently of workspace scenarios.": { "$ref": "./examples/WorkspaceEvaluations_Get_Failed.json" }, "Read a InProgress template evaluation independently of workspace scenarios.": { "$ref": "./examples/WorkspaceEvaluations_Get_InProgress.json" }, "Read a PartiallySucceeded template evaluation independently of workspace scenarios.": { "$ref": "./examples/WorkspaceEvaluations_Get_PartiallySucceeded.json" }, "Read a Succeeded template evaluation independently of workspace scenarios.": { "$ref": "./examples/WorkspaceEvaluations_Get_Succeeded.json" }, "Read latest as an alias while returning the canonical GA evaluation identity.": { "$ref": "./examples/WorkspaceEvaluations_Get_Latest.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios": { "get": { "operationId": "Scenarios_ListAll", "tags": [ "Scenarios" ], "description": "Get a list of scenarios.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ScenarioListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of scenarios.": { "$ref": "./examples/Scenarios_ListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios/{scenarioName}": { "get": { "operationId": "Scenarios_Get", "tags": [ "Scenarios" ], "description": "Get a scenario.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Scenario" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a scenario.": { "$ref": "./examples/Scenarios_Get.json" } } }, "put": { "operationId": "Scenarios_CreateOrUpdate", "tags": [ "Scenarios" ], "description": "Create or update a scenario.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "$ref": "#/parameters/PutPreconditionHeaders.ifNoneMatch" }, { "$ref": "#/parameters/PutPreconditionHeaders.ifMatch" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Scenario" } } ], "responses": { "200": { "description": "Resource 'Scenario' update operation succeeded", "schema": { "$ref": "#/definitions/Scenario" } }, "201": { "description": "Resource 'Scenario' create operation succeeded", "schema": { "$ref": "#/definitions/Scenario" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a scenario from a built-in scenario template version.": { "$ref": "./examples/Scenarios_CreateOrUpdate_From_Template.json" }, "Create a scenario only when absent, or return 412 when it already exists": { "$ref": "./examples/Scenarios_CreateOrUpdate_CreateOnly.json" }, "Create or update a scenario that continues past suppressed action failures.": { "$ref": "./examples/Scenarios_CreateOrUpdate_With_Failure_Behavior.json" }, "Create or update a scenario.": { "$ref": "./examples/Scenarios_CreateOrUpdate.json" }, "Update a scenario only when present, or return 412 when it does not exist": { "$ref": "./examples/Scenarios_CreateOrUpdate_UpdateOnly.json" } } }, "delete": { "operationId": "Scenarios_Delete", "tags": [ "Scenarios" ], "description": "Delete a scenario.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a Scenario in a workspace.": { "$ref": "./examples/Scenarios_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios/{scenarioName}/configurations": { "get": { "operationId": "ScenarioConfigurations_ListAll", "tags": [ "ScenarioConfigurations" ], "description": "Get a list of scenario definitions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ScenarioConfigurationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of scenario configurations.": { "$ref": "./examples/ScenarioConfigurations_ListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios/{scenarioName}/configurations/{scenarioConfigurationName}": { "get": { "operationId": "ScenarioConfigurations_Get", "tags": [ "ScenarioConfigurations" ], "description": "Get a scenario definition.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioConfigurationName", "in": "path", "description": "Name of the scenario definition.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScenarioConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a scenario configuration.": { "$ref": "./examples/ScenarioConfigurations_Get.json" } } }, "put": { "operationId": "ScenarioConfigurations_CreateOrUpdate", "tags": [ "ScenarioConfigurations" ], "description": "Create or update a scenario definition.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioConfigurationName", "in": "path", "description": "Name of the scenario definition.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "$ref": "#/parameters/PutPreconditionHeaders.ifNoneMatch" }, { "$ref": "#/parameters/PutPreconditionHeaders.ifMatch" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/ScenarioConfiguration" } } ], "responses": { "200": { "description": "Resource 'ScenarioConfiguration' update operation succeeded", "schema": { "$ref": "#/definitions/ScenarioConfiguration" } }, "201": { "description": "Resource 'ScenarioConfiguration' create operation succeeded", "schema": { "$ref": "#/definitions/ScenarioConfiguration" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a scenario configuration only when absent, or return 412 when it already exists": { "$ref": "./examples/ScenarioConfigurations_CreateOrUpdate_CreateOnly.json" }, "Create or update a scenario configuration with physical zone targeting.": { "$ref": "./examples/ScenarioConfigurations_CreateOrUpdate_With_Physical_Zones.json" }, "Create or update a scenario configuration.": { "$ref": "./examples/ScenarioConfigurations_CreateOrUpdate.json" }, "Update a scenario configuration only when present, or return 412 when it does not exist": { "$ref": "./examples/ScenarioConfigurations_CreateOrUpdate_UpdateOnly.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ScenarioConfigurations_Delete", "tags": [ "ScenarioConfigurations" ], "description": "Delete a scenario definition.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioConfigurationName", "in": "path", "description": "Name of the scenario definition.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a scenario configuration.": { "$ref": "./examples/ScenarioConfigurations_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios/{scenarioName}/configurations/{scenarioConfigurationName}/execute": { "post": { "operationId": "ScenarioConfigurations_Execute", "tags": [ "ScenarioConfigurations" ], "description": "Execute the scenario execution with the given scenario configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioConfigurationName", "in": "path", "description": "Name of the scenario definition.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Execute the scenario execution with the given scenario configuration.": { "$ref": "./examples/ScenarioConfigurations_Execute.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios/{scenarioName}/configurations/{scenarioConfigurationName}/fixResourcePermissions": { "post": { "operationId": "ScenarioConfigurations_FixResourcePermissions", "tags": [ "ScenarioConfigurations" ], "description": "Fixes resource permissions for the given scenario configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioConfigurationName", "in": "path", "description": "Name of the scenario definition.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/FixResourcePermissionsRequest" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Fixes resource permissions for the given scenario configuration.": { "$ref": "./examples/ScenarioConfigurations_FixResourcePermissions.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios/{scenarioName}/configurations/{scenarioConfigurationName}/validate": { "post": { "operationId": "ScenarioConfigurations_Validate", "tags": [ "ScenarioConfigurations" ], "description": "Validate the given scenario configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioConfigurationName", "in": "path", "description": "Name of the scenario definition.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Validate the given scenario configuration.": { "$ref": "./examples/ScenarioConfigurations_Validate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios/{scenarioName}/runs": { "get": { "operationId": "ScenarioRuns_ListAll", "tags": [ "ScenarioRuns" ], "description": "Get a list of scenario runs.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ScenarioRunListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a list of scenario runs.": { "$ref": "./examples/ScenarioRuns_ListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios/{scenarioName}/runs/{runId}": { "get": { "operationId": "ScenarioRuns_Get", "tags": [ "ScenarioRuns" ], "description": "Get a scenario run.\n\nThis endpoint is also the polling target for ScenarioConfigurations.execute\nand ScenarioRuns.cancel (final-state-via: location). While the run is in\nprogress the service returns 202 with a Location header pointing back to\nthis URL; clients must keep polling until they receive 200, which carries\nthe final ScenarioRun body.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "runId", "in": "path", "description": "The name of the ScenarioRun", "required": true, "type": "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}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ScenarioRun" } }, "202": { "description": "Indicates the scenario run is still in progress. Clients polling via the\nLocation header should continue polling until a 200 response is returned.\nThe body reflects the current run state at the time of the poll.", "schema": { "$ref": "#/definitions/ScenarioRun" }, "headers": { "Location": { "type": "string", "format": "uri", "description": "The URL where the status of the long-running operation can be polled." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The number of seconds the client should wait before polling again.", "minimum": 10, "maximum": 600 } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a scenario run that completed with suppressed action failures.": { "$ref": "./examples/ScenarioRuns_Get_Partially_Succeeded.json" }, "Get a scenario run.": { "$ref": "./examples/ScenarioRuns_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/workspaces/{workspaceName}/scenarios/{scenarioName}/runs/{runId}/cancel": { "post": { "operationId": "ScenarioRuns_Cancel", "tags": [ "ScenarioRuns" ], "description": "Cancel the currently running scenario execution.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "scenarioName", "in": "path", "description": "Name of the scenario.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "runId", "in": "path", "description": "The name of the ScenarioRun", "required": true, "type": "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}$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Cancel a running scenario run.": { "$ref": "./examples/ScenarioRuns_Cancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "Action": { "type": "object", "description": "Model that represents an Action resource.", "properties": { "properties": { "$ref": "#/definitions/ActionProperties", "description": "The properties of the action resource.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ActionDependency": { "type": "object", "description": "Model that represents an action dependency.", "properties": { "type": { "$ref": "#/definitions/ActionDependencyType", "description": "The type of dependency." }, "name": { "type": "string", "description": "Name of the action this depends on." }, "onActionLifecycle": { "$ref": "#/definitions/ActionLifecycle", "description": "The lifecycle state of the dependency action that triggers this action to start." } }, "required": [ "type", "name" ] }, "ActionDependencyType": { "type": "string", "description": "Enum for action dependency type.", "enum": [ "Action" ], "x-ms-enum": { "name": "ActionDependencyType", "modelAsString": true, "values": [ { "name": "Action", "value": "Action", "description": "Action dependency type." } ] } }, "ActionError": { "type": "object", "description": "Structured information about a scenario action failure.", "properties": { "code": { "type": "string", "description": "The stable code that identifies the action failure.", "readOnly": true }, "message": { "type": "string", "description": "The customer-safe description of the action failure.", "readOnly": true }, "details": { "type": "array", "description": "Additional customer-safe details about the action failure.", "items": { "$ref": "#/definitions/ActionErrorDetail" }, "readOnly": true, "x-ms-identifiers": [] } }, "required": [ "code", "message" ] }, "ActionErrorDetail": { "type": "object", "description": "Additional information about a scenario action failure.", "properties": { "code": { "type": "string", "description": "The stable code that identifies the failure detail.", "readOnly": true }, "message": { "type": "string", "description": "The customer-safe description of the failure detail.", "readOnly": true }, "target": { "type": "string", "description": "The target associated with the failure detail.", "readOnly": true } }, "required": [ "code", "message" ] }, "ActionKind": { "type": "string", "description": "Union of action types.", "enum": [ "Discrete", "Continuous", "Cancelable" ], "x-ms-enum": { "name": "ActionKind", "modelAsString": true, "values": [ { "name": "Discrete", "value": "Discrete", "description": "Discrete action type." }, { "name": "Continuous", "value": "Continuous", "description": "Continuous action type." }, { "name": "Cancelable", "value": "Cancelable", "description": "Cancelable action type." } ] } }, "ActionLifecycle": { "type": "string", "description": "Enum for action lifecycle states.", "enum": [ "AnyTerminal", "Start", "Running", "Success", "Failure", "Skipped" ], "x-ms-enum": { "name": "ActionLifecycle", "modelAsString": true, "values": [ { "name": "AnyTerminal", "value": "AnyTerminal", "description": "Trigger when action reaches any terminal state." }, { "name": "Start", "value": "Start", "description": "Trigger when action starts." }, { "name": "Running", "value": "Running", "description": "Trigger when action is running." }, { "name": "Success", "value": "Success", "description": "Trigger on success." }, { "name": "Failure", "value": "Failure", "description": "Trigger on failure." }, { "name": "Skipped", "value": "Skipped", "description": "Trigger when action is skipped." } ] } }, "ActionListResult": { "type": "object", "description": "Model that represents a list of Action resources and a link for pagination.", "properties": { "value": { "type": "array", "description": "The Action items on this page", "items": { "$ref": "#/definitions/Action" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ActionProperties": { "type": "object", "description": "Model that represents the properties of an Action resource.", "properties": { "canonicalId": { "type": "string", "description": "Canonical identifier of the action (e.g., \"microsoft-compute-shutdown/1.0\").", "readOnly": true }, "displayName": { "type": "string", "description": "Human-readable display name of the action.", "readOnly": true }, "description": { "type": "string", "description": "Description of what this action does.", "readOnly": true }, "actionName": { "type": "string", "description": "The short name of the action (e.g., \"Shutdown\").", "readOnly": true }, "version": { "type": "string", "description": "The version of the action (e.g., \"1.0.0\").", "readOnly": true }, "actionType": { "$ref": "#/definitions/ActionKind", "description": "The type of the action.", "readOnly": true }, "supportedTargetTypes": { "type": "array", "description": "List of target types supported by this action.", "items": { "$ref": "#/definitions/ActionSupportedTargetType" }, "readOnly": true, "x-ms-identifiers": [ "targetType" ] }, "parametersSchema": { "type": "object", "description": "JSON Schema describing the parameters for this action.", "readOnly": true }, "recommendedRoles": { "type": "array", "description": "Recommended Azure RBAC role definition GUIDs for this action.", "items": { "$ref": "#/definitions/Azure.Core.uuid" }, "readOnly": true } } }, "ActionStatus": { "type": "object", "description": "Model that represents the an action and its status.", "properties": { "actionName": { "type": "string", "description": "The name of the action status.", "readOnly": true }, "actionId": { "type": "string", "description": "The id of the action status.", "readOnly": true }, "status": { "type": "string", "description": "The status of the action.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "String that represents the start time of the action.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "String that represents the end time of the action.", "readOnly": true }, "targets": { "type": "array", "description": "The array of targets.", "items": { "$ref": "#/definitions/ExperimentExecutionActionTargetDetailsProperties" }, "readOnly": true, "x-ms-identifiers": [] } } }, "ActionSupportedTargetType": { "type": "object", "description": "Model that represents a target type supported by an action.", "properties": { "targetType": { "type": "string", "description": "The Azure resource type (e.g., \"Microsoft.Compute/virtualMachines\")." }, "requiredPermissions": { "type": "array", "description": "List of Azure permissions required for this target type.", "items": { "type": "string" } } } }, "ActionVersion": { "type": "object", "description": "Model that represents an Action Version resource.", "properties": { "properties": { "$ref": "#/definitions/ActionProperties", "description": "The properties of the action version resource.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ActionVersionListResult": { "type": "object", "description": "Model that represents a list of Action Version resources and a link for pagination.", "properties": { "value": { "type": "array", "description": "The ActionVersion items on this page", "items": { "$ref": "#/definitions/ActionVersion" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "Azure.Core.azureLocation": { "type": "string", "description": "Represents an Azure geography region where supported resource providers live." }, "Azure.Core.uuid": { "type": "string", "format": "uuid", "description": "Universally Unique Identifier" }, "BranchStatus": { "type": "object", "description": "Model that represents the a list of actions and action statuses.", "properties": { "branchName": { "type": "string", "description": "The name of the branch status.", "readOnly": true }, "branchId": { "type": "string", "description": "The id of the branch status.", "readOnly": true }, "status": { "type": "string", "description": "The status of the branch.", "readOnly": true }, "actions": { "type": "array", "description": "The array of actions.", "items": { "$ref": "#/definitions/ActionStatus" }, "readOnly": true, "x-ms-identifiers": [ "actionId" ] } } }, "Capability": { "type": "object", "description": "Model that represents a Capability resource.", "properties": { "properties": { "$ref": "#/definitions/CapabilityProperties", "description": "The properties of a capability resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "CapabilityListResult": { "type": "object", "description": "Model that represents a list of Capability resources and a link for pagination.", "properties": { "value": { "type": "array", "description": "The Capability items on this page", "items": { "$ref": "#/definitions/Capability" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CapabilityProperties": { "type": "object", "description": "Model that represents the Capability properties model.", "properties": { "publisher": { "type": "string", "description": "String of the Publisher that this Capability extends.", "readOnly": true }, "targetType": { "type": "string", "description": "String of the Target Type that this Capability extends.", "readOnly": true }, "description": { "type": "string", "description": "Localized string of the description.", "readOnly": true }, "parametersSchema": { "type": "string", "description": "URL to retrieve JSON schema of the Capability parameters.", "maxLength": 2048, "readOnly": true }, "urn": { "type": "string", "description": "String of the URN for this Capability Type.", "maxLength": 2048, "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Resource provisioning state. Not currently in use because resource is created synchronously.", "readOnly": true } } }, "CapabilityType": { "type": "object", "description": "Model that represents a Capability Type resource.", "properties": { "properties": { "$ref": "#/definitions/CapabilityTypeProperties", "description": "The properties of the capability type resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "CapabilityTypeListResult": { "type": "object", "description": "Model that represents a list of Capability Type resources and a link for pagination.", "properties": { "value": { "type": "array", "description": "The CapabilityType items on this page", "items": { "$ref": "#/definitions/CapabilityType" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "CapabilityTypeProperties": { "type": "object", "description": "Model that represents the Capability Type properties model.", "properties": { "publisher": { "type": "string", "description": "String of the Publisher that this Capability Type extends.", "readOnly": true }, "targetType": { "type": "string", "description": "String of the Target Type that this Capability Type extends.", "readOnly": true }, "displayName": { "type": "string", "description": "Localized string of the display name.", "readOnly": true }, "description": { "type": "string", "description": "Localized string of the description.", "readOnly": true }, "parametersSchema": { "type": "string", "description": "URL to retrieve JSON schema of the Capability Type parameters.", "maxLength": 2048, "readOnly": true }, "urn": { "type": "string", "description": "String of the URN for this Capability Type.", "maxLength": 2048, "readOnly": true }, "kind": { "type": "string", "description": "String of the kind of this Capability Type.", "readOnly": true }, "azureRbacActions": { "type": "array", "description": "Control plane actions necessary to execute capability type.", "items": { "type": "string" }, "readOnly": true }, "azureRbacDataActions": { "type": "array", "description": "Data plane actions necessary to execute capability type.", "items": { "type": "string" }, "readOnly": true }, "requiredAzureRoleDefinitionIds": { "type": "array", "description": "Required Azure Role Definition Ids to execute capability type.", "items": { "type": "string" }, "readOnly": true }, "runtimeProperties": { "$ref": "#/definitions/CapabilityTypePropertiesRuntimeProperties", "description": "Runtime properties of this Capability Type.", "readOnly": true } } }, "CapabilityTypePropertiesRuntimeProperties": { "type": "object", "description": "Runtime properties of this Capability Type.", "properties": { "kind": { "type": "string", "description": "String of the kind of the resource's action type (continuous or discrete).", "readOnly": true } } }, "ChaosExperimentAction": { "type": "object", "description": "Model that represents the base action model. 9 total per experiment.", "properties": { "name": { "type": "string", "description": "String that represents a Capability URN.", "maxLength": 2048 }, "type": { "$ref": "#/definitions/ExperimentActionType", "description": "Chaos experiment action discriminator type" } }, "discriminator": "type", "required": [ "name", "type" ] }, "ChaosExperimentBranch": { "type": "object", "description": "Model that represents a branch in the step. 9 total per experiment.", "properties": { "name": { "type": "string", "description": "String of the branch name.", "minLength": 1 }, "actions": { "type": "array", "description": "List of actions.", "items": { "$ref": "#/definitions/ChaosExperimentAction" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "name", "actions" ] }, "ChaosExperimentStep": { "type": "object", "description": "Model that represents a step in the Experiment resource.", "properties": { "name": { "type": "string", "description": "String of the step name.", "minLength": 1 }, "branches": { "type": "array", "description": "List of branches.", "items": { "$ref": "#/definitions/ChaosExperimentBranch" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "name", "branches" ] }, "ChaosTargetFilter": { "type": "object", "description": "Model that represents available filter types that can be applied to a targets list.", "properties": { "type": { "$ref": "#/definitions/FilterType", "description": "Chaos target filter discriminator type" } }, "discriminator": "type", "required": [ "type" ] }, "ChaosTargetListSelector": { "type": "object", "description": "Model that represents a list selector.", "properties": { "targets": { "type": "array", "description": "List of Target references.", "items": { "$ref": "#/definitions/TargetReference" } } }, "required": [ "targets" ], "allOf": [ { "$ref": "#/definitions/ChaosTargetSelector" } ], "x-ms-discriminator-value": "List" }, "ChaosTargetQuerySelector": { "type": "object", "description": "Model that represents a query selector.", "properties": { "queryString": { "type": "string", "description": "Azure Resource Graph (ARG) Query Language query for target resources." }, "subscriptionIds": { "type": "array", "description": "Subscription id list to scope resource query.", "items": { "type": "string" } } }, "required": [ "queryString", "subscriptionIds" ], "allOf": [ { "$ref": "#/definitions/ChaosTargetSelector" } ], "x-ms-discriminator-value": "Query" }, "ChaosTargetSelector": { "type": "object", "description": "Model that represents a selector in the Experiment resource.", "properties": { "id": { "type": "string", "description": "String of the selector ID.", "minLength": 1 }, "type": { "$ref": "#/definitions/SelectorType", "description": "Chaos target selector discriminator type" }, "filter": { "$ref": "#/definitions/ChaosTargetFilter", "description": "Model that represents available filter types that can be applied to a targets list." } }, "discriminator": "type", "required": [ "id", "type" ] }, "ChaosTargetSimpleFilter": { "type": "object", "description": "Model that represents a simple target filter.", "properties": { "parameters": { "$ref": "#/definitions/ChaosTargetSimpleFilterParameters", "description": "Model that represents the Simple filter parameters." } }, "allOf": [ { "$ref": "#/definitions/ChaosTargetFilter" } ], "x-ms-discriminator-value": "Simple" }, "ChaosTargetSimpleFilterParameters": { "type": "object", "description": "Model that represents the Simple filter parameters.", "properties": { "zones": { "type": "array", "description": "List of Azure availability zones to filter targets by.", "items": { "type": "string" } } } }, "Connection": { "type": "object", "description": "Model that represents a connection between a workspace and a target resource.\nA connection provisions and tracks the trust relationship that authorizes the\nactor to reach the Chaos Studio data plane for the workspace and target during\nfault injection.", "properties": { "properties": { "$ref": "#/definitions/ConnectionProperties", "description": "The properties of the connection." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ConnectionKind": { "type": "string", "description": "The kind of connection, indicating the actor type authorized to reach the Chaos Studio data plane for the workspace and target.", "enum": [ "AksExtension", "ChaosAgent" ], "x-ms-enum": { "name": "ConnectionKind", "modelAsString": true, "values": [ { "name": "AksExtension", "value": "AksExtension", "description": "A connection backed by the Chaos AKS cluster extension." }, { "name": "ChaosAgent", "value": "ChaosAgent", "description": "A connection backed by the Chaos agent installed on the target resource." } ] } }, "ConnectionListResult": { "type": "object", "description": "Model that represents a list of connections and a link for pagination.", "properties": { "value": { "type": "array", "description": "The Connection items on this page", "items": { "$ref": "#/definitions/Connection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ConnectionProperties": { "type": "object", "description": "Model that represents the properties of a connection.\n\nThe schema is flat and discriminated by `kind`. Optional fields form the\nsuperset across all connection kinds; which fields are required is\nvalidated by the service per kind.", "properties": { "kind": { "$ref": "#/definitions/ConnectionKind", "description": "The kind of connection, indicating the actor type authorized to reach the Chaos Studio data plane for the workspace and target." }, "targetResourceId": { "type": "string", "format": "arm-id", "description": "The fully qualified Azure resource ID of the target resource this connection is established with." }, "principalId": { "$ref": "#/definitions/Azure.Core.uuid", "description": "The Microsoft Entra principal (object) ID of the identity used by the connection." }, "tenantId": { "$ref": "#/definitions/Azure.Core.uuid", "description": "The Microsoft Entra tenant ID that the connection identity belongs to." }, "certificateSubjectName": { "type": "string", "description": "The subject name of the certificate used to authenticate the connection." }, "certificateIssuer": { "type": "string", "description": "The issuer of the certificate used to authenticate the connection." }, "dataPlaneEndpoint": { "type": "string", "format": "uri", "description": "The regional Chaos Studio data-plane endpoint assigned to this connection.\nClients and agents use this endpoint to reach the Chaos Studio data plane\nfor the connection.", "readOnly": true }, "status": { "$ref": "#/definitions/ConnectionStatus", "description": "The current status of the connection.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The most recent provisioning state for the connection resource.", "readOnly": true } }, "required": [ "kind", "targetResourceId" ] }, "ConnectionStatus": { "type": "string", "description": "The status of a connection.", "enum": [ "Pending", "Connected", "Disconnected", "Revoked" ], "x-ms-enum": { "name": "ConnectionStatus", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending", "description": "The connection has been created but is not yet sending heartbeats; the trust relationship is not yet established." }, { "name": "Connected", "value": "Connected", "description": "The connection is established and actively heartbeating." }, { "name": "Disconnected", "value": "Disconnected", "description": "The connection's heartbeat has gone stale; heartbeats are no longer being received." }, { "name": "Revoked", "value": "Revoked", "description": "The connection's credentials have been revoked." } ] } }, "ContinuousAction": { "type": "object", "description": "Model that represents a continuous action.", "properties": { "duration": { "type": "string", "format": "duration", "description": "ISO8601 formatted string that represents a duration." }, "parameters": { "type": "array", "description": "List of key value pairs.", "items": { "$ref": "#/definitions/KeyValuePair" }, "x-ms-identifiers": [ "key" ] }, "selectorId": { "type": "string", "description": "String that represents a selector.", "minLength": 1 } }, "required": [ "duration", "parameters", "selectorId" ], "allOf": [ { "$ref": "#/definitions/ChaosExperimentAction" } ], "x-ms-discriminator-value": "continuous" }, "CustomerDataStorageProperties": { "type": "object", "description": "Model that represents the Customer Managed Storage for an Experiment.", "properties": { "storageAccountResourceId": { "type": "string", "format": "arm-id", "description": "Azure Resource ID of the Storage account to use for Customer Data storage.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Storage/storageAccounts" } ] } }, "blobContainerName": { "type": "string", "description": "Name of the Azure Blob Storage container to use or create.", "minLength": 3, "maxLength": 63, "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$" } } }, "DelayAction": { "type": "object", "description": "Model that represents a delay action.", "properties": { "duration": { "type": "string", "format": "duration", "description": "ISO8601 formatted string that represents a duration." } }, "required": [ "duration" ], "allOf": [ { "$ref": "#/definitions/ChaosExperimentAction" } ], "x-ms-discriminator-value": "delay" }, "DiscoveredResource": { "type": "object", "description": "Model that represents a discovered resource.", "properties": { "properties": { "$ref": "#/definitions/DiscoveredResourceProperties", "description": "The properties of the discovered resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "DiscoveredResourceListResult": { "type": "object", "description": "Model that represents a list of discovered resources and a link for pagination.", "properties": { "value": { "type": "array", "description": "The DiscoveredResource items on this page", "items": { "$ref": "#/definitions/DiscoveredResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DiscoveredResourceProperties": { "type": "object", "description": "Model that represents the properties of a discovered resource.", "properties": { "namespace": { "type": "string", "description": "The namespace of the discovered resource.", "readOnly": true, "x-ms-client-name": "resourceNamespace" }, "resourceName": { "type": "string", "description": "The name of the discovered resource.", "readOnly": true }, "resourceType": { "type": "string", "description": "The resource type of the discovered resource.", "readOnly": true }, "fullyQualifiedIdentifier": { "type": "string", "description": "The fully qualified identifier of the discovered resource.", "readOnly": true }, "discoveredAt": { "type": "string", "format": "date-time", "description": "The date and time when the resource was discovered.", "readOnly": true }, "scope": { "type": "string", "description": "The scope of the discovered resource.", "readOnly": true }, "location": { "$ref": "#/definitions/Azure.Core.azureLocation", "description": "The Azure region the discovered resource is deployed to, in lowercase with no spaces. Absent when no single deployment region was captured, including global and multi-region resources.", "readOnly": true }, "zones": { "type": "array", "description": "The availability zones the discovered resource occupies. Values are logical zone identifiers, such as `[\"1\", \"2\"]` for a zone-pinned resource, or the single value `zone-redundant` when redundancy is expressed as a flag or SKU rather than a zone list. Absent, and never empty, when no zone information was captured; a non-zone-aware resource and a zone-aware resource without an assigned zone are not distinguished.", "items": { "type": "string" }, "readOnly": true } }, "required": [ "namespace", "resourceName", "resourceType", "fullyQualifiedIdentifier", "discoveredAt", "scope" ] }, "DiscreteAction": { "type": "object", "description": "Model that represents a discrete action.", "properties": { "parameters": { "type": "array", "description": "List of key value pairs.", "items": { "$ref": "#/definitions/KeyValuePair" }, "x-ms-identifiers": [ "key" ] }, "selectorId": { "type": "string", "description": "String that represents a selector.", "minLength": 1 } }, "required": [ "parameters", "selectorId" ], "allOf": [ { "$ref": "#/definitions/ChaosExperimentAction" } ], "x-ms-discriminator-value": "discrete" }, "EntraIdentity": { "type": "object", "description": "Model that represents the Azure Entra identity.", "properties": { "objectId": { "type": "string", "description": "The identity object id.", "readOnly": true }, "tenantId": { "type": "string", "description": "The identity tenant id.", "readOnly": true } }, "required": [ "objectId", "tenantId" ] }, "Experiment": { "type": "object", "description": "Model that represents a Experiment resource.", "properties": { "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." }, "properties": { "$ref": "#/definitions/ExperimentProperties", "description": "The properties of the experiment resource.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "ExperimentActionType": { "type": "string", "description": "Enum union of Chaos experiment action types.", "enum": [ "delay", "discrete", "continuous" ], "x-ms-enum": { "name": "ExperimentActionType", "modelAsString": true, "values": [ { "name": "delay", "value": "delay" }, { "name": "discrete", "value": "discrete" }, { "name": "continuous", "value": "continuous" } ] } }, "ExperimentExecution": { "type": "object", "description": "Model that represents the execution of a Experiment.", "properties": { "properties": { "$ref": "#/definitions/ExperimentExecutionProperties", "description": "The properties of experiment execution status.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ExperimentExecutionActionTargetDetailsError": { "type": "object", "description": "Model that represents the Experiment action target details error model.", "properties": { "code": { "type": "string", "description": "The error code.", "readOnly": true }, "message": { "type": "string", "description": "The error message", "readOnly": true } } }, "ExperimentExecutionActionTargetDetailsProperties": { "type": "object", "description": "Model that represents the Experiment action target details properties model.", "properties": { "status": { "type": "string", "description": "The status of the execution.", "readOnly": true }, "target": { "type": "string", "description": "The target for the action.", "readOnly": true }, "targetFailedTime": { "type": "string", "format": "date-time", "description": "String that represents the failed date time.", "readOnly": true }, "targetCompletedTime": { "type": "string", "format": "date-time", "description": "String that represents the completed date time.", "readOnly": true }, "error": { "$ref": "#/definitions/ExperimentExecutionActionTargetDetailsError", "description": "The error of the action.", "readOnly": true } } }, "ExperimentExecutionDetails": { "type": "object", "description": "Model that represents the execution details of an Experiment.", "properties": { "type": { "type": "string", "description": "String of the resource type.", "readOnly": true }, "id": { "type": "string", "description": "String of the fully qualified resource ID.", "readOnly": true }, "name": { "type": "string", "description": "String of the resource name.", "readOnly": true }, "properties": { "$ref": "#/definitions/ExperimentExecutionDetailsProperties", "description": "The properties of the experiment execution details.", "readOnly": true, "x-ms-client-flatten": true } } }, "ExperimentExecutionDetailsProperties": { "type": "object", "description": "Model that represents the extended properties of an experiment execution.", "properties": { "status": { "type": "string", "description": "The status of the execution.", "readOnly": true }, "startedAt": { "type": "string", "format": "date-time", "description": "String that represents the start date time.", "readOnly": true }, "stoppedAt": { "type": "string", "format": "date-time", "description": "String that represents the stop date time.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Resource provisioning state. Not currently in use for executions.", "readOnly": true }, "failureReason": { "type": "string", "description": "The reason why the execution failed.", "readOnly": true }, "lastActionAt": { "type": "string", "format": "date-time", "description": "String that represents the last action date time.", "readOnly": true }, "runInformation": { "$ref": "#/definitions/ExperimentExecutionDetailsPropertiesRunInformation", "description": "The information of the experiment run.", "readOnly": true } } }, "ExperimentExecutionDetailsPropertiesRunInformation": { "type": "object", "description": "The information of the experiment run.", "properties": { "steps": { "type": "array", "description": "The steps of the experiment run.", "items": { "$ref": "#/definitions/StepStatus" }, "readOnly": true, "x-ms-identifiers": [ "stepName" ] } } }, "ExperimentExecutionListResult": { "type": "object", "description": "Model that represents a list of Experiment executions and a link for pagination.", "properties": { "value": { "type": "array", "description": "The ExperimentExecution items on this page", "items": { "$ref": "#/definitions/ExperimentExecution" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExperimentExecutionProperties": { "type": "object", "description": "Model that represents the execution properties of an Experiment.", "properties": { "status": { "type": "string", "description": "The status of the execution.", "readOnly": true }, "startedAt": { "type": "string", "format": "date-time", "description": "String that represents the start date time.", "readOnly": true }, "stoppedAt": { "type": "string", "format": "date-time", "description": "String that represents the stop date time.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Resource provisioning state. Not currently in use for executions.", "readOnly": true } } }, "ExperimentListResult": { "type": "object", "description": "Model that represents a list of Experiment resources and a link for pagination.", "properties": { "value": { "type": "array", "description": "The Experiment items on this page", "items": { "$ref": "#/definitions/Experiment" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExperimentProperties": { "type": "object", "description": "Model that represents the Experiment properties model.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Most recent provisioning state for the given experiment resource.", "readOnly": true }, "steps": { "type": "array", "description": "List of steps.", "items": { "$ref": "#/definitions/ChaosExperimentStep" }, "x-ms-identifiers": [ "name" ] }, "selectors": { "type": "array", "description": "List of selectors.", "items": { "$ref": "#/definitions/ChaosTargetSelector" } }, "customerDataStorage": { "$ref": "#/definitions/CustomerDataStorageProperties", "description": "Optional customer-managed Storage account where Experiment schema will be stored." } }, "required": [ "steps", "selectors" ] }, "ExperimentUpdate": { "type": "object", "description": "Describes an experiment update.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } } }, "ExternalResource": { "type": "object", "description": "Model that represents an external resource reference.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "The resource ID of the external resource." } } }, "FailureBehavior": { "type": "string", "description": "Enum of how a scenario run reacts when an action fails.", "enum": [ "Stop", "Continue" ], "x-ms-enum": { "name": "FailureBehavior", "modelAsString": true, "values": [ { "name": "Stop", "value": "Stop", "description": "The action failure stops the scenario run and drives it to the `Failed` terminal state.\nThis is the effective behavior when no `failureBehavior` is supplied." }, { "name": "Continue", "value": "Continue", "description": "The action failure is suppressed: it does not by itself end the scenario run, and the run\ncontinues with its remaining actions. Suppression affects the run's result only. It does not\nchange dependency scheduling, which stays under the control of each action's `runAfter` —\nan action that should still start after a failed dependency says so there.\n\nA run that completes normally and whose action failures were all suppressed terminates as\n`PartiallySucceeded`. Any failure that is not suppressed still drives the run to `Failed`,\nand cancellation keeps its existing result." } ] } }, "FilterType": { "type": "string", "description": "Enum that discriminates between filter types. Currently only `Simple` type is supported.", "enum": [ "Simple" ], "x-ms-enum": { "name": "FilterType", "modelAsString": true, "values": [ { "name": "Simple", "value": "Simple", "description": "Simple filter type." } ] } }, "FixResourcePermissionsRequest": { "type": "object", "description": "Request body for fixing resource permissions.", "properties": { "whatIf": { "type": "boolean", "description": "Optional value that indicates whether to run a \"dry run\" of fixing resource permissions." } } }, "KeyValuePair": { "type": "object", "description": "A key-value pair used to describe parameters for actions or configurations.", "properties": { "key": { "type": "string", "description": "The name of the setting for the action.", "minLength": 1 }, "value": { "type": "string", "description": "The value of the setting for the action.", "minLength": 1 } }, "required": [ "key", "value" ] }, "OperationError": { "type": "object", "description": "Represents a system or infrastructure error encountered during an async operation.", "properties": { "errorCode": { "type": "string", "description": "The error code identifying the type of system error." }, "errorMessage": { "type": "string", "description": "A human-readable description of the system error." } }, "required": [ "errorCode", "errorMessage" ] }, "ParameterFormatType": { "type": "string", "description": "Enum of the built-in formats a scenario parameter's value can be validated against.", "enum": [ "AzureResourceId", "AzureRegion", "AzureZone", "Duration", "Json" ], "x-ms-enum": { "name": "ParameterFormatType", "modelAsString": true, "values": [ { "name": "AzureResourceId", "value": "AzureResourceId", "description": "The value must be an Azure resource ID." }, { "name": "AzureRegion", "value": "AzureRegion", "description": "The value must be an Azure region name." }, { "name": "AzureZone", "value": "AzureZone", "description": "The value must be an Azure availability zone." }, { "name": "Duration", "value": "Duration", "description": "The value must be an ISO 8601 duration." }, { "name": "Json", "value": "Json", "description": "The value must be well-formed JSON." } ] } }, "ParameterType": { "type": "string", "description": "Enum for parameter types.", "enum": [ "string", "number", "boolean", "object", "array" ], "x-ms-enum": { "name": "ParameterType", "modelAsString": true, "values": [ { "name": "String", "value": "string", "description": "String parameter type." }, { "name": "Number", "value": "number", "description": "Number parameter type." }, { "name": "Boolean", "value": "boolean", "description": "Boolean parameter type." }, { "name": "Object", "value": "object", "description": "Object parameter type." }, { "name": "Array", "value": "array", "description": "Array parameter type." } ] } }, "PermissionError": { "type": "object", "description": "Model that represents the permission error.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "The resource id for the affected resource.", "readOnly": true }, "missingPermissions": { "type": "array", "description": "The missing permissions.", "items": { "type": "string" }, "readOnly": true }, "requiredPermissions": { "type": "array", "description": "The required permissions.", "items": { "type": "string" }, "readOnly": true }, "recommendedRoles": { "type": "array", "description": "The recommended roles.", "items": { "type": "string" }, "readOnly": true }, "identity": { "$ref": "#/definitions/EntraIdentity", "description": "The identity.", "readOnly": true }, "errorMessage": { "type": "string", "description": "The error message describing the permission validation failure, when the\nfailure carries a distinct message (for example, when the target could not\nbe read to evaluate access).", "readOnly": true } }, "required": [ "resourceId", "missingPermissions", "requiredPermissions", "recommendedRoles" ] }, "PermissionsFix": { "type": "object", "description": "Model that represents the fix resource permissions result.", "properties": { "properties": { "$ref": "#/definitions/PermissionsFixProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "PermissionsFixProperties": { "type": "object", "description": "Model that represents the properties of the permission fix operation.", "properties": { "state": { "$ref": "#/definitions/PermissionsFixState", "description": "The permission fix state.", "readOnly": true }, "startedAt": { "type": "string", "format": "date-time", "description": "The permission fix UTC start time.", "readOnly": true }, "completedAt": { "type": "string", "format": "date-time", "description": "The permission fix UTC end time.", "readOnly": true }, "whatIfMode": { "type": "boolean", "description": "Whether this was a what-if (dry run) operation.", "readOnly": true }, "roleAssignments": { "type": "array", "description": "The list of role assignment results.", "items": { "$ref": "#/definitions/RoleAssignmentResult" }, "readOnly": true, "x-ms-identifiers": [] }, "summary": { "$ref": "#/definitions/PermissionsFixSummary", "description": "Summary of the permission fix operation.", "readOnly": true } }, "required": [ "state", "startedAt", "whatIfMode", "roleAssignments", "summary" ] }, "PermissionsFixState": { "type": "string", "description": "Enum of the permission fix state.", "enum": [ "NotStarted", "InProgress", "Succeeded", "Failed", "PartiallySucceeded", "WhatIfCompleted" ], "x-ms-enum": { "name": "PermissionsFixState", "modelAsString": true, "values": [ { "name": "NotStarted", "value": "NotStarted", "description": "The permission fix has not started." }, { "name": "InProgress", "value": "InProgress", "description": "The permission fix is in progress." }, { "name": "Succeeded", "value": "Succeeded", "description": "All role assignments succeeded." }, { "name": "Failed", "value": "Failed", "description": "All role assignments failed." }, { "name": "PartiallySucceeded", "value": "PartiallySucceeded", "description": "Some role assignments succeeded and some failed." }, { "name": "WhatIfCompleted", "value": "WhatIfCompleted", "description": "What-if analysis completed (no changes made)." } ] }, "readOnly": true }, "PermissionsFixSummary": { "type": "object", "description": "Summary of the permission fix operation.", "properties": { "totalRequired": { "type": "integer", "format": "int32", "description": "Total number of role assignments required.", "readOnly": true }, "succeeded": { "type": "integer", "format": "int32", "description": "Number of successful role assignments.", "readOnly": true }, "failed": { "type": "integer", "format": "int32", "description": "Number of failed role assignments.", "readOnly": true }, "skipped": { "type": "integer", "format": "int32", "description": "Number of skipped role assignments (already existed).", "readOnly": true } }, "required": [ "totalRequired", "succeeded", "failed", "skipped" ] }, "PhysicalToLogicalZoneMapping": { "type": "object", "description": "Maps a physical zone to the resolved logical zone for a given subscription.", "properties": { "physicalZone": { "type": "string", "description": "The physical availability zone (e.g., `\"westus2-az1\"`).", "readOnly": true }, "logicalZone": { "type": "string", "description": "The logical availability zone resolved for this subscription\n(e.g., `\"1\"`, `\"2\"`, `\"3\"`).", "readOnly": true } }, "required": [ "physicalZone", "logicalZone" ] }, "ProvisioningState": { "type": "string", "description": "Current provisioning state for a given Azure Chaos resource.", "enum": [ "Succeeded", "Failed", "Canceled", "Creating", "Updating", "Deleting", "Running" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." }, { "name": "Creating", "value": "Creating", "description": "Initial creation in progress." }, { "name": "Updating", "value": "Updating", "description": "Update in progress." }, { "name": "Deleting", "value": "Deleting", "description": "Deletion in progress." }, { "name": "Running", "value": "Running", "description": "Action is running." } ] }, "readOnly": true }, "Recommendation": { "type": "object", "description": "Model that represents a scenario recommendation.", "properties": { "recommendationStatus": { "$ref": "#/definitions/RecommendationStatus", "description": "The recommendation status.", "readOnly": true }, "evaluationRunAt": { "type": "string", "format": "date-time", "description": "The UTC time when the recommendation was evaluated.", "readOnly": true } }, "required": [ "recommendationStatus" ] }, "RecommendationStatus": { "type": "string", "description": "Enum of the scenario validation state.", "enum": [ "NotEvaluated", "Recommended", "NotApplicable", "Evaluating", "EvaluationFailed", "EvaluationCancelled" ], "x-ms-enum": { "name": "RecommendationStatus", "modelAsString": true, "values": [ { "name": "NotEvaluated", "value": "NotEvaluated", "description": "The scenario recommendation status has not been evaluated." }, { "name": "Recommended", "value": "Recommended", "description": "The scenario recommendation status is recommended." }, { "name": "NotApplicable", "value": "NotApplicable", "description": "The scenario recommendation status is not applicable." }, { "name": "Evaluating", "value": "Evaluating", "description": "The scenario recommendation status is currently being evaluated." }, { "name": "EvaluationFailed", "value": "EvaluationFailed", "description": "The scenario recommendation evaluation has failed." }, { "name": "EvaluationCancelled", "value": "EvaluationCancelled", "description": "The scenario recommendation evaluation was cancelled." } ] } }, "ResourceStateError": { "type": "object", "description": "Model that represents the resource state error.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "The resource id for the affected resource.", "readOnly": true }, "errorCode": { "type": "string", "description": "The error code.", "readOnly": true }, "errorMessage": { "type": "string", "description": "The error message.", "readOnly": true }, "remediationUri": { "type": "string", "description": "The remediation uri.", "readOnly": true } }, "required": [ "resourceId", "errorCode", "errorMessage", "remediationUri" ] }, "ResourceTargeting": { "type": "object", "description": "Model that represents unified resource targeting with symmetric include/exclude criteria.\nBoth sides support the same set of dimensions.", "properties": { "include": { "$ref": "#/definitions/ResourceTargetingCriteria", "description": "Inclusion criteria. Resources must match ALL active dimensions to be candidates.\nNull or omitted means no inclusion filtering (all resources are candidates)." }, "exclude": { "$ref": "#/definitions/ResourceTargetingCriteria", "description": "Exclusion criteria. Resources matching ANY active dimension are removed.\nNull or omitted means no exclusions applied." } } }, "ResourceTargetingCriteria": { "type": "object", "description": "Model that represents a set of targeting criteria for resource selection.\nUsed on both the include and exclude sides of ResourceTargeting.\n\nAll dimensions use unified null/empty semantics:\n- Null or omitted means \"no constraint\" (this dimension is inactive).\n- Empty array is treated the same as null (no constraint).\n- Non-empty array means the dimension is active.", "properties": { "locations": { "type": "array", "description": "Array of Azure location strings (e.g., \"eastus\", \"westeurope\", \"global\").\nCase-insensitive, normalized form only (e.g., \"eastus\" not \"East US\").", "items": { "type": "string" } }, "zones": { "type": "array", "description": "Array of logical availability zone identifiers (e.g., \"1\", \"2\", \"3\", \"zone-redundant\").\n\nMutually exclusive with `physicalZones` — set one or the other, not both.\nWhen set, `locations` must also be set on the same side (zone IDs are only meaningful within a region).", "items": { "type": "string" } }, "physicalZones": { "type": "array", "description": "Array of physical datacenter zone identifiers in `{region}-az{N}` format\n(e.g., \"westus2-az1\"). Resolved to logical zones per-subscription at execution time.\n\nMutually exclusive with `zones` — set one or the other, not both.", "items": { "type": "string" } }, "types": { "type": "array", "description": "Array of Azure resource type strings (e.g., \"Microsoft.Compute/virtualMachines\").\nCase-insensitive equality. Supports trailing wildcard (e.g., \"Microsoft.Compute/*\").", "items": { "type": "string" } }, "tags": { "type": "array", "description": "Array of tag key-value pairs for filtering by Azure resource tags.\nKey and value are matched case-insensitively. Use \"*\" as value to match any value for a key.", "items": { "$ref": "#/definitions/KeyValuePair" }, "x-ms-identifiers": [ "key" ] }, "resources": { "type": "array", "description": "Array of fully qualified Azure resource IDs. Case-insensitive equality.", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource." } } } }, "RoleAssignmentError": { "type": "object", "description": "Error details for a failed role assignment.", "properties": { "code": { "type": "string", "description": "Azure error code.", "readOnly": true }, "message": { "type": "string", "description": "Error message.", "readOnly": true } }, "required": [ "code", "message" ] }, "RoleAssignmentResult": { "type": "object", "description": "Result of a single role assignment operation.", "properties": { "targetResourceId": { "type": "string", "format": "arm-id", "description": "The target Azure resource ID.", "readOnly": true }, "principalId": { "type": "string", "description": "The managed identity principal ID.", "readOnly": true }, "roleDefinitionId": { "type": "string", "description": "The Azure RBAC role definition ID.", "readOnly": true }, "roleDefinitionName": { "type": "string", "description": "Human-readable role name.", "readOnly": true }, "scope": { "type": "string", "description": "The scope at which the role was/will be assigned.", "readOnly": true }, "status": { "$ref": "#/definitions/RoleAssignmentStatus", "description": "The status of the role assignment operation.", "readOnly": true }, "roleAssignmentId": { "type": "string", "format": "arm-id", "description": "The created role assignment resource ID (null if failed or what-if mode).", "readOnly": true }, "error": { "$ref": "#/definitions/RoleAssignmentError", "description": "Error details if the assignment failed.", "readOnly": true } }, "required": [ "targetResourceId", "principalId", "roleDefinitionId", "roleDefinitionName", "scope", "status" ] }, "RoleAssignmentStatus": { "type": "string", "description": "Enum of the role assignment status.", "enum": [ "Succeeded", "Failed", "Skipped", "Pending" ], "x-ms-enum": { "name": "RoleAssignmentStatus", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "The role assignment succeeded." }, { "name": "Failed", "value": "Failed", "description": "The role assignment failed." }, { "name": "Skipped", "value": "Skipped", "description": "The role assignment was skipped (already exists)." }, { "name": "Pending", "value": "Pending", "description": "The role assignment is pending (what-if mode)." } ] }, "readOnly": true }, "RunAfter": { "type": "object", "description": "Model that represents action dependencies.", "properties": { "behavior": { "type": "string", "description": "Defines how multiple dependencies are evaluated.", "default": "Any", "enum": [ "Any", "All", "AtLeastOne" ], "x-ms-enum": { "name": "RunAfterBehavior", "modelAsString": true, "values": [ { "name": "Any", "value": "Any", "description": "Always continues after all dependencies (like a finally block)." }, { "name": "All", "value": "All", "description": "All dependencies must be satisfied to continue." }, { "name": "AtLeastOne", "value": "AtLeastOne", "description": "At least one dependency must be satisfied to continue." } ] } }, "items": { "type": "array", "description": "Array of action dependencies.", "items": { "$ref": "#/definitions/ActionDependency" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "items" ] }, "Scenario": { "type": "object", "description": "Model that represents the scenario.", "properties": { "properties": { "$ref": "#/definitions/ScenarioProperties", "description": "The properties of scenario." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ScenarioAction": { "type": "object", "description": "Model that represents a scenario action.", "properties": { "name": { "type": "string", "description": "Unique name for the action.", "pattern": "^[a-zA-Z0-9-_]+$" }, "actionId": { "type": "string", "description": "Identifier of the action and version (e.g., \"microsoft-compute-shutdown/1.0\")." }, "description": { "type": "string", "description": "Human-readable description of what this action does." }, "duration": { "type": "string", "description": "ISO 8601 duration for how long the action runs (e.g., PT30M for 30 minutes). Supports template macro syntax (%%\\{parameters.\\\\}%%)." }, "parameters": { "type": "array", "description": "Action-specific parameter values.", "items": { "$ref": "#/definitions/KeyValuePair" }, "x-ms-identifiers": [ "key" ] }, "selectors": { "type": "array", "description": "Action-specific target selectors evaluated during execution. When provided,\nthe collection must contain either `logicalZone` and `location`, or `physicalZone`.\nSelector names must be unique, the two modes cannot be combined, and the service\nenforces the cross-item combination at runtime.", "minItems": 1, "maxItems": 2, "items": { "$ref": "#/definitions/ScenarioActionSelector" }, "x-ms-identifiers": [ "name" ] }, "runAfter": { "$ref": "#/definitions/RunAfter", "description": "Action dependencies that control when this action starts." }, "waitBefore": { "type": "string", "description": "ISO 8601 duration to wait before action starts (e.g., PT30S for 30 seconds). Supports template macro syntax." }, "timeout": { "type": "string", "description": "ISO 8601 duration for maximum action execution time. Supports template macro syntax." }, "externalResource": { "$ref": "#/definitions/ExternalResource", "description": "External resource reference for the action." }, "failureBehavior": { "$ref": "#/definitions/FailureBehavior", "description": "Per-action override for how the scenario run reacts when this action fails. When omitted,\nthe action inherits the scenario-level `failureBehavior`; when neither is supplied the\neffective behavior is `Stop`." } }, "required": [ "name", "actionId", "duration" ] }, "ScenarioActionSelector": { "type": "object", "description": "Model that represents an action-specific target selector.", "properties": { "name": { "$ref": "#/definitions/ScenarioActionSelectorName", "description": "The selector name, such as `logicalZone`, `physicalZone`, or `location`." }, "value": { "type": "string", "description": "The value that targets must match. Supports template macro syntax." } }, "required": [ "name", "value" ] }, "ScenarioActionSelectorName": { "type": "string", "description": "The supported action selector names.", "enum": [ "logicalZone", "physicalZone", "location" ], "x-ms-enum": { "name": "ScenarioActionSelectorName", "modelAsString": true, "values": [ { "name": "LogicalZone", "value": "logicalZone", "description": "Select targets by logical availability zone." }, { "name": "PhysicalZone", "value": "physicalZone", "description": "Select targets by physical availability zone." }, { "name": "Location", "value": "location", "description": "Select targets by Azure location." } ] } }, "ScenarioConfiguration": { "type": "object", "description": "Model that represents the scenario.", "properties": { "properties": { "$ref": "#/definitions/ScenarioConfigurationProperties", "description": "The properties of scenario definition." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ScenarioConfigurationListResult": { "type": "object", "description": "Model that represents a list of scenario configurations and a link for pagination.", "properties": { "value": { "type": "array", "description": "The ScenarioConfiguration items on this page", "items": { "$ref": "#/definitions/ScenarioConfiguration" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ScenarioConfigurationProperties": { "type": "object", "description": "Model that represents the properties of the scenario configuration.", "properties": { "scenarioId": { "type": "string", "format": "arm-id", "description": "Resource ID of the scenario this configuration applies to." }, "parameters": { "type": "array", "description": "Runtime parameter values for the scenario. Keys must match parameter names defined in the scenario.", "items": { "$ref": "#/definitions/KeyValuePair" }, "x-ms-identifiers": [ "key" ] }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Most recent provisioning state for the given scenario resource.", "readOnly": true }, "resourceTargeting": { "$ref": "#/definitions/ResourceTargeting", "description": "Unified resource targeting policy that controls which discovered resources participate\nin fault injection. Replaces the separate `exclusions` and `filters` properties with\nsymmetric include/exclude criteria.\n\nInclude uses AND logic — a resource must match ALL active include dimensions.\nExclude uses OR logic — a resource is removed if it matches ANY exclude dimension.\nWhen include and exclude conflict on the same resource, exclude wins.\n\nNull or omitted means all discovered resources participate (no targeting constraints)." } }, "required": [ "scenarioId" ] }, "ScenarioErrors": { "type": "object", "description": "Model that represents the scenario run errors.", "properties": { "errorCode": { "type": "string", "description": "Error code for internal server errors." }, "errorMessage": { "type": "string", "description": "Error message for internal server errors." }, "permission": { "type": "array", "description": "Any permission errors associated with the scenario run.", "items": { "$ref": "#/definitions/PermissionError" }, "readOnly": true, "x-ms-identifiers": [ "resourceId" ] }, "resource": { "type": "array", "description": "Any resource state errors associated with the scenario run.", "items": { "$ref": "#/definitions/ResourceStateError" }, "readOnly": true, "x-ms-identifiers": [ "resourceId" ] } }, "required": [ "permission", "resource" ] }, "ScenarioListResult": { "type": "object", "description": "Model that represents a list of scenarios and a link for pagination.", "properties": { "value": { "type": "array", "description": "The Scenario items on this page", "items": { "$ref": "#/definitions/Scenario" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ScenarioParameter": { "type": "object", "description": "Model that represents a single scenario parameter definition.", "properties": { "name": { "type": "string", "description": "The name of the parameter.", "minLength": 1 }, "type": { "$ref": "#/definitions/ParameterType", "description": "Parameter data type." }, "default": { "type": "string", "description": "Default value for the parameter." }, "required": { "type": "boolean", "description": "Whether this parameter is required." }, "description": { "type": "string", "description": "Description of the parameter." }, "format": { "$ref": "#/definitions/ScenarioParameterFormat", "description": "Format validation applied to the parameter's value, and examples of values that satisfy it." } }, "required": [ "name", "type" ] }, "ScenarioParameterFormat": { "type": "object", "description": "Model that represents the format validation applied to a scenario parameter's value.", "properties": { "formatType": { "$ref": "#/definitions/ParameterFormatType", "description": "The built-in format the value is validated against." }, "examples": { "type": "array", "description": "Human-readable examples of values that satisfy the format.", "items": { "type": "string" } } } }, "ScenarioProperties": { "type": "object", "description": "Model that represents the properties of the scenario.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Most recent provisioning state for the given scenario resource.", "readOnly": true }, "createdFrom": { "type": "string", "description": "Resource ID of the template version this scenario was created from (optional).\nThe ID has the form\n`/providers/Microsoft.Chaos/scenarioTemplates/{scenarioTemplateName}/versions/{version}`.\nThis property retains its existing string representation for compatibility\nwith earlier API versions and SDKs.\n\nA scenario's structure comes from exactly one of two mutually exclusive sources.\nWhen `createdFrom` is supplied on create, the referenced template version is the\nauthoritative source for the scenario's structure; inline `parameters` and\n`actions` are not used. When `createdFrom` is absent, the structure comes from\nthe inline `parameters` and `actions` supplied in the request.\nSupplying neither source is rejected by request validation.", "x-ms-mutability": [ "read", "create" ] }, "version": { "type": "string", "description": "Version of the scenario, supplied by the author. Defaults to `1.0` when not\nsupplied on create. This is the scenario's own version and is independent of\nthe version of any template it was created from." }, "description": { "type": "string", "description": "Description of what this scenario does (optional)." }, "parameters": { "type": "array", "description": "Parameter definitions for the scenario.", "items": { "$ref": "#/definitions/ScenarioParameter" }, "x-ms-identifiers": [ "name" ] }, "actions": { "type": "array", "description": "Array of actions that define the scenario's orchestration.", "minItems": 1, "items": { "$ref": "#/definitions/ScenarioAction" }, "x-ms-identifiers": [ "name" ] }, "failureBehavior": { "$ref": "#/definitions/FailureBehavior", "description": "Scenario-wide default for how a scenario run reacts when one of its actions fails.\nAn action that does not supply its own `failureBehavior` inherits this value; when\nneither is supplied the effective behavior is `Stop`.\n\nNot used when `createdFrom` is supplied, for the same reason as `parameters` and\n`actions`: the referenced template version is then the authoritative source for the\nscenario's structure, and it supplies this policy too. A value sent in the request is\nignored in that case — on create the referenced template's policy is used, and on update\nthe policy of the already persisted template is preserved." }, "recommendation": { "$ref": "#/definitions/Recommendation", "description": "The recommendation information for this scenario.", "readOnly": true } } }, "ScenarioRun": { "type": "object", "description": "Model that represents the scenario run.", "properties": { "properties": { "$ref": "#/definitions/ScenarioRunProperties", "description": "The properties of scenario run." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ScenarioRunEffectiveTarget": { "type": "object", "description": "Model that represents the outcome for a concrete action target.", "properties": { "id": { "type": "string", "description": "The target resource ID.", "readOnly": true }, "state": { "$ref": "#/definitions/ScenarioRunTargetState", "description": "The target execution state.", "readOnly": true }, "startedAt": { "type": "string", "format": "date-time", "description": "When target processing started.", "readOnly": true }, "completedAt": { "type": "string", "format": "date-time", "description": "When target processing completed.", "readOnly": true } }, "required": [ "id", "state" ] }, "ScenarioRunListResult": { "type": "object", "description": "Model that represents a list of scenario runs and a link for pagination.", "properties": { "value": { "type": "array", "description": "The ScenarioRun items on this page", "items": { "$ref": "#/definitions/ScenarioRun" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ScenarioRunProperties": { "type": "object", "description": "Model that represents the properties of the scenario run.", "properties": { "workspaceName": { "type": "string", "description": "The workspace name.", "readOnly": true }, "scenarioName": { "type": "string", "description": "The scenario name.", "readOnly": true }, "scenarioConfigurationName": { "type": "string", "description": "The scenario configuration name.", "readOnly": true }, "managedIdentityPrincipalId": { "type": "string", "description": "The principal id for the managed identity used for the run.", "readOnly": true }, "resourceSnapshotId": { "type": "string", "description": "The resource snapshot ID this run is pinned to. Resolved from the scenario's\npinned evaluation snapshot (template scenarios) or the latest discovery\nsnapshot (custom scenarios) at run creation, ensuring the run executes against\nthe same set of discovered resources that produced the recommendation.", "readOnly": true }, "status": { "$ref": "#/definitions/ScenarioRunState", "description": "The scenario run status.", "readOnly": true }, "resources": { "type": "array", "description": "All resources discovered for the scenario run.", "items": { "$ref": "#/definitions/ScenarioRunResource" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "excludedResources": { "type": "array", "description": "Resources that matched the scenario's target resource types but were excluded\nfrom fault injection by the configuration's resource-targeting filters\n(for example zone, location, or explicit exclusions). These resources will not be impacted by the run.", "items": { "$ref": "#/definitions/ScenarioRunResource" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "errors": { "type": "array", "description": "System or infrastructure errors encountered during the scenario run.", "items": { "$ref": "#/definitions/OperationError" }, "readOnly": true, "x-ms-identifiers": [] }, "warnings": { "type": "array", "description": "Customer-actionable warnings encountered during the scenario run.", "items": { "$ref": "#/definitions/ScenarioRunWarning" }, "readOnly": true, "x-ms-identifiers": [] }, "executionErrors": { "$ref": "#/definitions/ScenarioErrors", "description": "Business errors from fault injection — permission and resource state issues.", "readOnly": true }, "scenarioRunJson": { "type": "string", "description": "The scenario run json.", "readOnly": true }, "scenarioRunSummary": { "type": "array", "description": "The scenario run summary.", "items": { "$ref": "#/definitions/ScenarioRunSummaryAction" }, "readOnly": true, "x-ms-identifiers": [ "actionUrn" ] }, "startTime": { "type": "string", "format": "date-time", "description": "When the scenario run was started.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "When the scenario run was completed.", "readOnly": true }, "zoneResolution": { "$ref": "#/definitions/ZoneResolutionInfo", "description": "Zone resolution information. Present when the scenario configuration\nused physical zone targeting (`physicalZones`). Contains the mode,\nrequested physical zones, and per-subscription logical zone mappings.", "readOnly": true } }, "required": [ "workspaceName", "scenarioName", "scenarioConfigurationName", "managedIdentityPrincipalId", "status", "resources", "startTime" ] }, "ScenarioRunResource": { "type": "object", "description": "Model that represents the scenario run resource.", "properties": { "id": { "type": "string", "description": "The resource id.", "readOnly": true } }, "required": [ "id" ] }, "ScenarioRunState": { "type": "string", "description": "Enum of the scenario run state.", "enum": [ "Queued", "Resolving", "Generating", "Validating", "ValidationSucceeded", "Starting", "Preparing", "Running", "CleaningUp", "Canceling", "Canceled", "Succeeded", "PartiallySucceeded", "Failed" ], "x-ms-enum": { "name": "ScenarioRunState", "modelAsString": true, "values": [ { "name": "Queued", "value": "Queued", "description": "The scenario run has been queued and is waiting to start." }, { "name": "Resolving", "value": "Resolving", "description": "The scenario run is in the process of being resolved." }, { "name": "Generating", "value": "Generating", "description": "The scenario run is in the process of being generated." }, { "name": "Validating", "value": "Validating", "description": "The scenario run is in the process of being validated." }, { "name": "ValidationSucceeded", "value": "ValidationSucceeded", "description": "The scenario run validation has completed successfully." }, { "name": "Starting", "value": "Starting", "description": "The scenario run is in the process of being started." }, { "name": "Preparing", "value": "Preparing", "description": "The scenario run is in the process of being prepared." }, { "name": "Running", "value": "Running", "description": "The scenario run is in the process of running." }, { "name": "CleaningUp", "value": "CleaningUp", "description": "The scenario run is in the process of being cleaned up." }, { "name": "Canceling", "value": "Canceling", "description": "The scenario run is in the process of being canceled." }, { "name": "Canceled", "value": "Canceled", "description": "The scenario run has been canceled." }, { "name": "Succeeded", "value": "Succeeded", "description": "The scenario run has completed successfully." }, { "name": "PartiallySucceeded", "value": "PartiallySucceeded", "description": "The scenario run completed, but one or more actions failed and every one of those\nfailures was suppressed by the effective `failureBehavior`." }, { "name": "Failed", "value": "Failed", "description": "The scenario run has failed." } ] }, "readOnly": true }, "ScenarioRunSummaryAction": { "type": "object", "description": "Model that represents the scenario run action.", "properties": { "resources": { "type": "array", "description": "The resources associated with the specified action, including the concrete targets\nevaluated during execution.", "items": { "$ref": "#/definitions/ScenarioRunSummaryResource" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "actionUrn": { "type": "string", "description": "The urn for the given chaos action.", "readOnly": true }, "state": { "$ref": "#/definitions/ScenarioSummaryState", "description": "The state of the action.", "readOnly": true }, "startedAt": { "type": "string", "format": "date-time", "description": "When the action was started.", "readOnly": true }, "completedAt": { "type": "string", "format": "date-time", "description": "When the action was completed.", "readOnly": true }, "error": { "$ref": "#/definitions/ActionError", "description": "Structured information about the action failure.", "readOnly": true }, "failureSuppressed": { "type": "boolean", "description": "Whether this action's failure was suppressed by the effective `failureBehavior`\nand therefore did not fail the scenario run. Present only for actions in the\n`Failed` state; absent otherwise.", "readOnly": true } }, "required": [ "resources", "actionUrn", "state" ] }, "ScenarioRunSummaryResource": { "type": "object", "description": "Model that represents a resource associated with a scenario run action.", "properties": { "id": { "type": "string", "description": "The resource ID.", "readOnly": true }, "affectedResources": { "type": "array", "description": "The resources affected during action execution.", "items": { "$ref": "#/definitions/ScenarioRunEffectiveTarget" }, "readOnly": true, "x-ms-identifiers": [ "id" ] } }, "required": [ "id" ] }, "ScenarioRunTargetState": { "type": "string", "description": "Enum of the execution states for a concrete action target.", "enum": [ "Succeeded", "NotApplicable", "Skipped", "Failed" ], "x-ms-enum": { "name": "ScenarioRunTargetState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "The action completed successfully for the target." }, { "name": "NotApplicable", "value": "NotApplicable", "description": "Evaluation determined that the action cannot apply because the target lacks required\nproperties or capabilities, or does not satisfy the action criteria. For example,\na SQL server without failover configured." }, { "name": "Skipped", "value": "Skipped", "description": "The action applies, but execution intentionally made no change because the target is\nalready in the desired state or the change would not be safely recoverable. For example,\na virtual machine that is already shut down." }, { "name": "Failed", "value": "Failed", "description": "Evaluation, authorization, lookup, mutation, or cleanup failed for the target." } ] }, "readOnly": true }, "ScenarioRunWarning": { "type": "object", "description": "Customer-actionable warning associated with a scenario run.", "properties": { "code": { "type": "string", "description": "The stable code that identifies the warning.", "readOnly": true }, "message": { "type": "string", "description": "The customer-safe description of the warning.", "readOnly": true }, "details": { "type": "array", "description": "Additional customer-safe details about the warning.", "items": { "$ref": "#/definitions/ScenarioRunWarningDetail" }, "readOnly": true, "x-ms-identifiers": [] } }, "required": [ "code", "message" ] }, "ScenarioRunWarningDetail": { "type": "object", "description": "Additional information about a scenario run warning.", "properties": { "code": { "type": "string", "description": "The stable code that identifies the warning detail.", "readOnly": true }, "message": { "type": "string", "description": "The customer-safe description of the warning detail.", "readOnly": true }, "target": { "type": "string", "description": "The target associated with the warning detail.", "readOnly": true } }, "required": [ "code", "message" ] }, "ScenarioSummaryState": { "type": "string", "description": "Enum of the scenario run summary action state.", "enum": [ "Pending", "Starting", "Running", "Stopping", "Succeeded", "Canceling", "Canceled", "FailingOnError", "Failed", "Skipped" ], "x-ms-enum": { "name": "ScenarioSummaryState", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending", "description": "The action is pending and has not started." }, { "name": "Starting", "value": "Starting", "description": "The action is in the process of starting." }, { "name": "Running", "value": "Running", "description": "The action is in the process of running." }, { "name": "Stopping", "value": "Stopping", "description": "The action is in the process of stopping." }, { "name": "Succeeded", "value": "Succeeded", "description": "The action has completed successfully." }, { "name": "Canceling", "value": "Canceling", "description": "The action is in the process of being canceled." }, { "name": "Canceled", "value": "Canceled", "description": "The action has been canceled." }, { "name": "FailingOnError", "value": "FailingOnError", "description": "The action is failing due to an error." }, { "name": "Failed", "value": "Failed", "description": "The action has failed." }, { "name": "Skipped", "value": "Skipped", "description": "The action was skipped." } ] }, "readOnly": true }, "ScenarioTemplate": { "type": "object", "description": "Model that represents a built-in scenario template. A scenario template is a versioned,\nread-only blueprint published by Microsoft that can be used to create a scenario. Templates\nare the same shape as the scenarios they produce, so an action read from a template is valid\ninput to a scenario create.\n\nThe template is addressed without a version, and always describes its newest published\nversion. Address a specific version through the child versions resource.", "properties": { "properties": { "$ref": "#/definitions/ScenarioTemplateProperties", "description": "The properties of the scenario template's newest published version." } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ScenarioTemplateListResult": { "type": "object", "description": "Model that represents a list of scenario templates and a link for pagination.", "properties": { "value": { "type": "array", "description": "The ScenarioTemplate items on this page", "items": { "$ref": "#/definitions/ScenarioTemplate" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ScenarioTemplateProperties": { "type": "object", "description": "Model that represents the properties of a scenario template. These are the properties of the\ntemplate's newest published version, together with the version number that identifies it.", "properties": { "latestVersion": { "type": "string", "description": "The newest published version of the template, for example 1.2. This is the version whose\ncontent the remaining properties describe, and the version a scenario records when it is\ncreated from the template without naming one.", "readOnly": true }, "displayName": { "type": "string", "description": "Localized display name of the template.", "readOnly": true }, "description": { "type": "string", "description": "Description of what the template does, and what resilience question it answers.", "readOnly": true }, "parameters": { "type": "array", "description": "Parameter definitions the template accepts. Values are supplied when the scenario created\nfrom this template is configured, and are referenced from an action through the\n`%%\\{parameters.\\\\}%%` macro.", "items": { "$ref": "#/definitions/ScenarioParameter" }, "readOnly": true, "x-ms-identifiers": [ "name" ] }, "actions": { "type": "array", "description": "The actions that define the template's orchestration. These are the same model a scenario\npublishes, and carry unresolved `%%\\{...\\}%%` macros; the macros are substituted when the\nscenario runs, not when it is read or created.\n\nThree macro namespaces may appear:\n\n- `%%\\{parameters.\\\\}%%` — resolves from the parameter values supplied when the\nscenario is configured. The accepted names are declared by `parameters`.\n- `%%\\{resourceTargeting.include.\\\\}%%` — resolves from the resource targeting\nof the scenario's configuration (for example `zones`, `locations`). The template does not\ndeclare these; they are dimensions of the configuration supplied at run time.\n- `%%\\{filters.\\\\}%%` — deprecated spelling of `resourceTargeting.include.`,\nretained only so that superseded template versions keep resolving. Do not depend on it;\nthe newest version of every template uses `resourceTargeting.include.`.\n\nAn action's `failureBehavior` overrides the template-wide `failureBehavior` for that action\nalone; an action that does not carry one inherits the template-wide value.", "minItems": 1, "items": { "$ref": "#/definitions/ScenarioAction" }, "readOnly": true, "x-ms-identifiers": [ "name" ] }, "failureBehavior": { "$ref": "#/definitions/FailureBehavior", "description": "Template-wide default for how a scenario run reacts when one of this template's actions\nfails. An action that does not carry its own `failureBehavior` inherits this value; when\nneither is present the effective behavior is `Stop`.\n\nA scenario created from this template takes this policy with the rest of the template's\nstructure, so it is also the scenario's resolved `failureBehavior`. Template versions\npublished before this policy existed do not carry one and report it as absent, which the\nrun resolves as `Stop`.", "readOnly": true } }, "required": [ "latestVersion", "actions" ] }, "ScenarioTemplateVersion": { "type": "object", "description": "Model that represents a single published version of a scenario template. A published version\nis immutable: corrections are shipped as a new version rather than by changing an existing\none, so a scenario that records the version it was created from always resolves to the same\ncontent.", "properties": { "properties": { "$ref": "#/definitions/ScenarioTemplateVersionProperties", "description": "The properties of the scenario template version." } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ScenarioTemplateVersionListResult": { "type": "object", "description": "Model that represents a list of scenario template versions and a link for pagination.", "properties": { "value": { "type": "array", "description": "The ScenarioTemplateVersion items on this page", "items": { "$ref": "#/definitions/ScenarioTemplateVersion" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ScenarioTemplateVersionProperties": { "type": "object", "description": "Model that represents the properties of a single published version of a scenario template —\nthe blueprint content itself.", "properties": { "displayName": { "type": "string", "description": "Localized display name of the template.", "readOnly": true }, "description": { "type": "string", "description": "Description of what the template does, and what resilience question it answers.", "readOnly": true }, "parameters": { "type": "array", "description": "Parameter definitions the template accepts. Values are supplied when the scenario created\nfrom this template is configured, and are referenced from an action through the\n`%%\\{parameters.\\\\}%%` macro.", "items": { "$ref": "#/definitions/ScenarioParameter" }, "readOnly": true, "x-ms-identifiers": [ "name" ] }, "actions": { "type": "array", "description": "The actions that define the template's orchestration. These are the same model a scenario\npublishes, and carry unresolved `%%\\{...\\}%%` macros; the macros are substituted when the\nscenario runs, not when it is read or created.\n\nThree macro namespaces may appear:\n\n- `%%\\{parameters.\\\\}%%` — resolves from the parameter values supplied when the\nscenario is configured. The accepted names are declared by `parameters`.\n- `%%\\{resourceTargeting.include.\\\\}%%` — resolves from the resource targeting\nof the scenario's configuration (for example `zones`, `locations`). The template does not\ndeclare these; they are dimensions of the configuration supplied at run time.\n- `%%\\{filters.\\\\}%%` — deprecated spelling of `resourceTargeting.include.`,\nretained only so that superseded template versions keep resolving. Do not depend on it;\nthe newest version of every template uses `resourceTargeting.include.`.\n\nAn action's `failureBehavior` overrides the template-wide `failureBehavior` for that action\nalone; an action that does not carry one inherits the template-wide value.", "minItems": 1, "items": { "$ref": "#/definitions/ScenarioAction" }, "readOnly": true, "x-ms-identifiers": [ "name" ] }, "failureBehavior": { "$ref": "#/definitions/FailureBehavior", "description": "Template-wide default for how a scenario run reacts when one of this template's actions\nfails. An action that does not carry its own `failureBehavior` inherits this value; when\nneither is present the effective behavior is `Stop`.\n\nA scenario created from this template takes this policy with the rest of the template's\nstructure, so it is also the scenario's resolved `failureBehavior`. Template versions\npublished before this policy existed do not carry one and report it as absent, which the\nrun resolves as `Stop`.", "readOnly": true } }, "required": [ "actions" ] }, "ScenarioValidationState": { "type": "string", "description": "Enum of the scenario validation state.", "enum": [ "Resolving", "Generating", "Validating", "Accepted", "NotStarted", "RequiresAttention", "NoResolvedResources", "Succeeded" ], "x-ms-enum": { "name": "ScenarioValidationState", "modelAsString": true, "values": [ { "name": "Resolving", "value": "Resolving", "description": "The scenario validation is in a resolving state." }, { "name": "Generating", "value": "Generating", "description": "The scenario validation is in a generating state." }, { "name": "Validating", "value": "Validating", "description": "The scenario validation is in a validating state." }, { "name": "Accepted", "value": "Accepted", "description": "The scenario validation has been accepted." }, { "name": "NotStarted", "value": "NotStarted", "description": "The scenario validation has not yet started." }, { "name": "RequiresAttention", "value": "RequiresAttention", "description": "The scenario validation reflects a state that requires attention.\nThis is a terminal failure state indicating validation issues were found." }, { "name": "NoResolvedResources", "value": "NoResolvedResources", "description": "The scenario validation found no valid resources to perform fault behaviors against.\nThis is a terminal failure state." }, { "name": "Succeeded", "value": "Succeeded", "description": "The scenario validation completed successfully and the scenario is ready to execute." } ] }, "readOnly": true }, "SelectorType": { "type": "string", "description": "Enum of the selector type.", "enum": [ "List", "Query" ], "x-ms-enum": { "name": "SelectorType", "modelAsString": true, "values": [ { "name": "List", "value": "List", "description": "List selector type." }, { "name": "Query", "value": "Query", "description": "Query selector type." } ] } }, "StepStatus": { "type": "object", "description": "Model that represents the a list of branches and branch statuses.", "properties": { "stepName": { "type": "string", "description": "The name of the step.", "readOnly": true }, "stepId": { "type": "string", "description": "The id of the step.", "readOnly": true }, "status": { "type": "string", "description": "The value of the status of the step.", "readOnly": true }, "branches": { "type": "array", "description": "The array of branches.", "items": { "$ref": "#/definitions/BranchStatus" }, "readOnly": true, "x-ms-identifiers": [ "branchName" ] } } }, "Target": { "type": "object", "description": "Model that represents a Target resource.", "properties": { "properties": { "type": "object", "description": "The properties of the target resource.", "additionalProperties": {}, "x-ms-client-flatten": true }, "location": { "$ref": "#/definitions/Azure.Core.azureLocation", "description": "Azure resource location.", "x-ms-mutability": [ "read", "create" ] } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "TargetListResult": { "type": "object", "description": "Model that represents a list of Target resources and a link for pagination.", "properties": { "value": { "type": "array", "description": "The Target items on this page", "items": { "$ref": "#/definitions/Target" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "TargetReference": { "type": "object", "description": "Model that represents a reference to a Target in the selector.", "properties": { "type": { "$ref": "#/definitions/TargetReferenceType", "description": "Enum of the Target reference type." }, "id": { "type": "string", "format": "arm-id", "description": "String of the resource ID of a Target resource." } }, "required": [ "type", "id" ] }, "TargetReferenceType": { "type": "string", "description": "Enum of the Target reference type.", "enum": [ "ChaosTarget" ], "x-ms-enum": { "name": "TargetReferenceType", "modelAsString": true, "values": [ { "name": "ChaosTarget", "value": "ChaosTarget", "description": "Chaos target reference type." } ] } }, "TargetType": { "type": "object", "description": "Model that represents a Target Type resource.", "properties": { "properties": { "$ref": "#/definitions/TargetTypeProperties", "description": "The properties of the target type resource.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "TargetTypeListResult": { "type": "object", "description": "Model that represents a list of Target Type resources and a link for pagination.", "properties": { "value": { "type": "array", "description": "The TargetType items on this page", "items": { "$ref": "#/definitions/TargetType" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "TargetTypeProperties": { "type": "object", "description": "Model that represents the base Target Type properties model.", "properties": { "displayName": { "type": "string", "description": "Localized string of the display name.", "readOnly": true }, "description": { "type": "string", "description": "Localized string of the description.", "readOnly": true }, "propertiesSchema": { "type": "string", "description": "URL to retrieve JSON schema of the Target Type properties.", "maxLength": 2048, "readOnly": true }, "resourceTypes": { "type": "array", "description": "List of resource types this Target Type can extend.", "items": { "type": "string" }, "readOnly": true } } }, "TemplateEvaluationResultItem": { "type": "object", "description": "Model that represents a single template evaluation result.", "properties": { "templateId": { "type": "string", "format": "arm-id", "description": "The canonical ARM ID of the evaluated scenario-template version. Scenario IDs and versionless template aliases are not valid substitutes.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Chaos/scenarioTemplates/versions" } ] } }, "templateName": { "type": "string", "description": "The stable catalog name of the evaluated scenario template, not a localized display name.", "minLength": 1, "readOnly": true }, "evaluationResult": { "$ref": "#/definitions/RecommendationStatus", "description": "The evaluation result for this template." } }, "required": [ "templateId", "templateName", "evaluationResult" ] }, "Validation": { "type": "object", "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/ValidationProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ValidationProperties": { "type": "object", "description": "Model that represents the properties of the scenario validation.", "properties": { "status": { "$ref": "#/definitions/ScenarioValidationState", "description": "The scenario validation status.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The scenario validation UTC start time.", "readOnly": true }, "executionPlanJson": { "type": "string", "description": "Execution plan created from validation. This plan will be executed as-is on next scenario execution." }, "endTime": { "type": "string", "format": "date-time", "description": "The scenario validation UTC end time.", "readOnly": true }, "resources": { "type": "array", "description": "Resources that matched the scenario's target resource types and will be impacted\nby the run, resolved after applying the configuration's resource-targeting filters.", "items": { "$ref": "#/definitions/ScenarioRunResource" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "excludedResources": { "type": "array", "description": "Resources that matched the scenario's target resource types but were excluded\nfrom fault injection by the configuration's resource-targeting filters\n(for example zone, location, or explicit exclusions). These resources will not be impacted.", "items": { "$ref": "#/definitions/ScenarioRunResource" }, "readOnly": true, "x-ms-identifiers": [ "id" ] }, "errors": { "type": "array", "description": "System or infrastructure errors encountered during validation.", "items": { "$ref": "#/definitions/OperationError" }, "readOnly": true, "x-ms-identifiers": [] }, "validationErrors": { "$ref": "#/definitions/ScenarioErrors", "description": "Business errors from validation — permission and resource state issues." } }, "required": [ "status", "startTime" ] }, "Workspace": { "type": "object", "description": "Model that represents a Workspace resource.", "properties": { "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." }, "properties": { "$ref": "#/definitions/WorkspaceProperties", "description": "The properties of the Workspace resource.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "WorkspaceCustomerManagedKeyEncryption": { "type": "object", "description": "A customer-managed key reference, not key material.", "properties": { "keyEncryptionKeyUrl": { "$ref": "#/definitions/WorkspaceKeyEncryptionKeyUrl", "description": "The versionless HTTPS Key Vault key URI in the supported cloud and Workspace\ntenant. The key vault must belong to the same Microsoft Entra tenant as\nthe Workspace. Its HTTPS origin must match the vault referenced by\nkeyVaultResourceId. The service validates the effective pair and caller\nvault-read permission synchronously through Azure Resource Manager before\ncreating public operation metadata, accepting the configuration operation,\npersisting requested encryption, or changing Storage or customer data.\nSupports RSA keys in Azure Key Vault and RSA-HSM keys in Premium Key Vault,\nwith key sizes of 2048, 3072, or 4096 bits. Premium RSA-HSM keys use the same\nvault URL. The separate Azure Managed HSM service is not supported;\nManaged HSM endpoints are rejected before operation acceptance.\nA key version, query string, or fragment is not permitted.\nAzure Storage follows key versions automatically. Keep the previous version\navailable for at least 24 hours after rotation." }, "keyVaultResourceId": { "type": "string", "format": "arm-id", "description": "The fully qualified Azure resource ID of the key vault that contains the key.\nUse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName},\nnot a key child resource, Managed HSM, or URL. Full PUT with CMK and PATCH\nthat changes either CMK member require Microsoft.KeyVault/vaults/read on\nthe effective vault. The service compares its canonical ID, tenant, and\nvault URI with the requested pair before accepting the operation.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.KeyVault/vaults" } ] } } }, "required": [ "keyEncryptionKeyUrl", "keyVaultResourceId" ] }, "WorkspaceCustomerManagedKeyEncryptionPatchMergePatchUpdateOrCreate": { "type": "object", "description": "A partial customer key reference, validated after merging with the stored setting.", "properties": { "keyEncryptionKeyUrl": { "$ref": "#/definitions/WorkspaceKeyEncryptionKeyUrl", "description": "The replacement versionless key URI. Omission retains the URI; null deletes\nit. A same-vault replacement retains the stored vault ID. The effective\npair is authorized and validated before acceptance; an incomplete or\nmismatched pair is rejected. Key path and name casing is preserved.", "x-nullable": true }, "keyVaultResourceId": { "type": "string", "format": "arm-id", "description": "The vault resource ID to merge with the key URL. Omission retains the ID,\nbut does not bypass caller authorization when the URL changes. Null deletes\nthe ID; a remaining CMK object without both members is invalid. Changing\nvault requires a coherent new URL and ID pair.", "x-nullable": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.KeyVault/vaults" } ] } } } }, "WorkspaceCustomerManagedKeyOnboarding": { "type": "object", "description": "The service application that the customer authorizes to use the key.", "properties": { "applicationId": { "type": "string", "description": "The Microsoft Entra application ID used for customer consent, returned for\nexisting Workspaces, including Microsoft-managed Workspaces. This does not\npermit adding CMK to an existing Microsoft-managed Workspace. Before\ncreating a Workspace with a customer key, obtain the application name and\nID for the target cloud from the service onboarding documentation or Portal,\nthen consent and grant key access. The configuring caller separately needs\nMicrosoft.KeyVault/vaults/read on the referenced vault.\nGET returns the same application ID.\nThis is not a service principal object ID or an identity selector.\nThe Workspace's top-level identity does not select this application.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true } }, "required": [ "applicationId" ] }, "WorkspaceDiscovery": { "type": "object", "description": "A retained workspace discovery result and its accepted coverage facts.", "properties": { "properties": { "$ref": "#/definitions/WorkspaceDiscoveryProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "WorkspaceDiscoveryAccessWarning": { "type": "object", "description": "Neutral guidance when access versus absence could not be established.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "The affected resource or member identity.", "readOnly": true } }, "required": [ "resourceId" ], "allOf": [ { "$ref": "#/definitions/WorkspaceDiscoveryWarning" } ], "x-ms-discriminator-value": "AccessIndeterminate" }, "WorkspaceDiscoveryCompleteness": { "type": "string", "description": "The coverage classification of the accepted Azure Resource Manager discovery result, independent of operation status and cause.", "enum": [ "Established", "BaselineUnknown", "VerificationIncomplete", "KnownPartial" ], "x-ms-enum": { "name": "WorkspaceDiscoveryCompleteness", "modelAsString": true, "values": [ { "name": "Established", "value": "Established", "description": "All attainable expected resource occurrences were classified and represented, with no observed shortfall." }, { "name": "BaselineUnknown", "value": "BaselineUnknown", "description": "Required work completed without an observed gap, but a complete inventory denominator is structurally unavailable." }, { "name": "VerificationIncomplete", "value": "VerificationIncomplete", "description": "Required system verification did not complete or a proven accessible required resource was not represented." }, { "name": "KnownPartial", "value": "KnownPartial", "description": "Confirmed undelivered obligations remain and no required system-verification gap remains." } ] } }, "WorkspaceDiscoveryCount": { "type": "integer", "format": "int64", "description": "A nonnegative count of the named discovery coverage unit. No resource-count maximum is defined.", "minimum": 0 }, "WorkspaceDiscoveryCoverageSummary": { "type": "object", "description": "Aggregate coverage of expanded Azure Resource Manager scope occurrences. Non-Azure Resource Manager discovery ingress is outside this population. VerificationIncomplete dominates KnownPartial, then BaselineUnknown, then Established.", "properties": { "scopes": { "$ref": "#/definitions/WorkspaceDiscoveryScopeCoverageSummary", "description": "The scope-occurrence coverage partitions for this discovery result.", "readOnly": true }, "resources": { "$ref": "#/definitions/WorkspaceDiscoveryResourceCoverageSummary", "description": "Required resource occurrences only from scopes with a known complete expected inventory set. Absent exactly when knownExpectedSetCount is zero. Unknown is not a known empty set.", "readOnly": true } }, "required": [ "scopes" ] }, "WorkspaceDiscoveryListResult": { "type": "object", "description": "The response of a WorkspaceDiscovery list operation.", "properties": { "value": { "type": "array", "description": "The WorkspaceDiscovery items on this page", "items": { "$ref": "#/definitions/WorkspaceDiscovery" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "WorkspaceDiscoveryPermissionWarning": { "type": "object", "description": "Confirmed read-authorization guidance. Permission details are required composition, not an optional shell reused for other causes.", "properties": { "permission": { "$ref": "#/definitions/PermissionError", "description": "The affected resource, required permissions, recommended roles, and optional identity details.", "readOnly": true } }, "required": [ "permission" ], "allOf": [ { "$ref": "#/definitions/WorkspaceDiscoveryWarning" } ], "x-ms-discriminator-value": "RbacValidationFailed" }, "WorkspaceDiscoveryProperties": { "type": "object", "description": "Model that represents the properties of the workspace discovery.", "properties": { "status": { "$ref": "#/definitions/WorkspaceDiscoveryStatus", "description": "The discovery status.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The discovery UTC start time.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The discovery UTC end time.", "readOnly": true }, "errors": { "type": "array", "description": "System or infrastructure errors encountered during discovery.", "items": { "$ref": "#/definitions/OperationError" }, "readOnly": true, "x-ms-identifiers": [] }, "workspaceId": { "type": "string", "format": "arm-id", "description": "The workspace ID this discovery belongs to.", "readOnly": true }, "resourceSnapshotId": { "type": "string", "description": "The resource snapshot ID produced by this discovery.", "readOnly": true }, "completeness": { "$ref": "#/definitions/WorkspaceDiscoveryCompleteness", "description": "The coverage established by the accepted discovery result for Azure Resource Manager scopes. Present with coverageSummary on newly produced snapshot results; absence is not Established or a known zero.", "readOnly": true }, "coverageSummary": { "$ref": "#/definitions/WorkspaceDiscoveryCoverageSummary", "description": "Coverage facts for the accepted result. Scope counts, resource-occurrence counts, warning counts, and returned inventory-row counts are different units and must not be combined.", "readOnly": true }, "warnings": { "type": "array", "description": "Confirmed access, missing-resource, or access-indeterminate guidance. System verification failures are reported in errors, not as permission warnings. The returned array may be a subset; use warningsTotalCount and warningsTruncated.", "items": { "$ref": "#/definitions/WorkspaceDiscoveryWarning" }, "readOnly": true, "x-ms-identifiers": [] }, "warningsTotalCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The deduplicated number of warning identities before sampling. Identity consists of the expanded scope, affected resource, and reason. Absent means no accepted warning population was recorded, not zero warnings.", "readOnly": true }, "warningsTruncated": { "type": "boolean", "description": "Whether warnings contains fewer entries than warningsTotalCount. False requires equality; true requires a smaller returned array. An accepted empty warning population is an empty array, zero total, and false.", "readOnly": true } }, "required": [ "status", "workspaceId" ] }, "WorkspaceDiscoveryResourceCoverageSummary": { "type": "object", "description": "Required resource occurrences from known-set scopes, keyed by normalized scope and resource before global inventory-row deduplication. classifiedCount plus unclassifiedCount equals expectedCount, and coveredCount does not exceed classifiedCount.", "properties": { "expectedCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of unique required resource occurrences across known-set scopes, not the number of service-group container members or listed inventory rows.", "readOnly": true }, "classifiedCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of expected occurrences with a terminal access or presence classification.", "readOnly": true }, "unclassifiedCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of expected occurrences that required system verification could not classify.", "readOnly": true }, "coveredCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of classified expected occurrences actually represented in the produced snapshot. Access to a container or its descendants does not invent a resource occurrence.", "readOnly": true } }, "required": [ "expectedCount", "classifiedCount", "unclassifiedCount", "coveredCount" ] }, "WorkspaceDiscoveryResourceWarning": { "type": "object", "description": "Guidance for a resource or membership confirmed missing.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "The affected resource or member identity.", "readOnly": true } }, "required": [ "resourceId" ], "allOf": [ { "$ref": "#/definitions/WorkspaceDiscoveryWarning" } ], "x-ms-discriminator-value": "TargetNotFound" }, "WorkspaceDiscoveryScopeCoverageSummary": { "type": "object", "description": "Two independent partitions of expanded scope occurrences after normalized-scope deduplication. Distinct service groups remain distinct even if their members coincide. The known/unknown counts and the four completeness counts each sum to totalCount.", "properties": { "totalCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of expanded Azure Resource Manager scope occurrences represented by the result.", "readOnly": true }, "knownExpectedSetCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of scopes with an authoritative complete expected resource-occurrence set, including authoritatively empty sets.", "readOnly": true }, "unknownExpectedSetCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of scopes whose complete expected inventory set is unavailable. A service group's known subscription or resource-group membership does not establish its descendant-resource denominator.", "readOnly": true }, "establishedCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of scopes with Established coverage.", "readOnly": true }, "baselineUnknownCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of scopes with a structurally unavailable denominator and no observed shortfall, including successful observed-empty container scans.", "readOnly": true }, "verificationIncompleteCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of scopes with required verification failure, unavailable required child enumeration, or a proven accessible required resource absent from the snapshot.", "readOnly": true }, "knownPartialCount": { "$ref": "#/definitions/WorkspaceDiscoveryCount", "description": "The number of scopes with confirmed undelivered obligations and no remaining system-verification gap.", "readOnly": true } }, "required": [ "totalCount", "knownExpectedSetCount", "unknownExpectedSetCount", "establishedCount", "baselineUnknownCount", "verificationIncompleteCount", "knownPartialCount" ] }, "WorkspaceDiscoveryStatus": { "type": "string", "description": "Enum of the workspace discovery status.", "enum": [ "Pending", "Queued", "InProgress", "Succeeded", "PartiallySucceeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "WorkspaceDiscoveryStatus", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending", "description": "The discovery is pending and has not started." }, { "name": "Queued", "value": "Queued", "description": "The discovery has been accepted and is queued for execution." }, { "name": "InProgress", "value": "InProgress", "description": "The discovery is in progress." }, { "name": "Succeeded", "value": "Succeeded", "description": "The discovery completed successfully." }, { "name": "PartiallySucceeded", "value": "PartiallySucceeded", "description": "Discovery produced an admissible result with an observed coverage shortfall. This status does not itself block scenario runs or evaluations; consumers requiring established coverage must also check completeness." }, { "name": "Failed", "value": "Failed", "description": "The discovery failed." }, { "name": "Canceled", "value": "Canceled", "description": "The discovery was canceled." } ] }, "readOnly": true }, "WorkspaceDiscoveryWarning": { "type": "object", "description": "The common fields of a discovery guidance warning, discriminated by reason. Known reasons use their corresponding subtype; unknown future reasons retain these base fields.", "properties": { "scopeId": { "type": "string", "format": "arm-id", "description": "The normalized expanded source scope where the affected obligation was encountered.", "readOnly": true }, "scopeKind": { "type": "string", "description": "The source scope kind, such as Subscription, ResourceGroup, ServiceGroup, or Resource.", "readOnly": true }, "reason": { "$ref": "#/definitions/WorkspaceDiscoveryWarningReason", "description": "The confirmed guidance reason, not a system-verification failure.", "readOnly": true }, "message": { "type": "string", "description": "Human-readable guidance with attribution appropriate to the reason.", "readOnly": true } }, "discriminator": "reason", "required": [ "scopeId", "scopeKind", "reason", "message" ] }, "WorkspaceDiscoveryWarningReason": { "type": "string", "description": "The confirmed guidance reason. Unknown future reasons preserve the common warning fields and must not be interpreted as a permission denial.", "enum": [ "RbacValidationFailed", "TargetNotFound", "AccessIndeterminate" ], "x-ms-enum": { "name": "WorkspaceDiscoveryWarningReason", "modelAsString": true, "values": [ { "name": "RbacValidationFailed", "value": "RbacValidationFailed", "description": "The affected resource could not be read because of a confirmed authorization denial." }, { "name": "TargetNotFound", "value": "TargetNotFound", "description": "The affected resource or configured membership was confirmed missing." }, { "name": "AccessIndeterminate", "value": "AccessIndeterminate", "description": "Access versus absence could not be determined; guidance must state both possibilities." } ] } }, "WorkspaceEncryption": { "type": "object", "description": "The validated requested key and vault reference, onboarding information, and service observations.", "properties": { "customerManagedKeyEncryption": { "$ref": "#/definitions/WorkspaceCustomerManagedKeyEncryption", "description": "The requested customer-managed key. Its presence is fixed by accepted\nWorkspace creation: adding CMK to a Microsoft-managed Workspace or removing\nCMK from a CMK-created Workspace is rejected with InvalidEncryptionConfiguration.\nThe key pair remains updateable on CMK-created Workspaces, including after\na failed creation. A present object requires a coherent keyEncryptionKeyUrl and\nkeyVaultResourceId pair. After synchronous caller and vault validation,\nthe accepted pair can be returned while configuration is Pending.\nIt does not prove that active data already uses the requested key." }, "customerManagedKeyOnboarding": { "$ref": "#/definitions/WorkspaceCustomerManagedKeyOnboarding", "description": "The service application to authorize before creating a new CMK Workspace; also returned for existing Workspaces.", "readOnly": true }, "status": { "$ref": "#/definitions/WorkspaceEncryptionStatus", "description": "The observed result, separate from the requested setting.", "readOnly": true } } }, "WorkspaceEncryptionPatchMergePatchUpdateOrCreate": { "type": "object", "description": "A partial encryption setting. Omitted fields are unchanged and null deletes a\nwritable field. A remaining customerManagedKeyEncryption object must have a\ncoherent key URL and vault resource ID. Read-only onboarding and status\ninputs are ignored. The accepted creation choice cannot change. Only a\nCMK-created Workspace can update the pair. Changing either member requires synchronous caller and\nvault validation of the merged pair, including any retained member.", "properties": { "customerManagedKeyEncryption": { "$ref": "#/definitions/WorkspaceCustomerManagedKeyEncryptionPatchMergePatchUpdateOrCreate", "description": "The customer key configuration to merge on a CMK-created Workspace.\nNull deletion is rejected on CMK and is a no-op only when already absent\non a Microsoft-managed Workspace. An empty object retains an existing\ncomplete pair without a lookup when neither member changes, but is invalid\nwhen the merged pair is incomplete. Unsupported mode changes are rejected\nbefore vault lookup, operation creation, desired mutation, or Storage effects.", "x-nullable": true } } }, "WorkspaceEncryptionProtection": { "type": "string", "description": "The last directly observed protection of active Workspace customer data.", "enum": [ "CustomerManaged", "MicrosoftManaged" ], "x-ms-enum": { "name": "WorkspaceEncryptionProtection", "modelAsString": true, "values": [ { "name": "CustomerManaged", "value": "CustomerManaged", "description": "Active customer data uses customer-managed key protection." }, { "name": "MicrosoftManaged", "value": "MicrosoftManaged", "description": "Active customer data uses Microsoft-managed key protection." } ] } }, "WorkspaceEncryptionState": { "type": "string", "description": "The observed encryption state; this does not replace Workspace provisioningState.", "enum": [ "NotConfigured", "Pending", "Applied", "Failed", "Unknown" ], "x-ms-enum": { "name": "WorkspaceEncryptionState", "modelAsString": true, "values": [ { "name": "NotConfigured", "value": "NotConfigured", "description": "No per-Workspace encryption configuration exists. Microsoft-managed protection applies." }, { "name": "Pending", "value": "Pending", "description": "An encryption configuration operation is in progress." }, { "name": "Applied", "value": "Applied", "description": "A fresh check confirms the requested customer key and scoped customer-data access." }, { "name": "Failed", "value": "Failed", "description": "An encryption configuration step or health check failed. See the error for corrective action." }, { "name": "Unknown", "value": "Unknown", "description": "No usable fresh observation is available." } ] } }, "WorkspaceEncryptionStatus": { "type": "object", "description": "Service observations of protection and access for customer data under the Workspace encryption scope.", "properties": { "state": { "$ref": "#/definitions/WorkspaceEncryptionState", "description": "The result of configuration or the most recent usable health observation.", "readOnly": true }, "observedProtection": { "$ref": "#/definitions/WorkspaceEncryptionProtection", "description": "The last directly observed active protection. Omitted when unknown.", "readOnly": true }, "observedKeyEncryptionKeyUrl": { "type": "string", "format": "uri", "description": "The active key URI reported by Azure Storage, including its version when\navailable. Omitted when unknown or when protection is Microsoft-managed.\nThis value is not inferred from the requested key.", "readOnly": true }, "lastCheckedAt": { "type": "string", "format": "date-time", "description": "The UTC time of the observation, including a failed check.", "readOnly": true }, "error": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "The configuration or health error. Failed state includes a code and message.\nCustomerKeyAccessFailed means Azure Storage cannot use the customer key.\nEncryptionConfigurationFailed means a service-side configuration step failed.\nA more specific cause is included only when the platform response identifies it.", "readOnly": true } }, "required": [ "state" ] }, "WorkspaceEvaluation": { "type": "object", "description": "A retained workspace evaluation of published scenario-template versions.", "properties": { "properties": { "$ref": "#/definitions/WorkspaceEvaluationProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "WorkspaceEvaluationListResult": { "type": "object", "description": "The response of a WorkspaceEvaluation list operation.", "properties": { "value": { "type": "array", "description": "The WorkspaceEvaluation items on this page", "items": { "$ref": "#/definitions/WorkspaceEvaluation" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "WorkspaceEvaluationProperties": { "type": "object", "description": "Model that represents the properties of the workspace evaluation.", "properties": { "status": { "$ref": "#/definitions/WorkspaceEvaluationStatus", "description": "The evaluation status.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The evaluation UTC start time.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The evaluation UTC end time.", "readOnly": true }, "errors": { "type": "array", "description": "System or infrastructure errors encountered during evaluation.", "items": { "$ref": "#/definitions/OperationError" }, "readOnly": true, "x-ms-identifiers": [] }, "workspaceId": { "type": "string", "format": "arm-id", "description": "The workspace ID this evaluation belongs to.", "readOnly": true }, "resourceSnapshotId": { "type": "string", "description": "The resource snapshot ID used for this evaluation.", "readOnly": true }, "discoveryResultId": { "type": "string", "format": "arm-id", "description": "The canonical Azure resource ID of the retained discovery result that supplied resourceSnapshotId. This reference does not change when the latest discovery changes and never identifies the latest alias or a protected LRO polling handle.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Chaos/workspaces/discoveries" } ] } }, "numTemplatesToEvaluate": { "type": "integer", "format": "int32", "description": "The number of templates to evaluate.", "minimum": 0, "readOnly": true }, "numTemplatesEvaluatedSucceeded": { "type": "integer", "format": "int32", "description": "The number of templates that evaluated successfully.", "minimum": 0, "readOnly": true }, "numTemplatesEvaluatedFailed": { "type": "integer", "format": "int32", "description": "The number of templates that failed evaluation.", "minimum": 0, "readOnly": true }, "numTemplatesEvaluatedCancelled": { "type": "integer", "format": "int32", "description": "The number of templates that were cancelled during evaluation.", "minimum": 0, "readOnly": true }, "results": { "type": "array", "description": "Per-template evaluation results.", "items": { "$ref": "#/definitions/TemplateEvaluationResultItem" }, "readOnly": true, "x-ms-client-name": "Results", "x-ms-identifiers": [ "templateId" ] } }, "required": [ "status", "workspaceId", "resourceSnapshotId", "discoveryResultId", "numTemplatesToEvaluate", "numTemplatesEvaluatedSucceeded", "numTemplatesEvaluatedFailed", "numTemplatesEvaluatedCancelled" ] }, "WorkspaceEvaluationStatus": { "type": "string", "description": "Enum of the workspace evaluation status.", "enum": [ "Pending", "Queued", "InProgress", "Succeeded", "PartiallySucceeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "WorkspaceEvaluationStatus", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending", "description": "The evaluation is pending and has not started." }, { "name": "Queued", "value": "Queued", "description": "The evaluation has been accepted and is queued for execution." }, { "name": "InProgress", "value": "InProgress", "description": "The evaluation is in progress." }, { "name": "Succeeded", "value": "Succeeded", "description": "The evaluation completed successfully." }, { "name": "PartiallySucceeded", "value": "PartiallySucceeded", "description": "Unless cancellation won terminal settlement, at least one template applicability test completed and at least one failed or was canceled. Discovery completeness does not determine this processing status. The first terminal settlement is authoritative; a later cancellation does not replace it." }, { "name": "Failed", "value": "Failed", "description": "No template applicability test completed and at least one failed, unless cancellation won terminal settlement. The accepted resource snapshot and discovery result reference remain present; an admission failure creates no evaluation result." }, { "name": "Canceled", "value": "Canceled", "description": "Cancellation won terminal settlement, or all admitted template tests were canceled. Previously recorded outcomes may remain. A later callback cannot replace this terminal result, and cancellation cannot replace an already settled result." } ] }, "readOnly": true }, "WorkspaceKeyEncryptionKeyUrl": { "type": "string", "format": "uri", "description": "A versionless HTTPS Azure Key Vault key URI, including Premium-vault RSA-HSM\nkeys. Azure Managed HSM endpoints are not supported. The service also\nvalidates the cloud host allowlist and tenant; a vault URL does not identify\nthe key type.", "pattern": "^https://[a-zA-Z0-9-]+\\.vault\\.[a-zA-Z0-9.-]+/keys/[a-zA-Z0-9-]+$" }, "WorkspaceListResult": { "type": "object", "description": "Model that represents a list of Workspace resources and a link for pagination.", "properties": { "value": { "type": "array", "description": "The Workspace items on this page", "items": { "$ref": "#/definitions/Workspace" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "WorkspaceProperties": { "type": "object", "description": "Model that represents the Workspace properties model.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Most recent provisioning state for the given Workspace resource.", "readOnly": true }, "scopes": { "type": "array", "description": "The intended workspace-level resource scope to be used by child scenarios.", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource." } }, "encryption": { "$ref": "#/definitions/WorkspaceEncryption", "description": "The requested customer key and service observations. Accepted creation fixes\nwhether customerManagedKeyEncryption is present. On PUT, omission of\nencryption or its CMK object, or an empty encryption object, is valid for\nMicrosoft-managed Workspaces but rejected for CMK-created Workspaces.\nNull is not a valid PUT value. A CMK-created Workspace can replace its key." } }, "required": [ "scopes" ] }, "WorkspaceUpdate": { "type": "object", "description": "Describes a workspace update.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." }, "properties": { "$ref": "#/definitions/WorkspaceUpdateProperties", "description": "The resource-specific fields to update. Omitted fields are unchanged." } } }, "WorkspaceUpdateProperties": { "type": "object", "description": "The Workspace properties supported by partial updates.", "properties": { "encryption": { "$ref": "#/definitions/WorkspaceEncryptionPatchMergePatchUpdateOrCreate", "description": "A JSON Merge Patch of the requested encryption setting. Omission leaves the\nsetting unchanged. Null deletion is rejected on a CMK-created Workspace\nand is a no-op only when the setting is already absent on a Microsoft-managed\nWorkspace. The service validates the creation choice and merged pair first.", "x-nullable": true } } }, "ZoneResolutionInfo": { "type": "object", "description": "Information about how physical zones were resolved to logical zones\nfor each subscription during scenario execution.", "properties": { "mode": { "$ref": "#/definitions/ZoneResolutionMode", "description": "The zone targeting mode used for this run.\n`logical` — customer specified logical zone identifiers directly.\n`physical` — customer specified physical zone identifiers; the system\nresolved them to per-subscription logical zones at execution time.", "readOnly": true }, "requestedPhysicalZones": { "type": "array", "description": "The physical zone identifiers requested by the customer in the\nscenario configuration (e.g., `[\"westus2-az1\"]`).\nEmpty array when `mode` is `logical`.", "items": { "type": "string" }, "readOnly": true }, "subscriptionZoneMappings": { "type": "array", "description": "Per-subscription zone resolution results. Each entry maps a subscription\nto the logical zone resolved from the requested physical zone.\nEmpty when `mode` is `logical`.", "items": { "$ref": "#/definitions/ZoneResolutionMapping" }, "readOnly": true, "x-ms-identifiers": [ "subscriptionId" ] } }, "required": [ "mode", "requestedPhysicalZones", "subscriptionZoneMappings" ] }, "ZoneResolutionMapping": { "type": "object", "description": "Maps a single subscription to its physical-to-logical zone resolutions.", "properties": { "subscriptionId": { "type": "string", "description": "The subscription ID (e.g., `\"6b052e15-03d3-4f17-b2e1-be7f07588291\"`).", "readOnly": true }, "zoneMappings": { "type": "array", "description": "The physical-to-logical zone mappings for this subscription.", "items": { "$ref": "#/definitions/PhysicalToLogicalZoneMapping" }, "readOnly": true, "x-ms-identifiers": [ "physicalZone" ] } }, "required": [ "subscriptionId", "zoneMappings" ] }, "ZoneResolutionMode": { "type": "string", "description": "The zone resolution mode for a scenario run.", "enum": [ "logical", "physical" ], "x-ms-enum": { "name": "ZoneResolutionMode", "modelAsString": true, "values": [ { "name": "Logical", "value": "logical", "description": "Logical zone mode — customer specified logical zone identifiers directly." }, { "name": "Physical", "value": "physical", "description": "Physical zone mode — system resolved physical zones to per-subscription\nlogical zones at execution time." } ] } } }, "parameters": { "PutPreconditionHeaders.ifMatch": { "name": "If-Match", "in": "header", "description": "Use '*' to update the resource only if it exists. If the resource does not exist, the request fails with HTTP 412 and error code PreconditionFailed in the standard Azure error body. A failed condition starts no resource change or asynchronous operation. Omit both condition headers for an unconditional create or update. Other effective conditions must be honored if supported or rejected with 412 if they cannot be verified; they must not be silently ignored. This contract does not introduce entity-tag matching.", "required": false, "type": "string", "x-ms-parameter-location": "method", "x-ms-client-name": "ifMatch" }, "PutPreconditionHeaders.ifNoneMatch": { "name": "If-None-Match", "in": "header", "description": "Use '*' to create the resource only if it does not exist. If the resource exists, the request fails with HTTP 412 and error code PreconditionFailed in the standard Azure error body. A failed condition starts no resource change or asynchronous operation. Omit both condition headers for an unconditional create or update. Other effective conditions must be honored if supported or rejected with 412 if they cannot be verified; they must not be silently ignored. This contract does not introduce entity-tag matching.", "required": false, "type": "string", "x-ms-parameter-location": "method", "x-ms-client-name": "ifNoneMatch" } } }