{ "swagger": "2.0", "info": { "title": "ChaosManagementClient", "version": "2026-05-01-preview", "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": "PrivateAccesses" }, { "name": "PrivateEndpointConnections" }, { "name": "Actions" }, { "name": "ActionVersions" }, { "name": "TargetTypes" }, { "name": "OperationStatuses" }, { "name": "Workspaces" }, { "name": "DiscoveredResources" }, { "name": "Scenarios" }, { "name": "ScenarioRuns" }, { "name": "ScenarioConfigurations" } ], "paths": { "/providers/Microsoft.Chaos/operations": { "get": { "operationId": "Operations_ListAll", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Lists all Chaos Studio operations.": { "$ref": "./examples/Operations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/OperationIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/privateAccesses": { "get": { "operationId": "PrivateAccesses_ListAll", "tags": [ "PrivateAccesses" ], "description": "Get a list of private access resources in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/PrivateAccessListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all private accesses in a subscription.": { "$ref": "./examples/PrivateAccesses_ListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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": "The operation to update an experiment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/privateAccesses": { "get": { "operationId": "PrivateAccesses_List", "tags": [ "PrivateAccesses" ], "description": "Get a list of private access resources in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/PrivateAccessListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all private access in a resource group.": { "$ref": "./examples/PrivateAccesses_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}": { "get": { "operationId": "PrivateAccesses_Get", "tags": [ "PrivateAccesses" ], "description": "Get a private access resource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateAccessName", "in": "path", "description": "The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateAccess" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a private access resource": { "$ref": "./examples/PrivateAccesses_Get_Get_A_Private_Access_Resource.json" }, "Get a private access resource with private endpoint": { "$ref": "./examples/PrivateAccesses_Get_Get_A_Private_Access_Resource_With_Private_Endpoint.json" } } }, "put": { "operationId": "PrivateAccesses_CreateOrUpdate", "tags": [ "PrivateAccesses" ], "description": "Create or update a private access", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateAccessName", "in": "path", "description": "The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "resource", "in": "body", "description": "private access resource to be created or updated.", "required": true, "schema": { "$ref": "#/definitions/PrivateAccess" } } ], "responses": { "200": { "description": "Resource 'PrivateAccess' update operation succeeded", "schema": { "$ref": "#/definitions/PrivateAccess" } }, "201": { "description": "Resource 'PrivateAccess' create operation succeeded", "schema": { "$ref": "#/definitions/PrivateAccess" }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update a private access resource": { "$ref": "./examples/PrivateAccesses_CreateOrUpdate_Create_Or_Update_A_Private_Access_Resource.json" }, "Create or Update a private access resource with publicNetworkAccess": { "$ref": "./examples/PrivateAccesses_CreateOrUpdate_Create_Or_Update_A_Private_Access_Resource_With_Public_Network_Access.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "PrivateAccesses_Update", "tags": [ "PrivateAccesses" ], "description": "Patch a private access tags", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateAccessName", "in": "path", "description": "The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "properties", "in": "body", "description": "private access resource's tags to be updated.", "required": true, "schema": { "$ref": "#/definitions/PrivateAccessPatch" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateAccess" } }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a private access resource's tags": { "$ref": "./examples/PrivateAccesses_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "PrivateAccesses_Delete", "tags": [ "PrivateAccesses" ], "description": "Delete a private access", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateAccessName", "in": "path", "description": "The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a private access resource": { "$ref": "./examples/PrivateAccesses_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/privateAccesses/{privateAccessName}/privateEndpointConnections": { "get": { "operationId": "PrivateAccesses_ListPrivateEndpointConnections", "tags": [ "PrivateEndpointConnections" ], "description": "List information about private endpoint connections under a private access resource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateAccessName", "in": "path", "description": "The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all private endpoint connections under a private access resource.": { "$ref": "./examples/PrivateAccesses_ListPrivateEndpointConnections.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "PrivateAccesses_GetAPrivateEndpointConnection", "tags": [ "PrivateEndpointConnections" ], "description": "Gets information about a private endpoint connection under a private access resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateAccessName", "in": "path", "description": "The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string", "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get information about a private endpoint connection under a private access resource.": { "$ref": "./examples/PrivateAccesses_GetAPrivateEndpointConnection.json" } } }, "delete": { "operationId": "PrivateAccesses_DeleteAPrivateEndpointConnection", "tags": [ "PrivateEndpointConnections" ], "description": "Deletes a private endpoint connection under a private access resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateAccessName", "in": "path", "description": "The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string", "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a private endpoint connection under a private access resource.": { "$ref": "./examples/PrivateAccesses_DeleteAPrivateEndpointConnection.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/privateAccesses/{privateAccessName}/privateLinkResources": { "get": { "operationId": "PrivateAccesses_GetPrivateLinkResources", "tags": [ "PrivateAccesses" ], "description": "Gets the private link resources possible under private access resource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "privateAccessName", "in": "path", "description": "The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all possible private link resources under private access resource.": { "$ref": "./examples/PrivateAccesses_GetPrivateLinkResources.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a Workspace in a resource group.": { "$ref": "./examples/Workspaces_Get.json" } } }, "put": { "operationId": "Workspaces_CreateOrUpdate", "tags": [ "Workspaces" ], "description": "Create or update a Workspace resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "workspaceName", "in": "path", "description": "String that represents a Workspace resource name.", "required": true, "type": "string", "minLength": 1, "pattern": "^[^<>%&:?#/\\\\]+$" }, { "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create/update a workspace in a resource group.": { "$ref": "./examples/Workspaces_CreateOrUpdate.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": "The operation to update a Workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a Workspace in a resource group.": { "$ref": "./examples/Workspaces_Update.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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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}/discoveredResources": { "get": { "operationId": "DiscoveredResources_ListByWorkspace", "tags": [ "DiscoveredResources" ], "description": "Get a list of discovered resources for a workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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}/refreshRecommendations": { "post": { "operationId": "Workspaces_RefreshRecommendations", "tags": [ "Workspaces" ], "description": "Refreshes recommendation status for all scenarios in a given workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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 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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Refresh recommendations for all scenarios in a workspace.": { "$ref": "./examples/Workspaces_RefreshRecommendations.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": { "get": { "operationId": "Scenarios_ListAll", "tags": [ "Scenarios" ], "description": "Get a list of scenarios.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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": "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a scenario.": { "$ref": "./examples/Scenarios_CreateOrUpdate.json" } } }, "delete": { "operationId": "Scenarios_Delete", "tags": [ "Scenarios" ], "description": "Delete a scenario.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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": "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "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" } }, "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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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" ], "summary": "Get a scenario run.", "description": "Get a scenario run.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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": "The request has been accepted for processing, but processing has not yet completed.", "schema": { "$ref": "#/definitions/ScenarioRun" }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "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/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/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/v5/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/v5/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." } ] } }, "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/v5/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/v5/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/v5/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" } } } }, "ConfigurationExclusions": { "type": "object", "description": "Model that represents exclusion criteria for protecting resources from fault injection.\nUses union (OR) logic - a resource is excluded if it matches ANY criteria.", "properties": { "resources": { "type": "array", "description": "Array of specific resource IDs to exclude from fault injection.", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource." } }, "tags": { "type": "array", "description": "Array of tag key-value pairs. Resources with matching tags are excluded.", "items": { "$ref": "#/definitions/KeyValuePair" }, "x-ms-identifiers": [ "key" ] }, "types": { "type": "array", "description": "Array of resource types. All resources of these types are excluded.", "items": { "type": "string" } } } }, "ConfigurationFilters": { "type": "object", "description": "Model that represents filter criteria for constraining which discovered\nresources participate in fault injection.\n\nUses intersection (AND) logic — a resource is included only if it matches all criteria.", "properties": { "locations": { "type": "array", "description": "Array of Azure location strings. Only resources in these locations are included.\n\nNull or omitted means all locations (no filter). Empty array means include nothing.", "items": { "type": "string" } }, "zones": { "type": "array", "description": "Array of availability zone identifiers (\"1\", \"2\", \"3\", \"zone-redundant\").\nOnly resources whose zones intersect this list are included.\n\nNull or omitted means all zones (including non-zonal). Empty array means include nothing.\n\nMutually exclusive with `physicalZones` — set one or the other, not both.", "items": { "type": "string" } }, "physicalZones": { "type": "array", "description": "Array of physical availability zone identifiers in `{region}-az{N}` format\n(e.g., `\"westus2-az1\"`). Only resources in the corresponding logical zone\nfor each subscription are included.\n\nAt execution time, each physical zone is resolved to per-subscription\nlogical zones via the Azure locations API. The resolved mapping is surfaced\non the scenario run response (`zoneResolution`).\n\nNull or omitted means physical zone targeting is not used.\nOnly one physical zone is supported in preview.\n\nMutually exclusive with `zones` — set one or the other, not both.", "items": { "type": "string" } } } }, "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/v5/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 } }, "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/v5/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/v5/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/v5/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/v5/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." } } }, "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 map 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" ] }, "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", "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 } }, "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/v5/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" ] }, "PrivateAccess": { "type": "object", "description": "PrivateAccesses tracked resource.", "properties": { "properties": { "$ref": "#/definitions/PrivateAccessProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "PrivateAccessListResult": { "type": "object", "description": "Model that represents a list of private access resources and a link for pagination.", "properties": { "value": { "type": "array", "description": "The PrivateAccess items on this page", "items": { "$ref": "#/definitions/PrivateAccess" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PrivateAccessPatch": { "type": "object", "description": "Describes a private access update.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "PrivateAccessProperties": { "type": "object", "description": "The properties of a private access resource", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Most recent provisioning state for the given privateAccess resource.", "readOnly": true }, "privateEndpointConnections": { "type": "array", "description": "A readonly collection of private endpoint connection. Currently only one endpoint connection is supported.", "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, "readOnly": true }, "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccessOption", "description": "Public Network Access Control for PrivateAccess resource." } } }, "PrivateEndpoint": { "type": "object", "description": "The private endpoint resource.", "properties": { "id": { "type": "string", "description": "The Azure identifier for private endpoint.", "readOnly": true } } }, "PrivateEndpointConnection": { "type": "object", "description": "The private endpoint connection resource.", "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PrivateEndpointConnectionListResult": { "type": "object", "description": "A list of private link resources", "properties": { "value": { "type": "array", "description": "The PrivateEndpointConnection items on this page", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PrivateEndpointConnectionProperties": { "type": "object", "description": "Properties of the private endpoint connection.", "properties": { "groupIds": { "type": "array", "description": "The group ids for the private endpoint resource.", "items": { "type": "string" }, "readOnly": true }, "privateEndpoint": { "$ref": "#/definitions/PrivateEndpoint", "description": "The private endpoint resource." }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionState", "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the private endpoint connection resource.", "readOnly": true } }, "required": [ "privateLinkServiceConnectionState" ] }, "PrivateEndpointServiceConnectionStatus": { "type": "string", "description": "The private endpoint connection status.", "enum": [ "Pending", "Approved", "Rejected" ], "x-ms-enum": { "name": "PrivateEndpointServiceConnectionStatus", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending", "description": "Pending status." }, { "name": "Approved", "value": "Approved", "description": "Approved status." }, { "name": "Rejected", "value": "Rejected", "description": "Rejected status." } ] } }, "PrivateLinkResource": { "type": "object", "description": "A private link resource.", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "PrivateLinkResourceListResult": { "type": "object", "description": "A list of private link resources", "properties": { "value": { "type": "array", "description": "The PrivateLinkResource items on this page", "items": { "$ref": "#/definitions/PrivateLinkResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PrivateLinkResourceProperties": { "type": "object", "description": "Properties of a private link resource.", "properties": { "groupId": { "type": "string", "description": "The private link resource group id.", "readOnly": true }, "requiredMembers": { "type": "array", "description": "The private link resource required member names.", "items": { "type": "string" }, "readOnly": true }, "requiredZoneNames": { "type": "array", "description": "The private link resource private link DNS zone name.", "items": { "type": "string" } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Resource provisioning state. Not currently in use.", "readOnly": true } } }, "PrivateLinkServiceConnectionState": { "type": "object", "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { "status": { "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." } } }, "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 }, "PublicNetworkAccessOption": { "type": "string", "description": "Public Network Access Control for PrivateAccess resource.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccessOption", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enabled access." }, { "name": "Disabled", "value": "Disabled", "description": "Disabled access." } ] } }, "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", "description": "The resource id for the affected resource.", "readOnly": true }, "errorCode": { "type": "integer", "format": "int32", "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" ] }, "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", "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", "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.", "minItems": 1, "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/v5/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" ] }, "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." } }, "required": [ "name", "actionId", "duration" ] }, "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/v5/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" ] }, "exclusions": { "$ref": "#/definitions/ConfigurationExclusions", "description": "Exclusion criteria for protecting resources from fault injection." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Most recent provisioning state for the given scenario resource.", "readOnly": true }, "filters": { "$ref": "#/definitions/ConfigurationFilters", "description": "Filter criteria used to constrain which discovered resources participate in fault injection." } }, "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" ] }, "ScenarioEvaluationResultItem": { "type": "object", "description": "Model that represents a single scenario evaluation result.", "properties": { "scenarioName": { "type": "string", "description": "The name of the scenario that was evaluated." }, "evaluationResult": { "$ref": "#/definitions/RecommendationStatus", "description": "The evaluation result for this scenario." } }, "required": [ "scenarioName", "evaluationResult" ] }, "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." } }, "required": [ "name", "type" ] }, "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).", "readOnly": true }, "version": { "type": "string", "description": "Version of the scenario.", "readOnly": true }, "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" ] }, "recommendation": { "$ref": "#/definitions/Recommendation", "description": "The recommendation information for this scenario.", "readOnly": true } }, "required": [ "parameters", "actions" ] }, "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/v5/types.json#/definitions/ProxyResource" } ] }, "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 }, "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" ] }, "errors": { "type": "array", "description": "System or infrastructure errors encountered during the scenario run.", "items": { "$ref": "#/definitions/OperationError" }, "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", "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": "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.", "items": { "$ref": "#/definitions/ScenarioRunResource" }, "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 } }, "required": [ "resources", "actionUrn", "state" ] }, "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 }, "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/v5/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/v5/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 } } }, "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/v5/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 }, "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/v5/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/v5/types.json#/definitions/TrackedResource" } ] }, "WorkspaceEvaluation": { "type": "object", "description": "Model that represents the latest workspace evaluation result.", "properties": { "properties": { "$ref": "#/definitions/WorkspaceEvaluationProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "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", "description": "The workspace ID this evaluation belongs to.", "readOnly": true }, "numScenariosToEvaluate": { "type": "integer", "format": "int32", "description": "The number of scenarios to evaluate.", "readOnly": true }, "numScenariosEvaluatedSucceeded": { "type": "integer", "format": "int32", "description": "The number of scenarios that evaluated successfully.", "readOnly": true }, "numScenariosEvaluatedFailed": { "type": "integer", "format": "int32", "description": "The number of scenarios that failed evaluation.", "readOnly": true }, "numScenariosEvaluatedCancelled": { "type": "integer", "format": "int32", "description": "The number of scenarios that were cancelled during evaluation.", "readOnly": true }, "evaluationResult": { "$ref": "#/definitions/RecommendationStatus", "description": "The overall evaluation result.", "readOnly": true }, "results": { "type": "array", "description": "Per-scenario evaluation results.", "items": { "$ref": "#/definitions/ScenarioEvaluationResultItem" }, "readOnly": true, "x-ms-identifiers": [ "scenarioName" ] } }, "required": [ "status", "workspaceId" ] }, "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": "The evaluation partially succeeded — some scenarios succeeded while others failed." }, { "name": "Failed", "value": "Failed", "description": "The evaluation failed." }, { "name": "Canceled", "value": "Canceled", "description": "The evaluation was canceled." } ] }, "readOnly": true }, "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 }, "communicationEndpoint": { "type": "string", "description": "The communication endpoint used to connect and communicate with the workspace for fault-injection orchestration.", "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." } } }, "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/v5/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } } }, "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": {} }