{ "swagger": "2.0", "info": { "title": "Microsoft.AzureResilienceManagement", "version": "2025-02-01-preview", "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": "Operations" }, { "name": "OperationStatus" }, { "name": "GoalAssignments" }, { "name": "GoalTemplates" }, { "name": "GoalResources" }, { "name": "RecoveryPlans" }, { "name": "RecoveryPlanActions" }, { "name": "RecoveryResources" }, { "name": "RecoveryJobs" }, { "name": "RecoveryChildJobs" }, { "name": "RecoveryJobResources" }, { "name": "Drills" }, { "name": "DrillResources" }, { "name": "DrillRuns" }, { "name": "DrillRunChildJobs" }, { "name": "DrillRunResources" }, { "name": "ChaosJobs" }, { "name": "ChaosJobResources" }, { "name": "ChaosJobChildJobs" }, { "name": "UnifiedResilienceItems" } ], "paths": { "/providers/Microsoft.AzureResilienceManagement/locations/{location}/operationStatuses/{operationId}": { "get": { "operationId": "OperationStatus_Get", "tags": [ "OperationStatus" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Returns the current status of an async operation. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/OperationIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationStatusResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "OperationStatus_Get_MaximumSet": { "$ref": "./examples/OperationStatus_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.AzureResilienceManagement/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List the operations for the provider Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "Operations_List_MaximumSet": { "$ref": "./examples/Operations_List_MaximumSet_Gen.json" }, "Operations_List_MinimumSet": { "$ref": "./examples/Operations_List_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills": { "get": { "operationId": "Drills_List", "tags": [ "Drills" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List Drill resources by tenant Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/QueryParameters.skipToken" }, { "$ref": "#/parameters/QueryParameters.top" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "Drills_List_MaximumSet": { "$ref": "./examples/Drills_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}": { "get": { "operationId": "Drills_Get", "tags": [ "Drills" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a Drill Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Drill" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "Drills_Get_MaximumSet": { "$ref": "./examples/Drills_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "Drills_Create", "tags": [ "Drills" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Create a Drill Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Drill" } } ], "responses": { "200": { "description": "Resource 'Drill' update operation succeeded", "schema": { "$ref": "#/definitions/Drill" } }, "201": { "description": "Resource 'Drill' create operation succeeded", "schema": { "$ref": "#/definitions/Drill" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "Drills_Create_MaximumSet": { "$ref": "./examples/Drills_Create_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Drills_Update", "tags": [ "Drills" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Update a Drill Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/DrillUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Drill" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "Drills_Update_MaximumSet": { "$ref": "./examples/Drills_Update_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Drills_Delete", "tags": [ "Drills" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Delete a Drill Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "Drills_Delete_MaximumSet": { "$ref": "./examples/Drills_Delete_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/addOrUpdateResources": { "post": { "operationId": "Drills_AddOrUpdateResources", "tags": [ "Drills" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This enables the user to include, exclude or update resources from their Drill. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/AddOrUpdateResourcesRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AddOrUpdateResourcesResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "Drills_AddOrUpdateResources_MaximumSet": { "$ref": "./examples/Drills_AddOrUpdateResources_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillResources": { "get": { "operationId": "DrillResources_List", "tags": [ "DrillResources" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List DrillResource resources by Drill Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/QueryParameters.skipToken" }, { "$ref": "#/parameters/QueryParameters.top" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillResources_List_MaximumSet": { "$ref": "./examples/DrillResources_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillResources/{drillResourceName}": { "get": { "operationId": "DrillResources_Get", "tags": [ "DrillResources" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a DrillResource Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillResourceName", "in": "path", "description": "The name of the DrillResource (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillResources_Get_MaximumSet": { "$ref": "./examples/DrillResources_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns": { "get": { "operationId": "DrillRuns_List", "tags": [ "DrillRuns" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List DrillRun resources by Drill Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRuns_List_MaximumSet": { "$ref": "./examples/DrillRuns_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}": { "get": { "operationId": "DrillRuns_Get", "tags": [ "DrillRuns" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a DrillRun Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRun" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRuns_Get_MaximumSet": { "$ref": "./examples/DrillRuns_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/addNotes": { "post": { "operationId": "DrillRuns_AddNotes", "tags": [ "DrillRuns" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This enables the user to add notes on this Drill Run. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/DrillRunAddNotesRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunActionResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRuns_AddNotes_MaximumSet": { "$ref": "./examples/DrillRuns_AddNotes_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/chaosJobs": { "get": { "operationId": "ChaosJobs_List", "tags": [ "ChaosJobs" ], "summary": "Deprecated with no direct replacement in 2026-09-30-preview.", "description": "List ChaosJob resources by DrillRun Deprecated: ChaosJob operations are deprecated and removed in 2026-04-01-preview. They have no direct replacement in 2026-09-30-preview.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ChaosJobListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "ChaosJobs_List_MaximumSet": { "$ref": "./examples/ChaosJobs_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/chaosJobs/{chaosJobName}": { "get": { "operationId": "ChaosJobs_Get", "tags": [ "ChaosJobs" ], "summary": "Deprecated with no direct replacement in 2026-09-30-preview.", "description": "Get a ChaosJob Deprecated: ChaosJob operations are deprecated and removed in 2026-04-01-preview. They have no direct replacement in 2026-09-30-preview.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "chaosJobName", "in": "path", "description": "The unique name of the chaos job (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ChaosJob" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "ChaosJobs_Get_MaximumSet": { "$ref": "./examples/ChaosJobs_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/chaosJobs/{chaosJobName}/chaosJobChildJobs": { "get": { "operationId": "ChaosJobChildJobs_List", "tags": [ "ChaosJobChildJobs" ], "summary": "Deprecated with no direct replacement in 2026-09-30-preview.", "description": "List ChaosJobChildJob resources by ChaosJob Deprecated: ChaosJobChildJob operations are deprecated and removed in 2026-04-01-preview. They have no direct replacement in 2026-09-30-preview.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "chaosJobName", "in": "path", "description": "The unique name of the chaos job (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ChaosJobChildJobListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "ChaosJobChildJobs_List_MaximumSet": { "$ref": "./examples/ChaosJobChildJobs_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/chaosJobs/{chaosJobName}/chaosJobChildJobs/{chaosJobChildJobName}": { "get": { "operationId": "ChaosJobChildJobs_Get", "tags": [ "ChaosJobChildJobs" ], "summary": "Deprecated with no direct replacement in 2026-09-30-preview.", "description": "Get a ChaosJobChildJob Deprecated: ChaosJobChildJob operations are deprecated and removed in 2026-04-01-preview. They have no direct replacement in 2026-09-30-preview.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "chaosJobName", "in": "path", "description": "The unique name of the chaos job (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "chaosJobChildJobName", "in": "path", "description": "The unique name (Guid) of the Chaos job child job", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ChaosJobChildJob" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "ChaosJobChildJobs_Get_MaximumSet": { "$ref": "./examples/ChaosJobChildJobs_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/chaosJobs/{chaosJobName}/chaosJobResources": { "get": { "operationId": "ChaosJobResources_List", "tags": [ "ChaosJobResources" ], "summary": "Deprecated with no direct replacement in 2026-09-30-preview.", "description": "List ChaosJobResource resources by ChaosJob Deprecated: ChaosJobResource operations are deprecated and removed in 2026-04-01-preview. They have no direct replacement in 2026-09-30-preview.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "chaosJobName", "in": "path", "description": "The unique name of the chaos job (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ChaosJobResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "ChaosJobResources_List_MaximumSet": { "$ref": "./examples/ChaosJobResources_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/chaosJobs/{chaosJobName}/chaosJobResources/{chaosJobResourceName}": { "get": { "operationId": "ChaosJobResources_Get", "tags": [ "ChaosJobResources" ], "summary": "Deprecated with no direct replacement in 2026-09-30-preview.", "description": "Get a ChaosJobResource Deprecated: ChaosJobResource operations are deprecated and removed in 2026-04-01-preview. They have no direct replacement in 2026-09-30-preview.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "chaosJobName", "in": "path", "description": "The unique name of the chaos job (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "chaosJobResourceName", "in": "path", "description": "The unique name (GUID) of the chaos job resource.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ChaosJobResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "ChaosJobResources_Get_MaximumSet": { "$ref": "./examples/ChaosJobResources_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/drillRunChildJobs": { "get": { "operationId": "DrillRunChildJobs_List", "tags": [ "DrillRunChildJobs" ], "summary": "Deprecated with no direct replacement in 2026-09-30-preview.", "description": "List DrillRunChildJob resources by DrillRun Deprecated: DrillRunChildJob operations are deprecated and removed in 2026-04-01-preview. They have no direct replacement in 2026-09-30-preview.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunChildJobListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRunChildJobs_List_MaximumSet": { "$ref": "./examples/DrillRunChildJobs_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/drillRunChildJobs/{drillRunChildJobName}": { "get": { "operationId": "DrillRunChildJobs_Get", "tags": [ "DrillRunChildJobs" ], "summary": "Deprecated with no direct replacement in 2026-09-30-preview.", "description": "Get a DrillRunChildJob Deprecated: DrillRunChildJob operations are deprecated and removed in 2026-04-01-preview. They have no direct replacement in 2026-09-30-preview.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "drillRunChildJobName", "in": "path", "description": "The unique name (Guid) of the DrillRun child job", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunChildJob" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRunChildJobs_Get_MaximumSet": { "$ref": "./examples/DrillRunChildJobs_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/drillRunResources": { "get": { "operationId": "DrillRunResources_List", "tags": [ "DrillRunResources" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List DrillRunResource resources by DrillRun Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRunResources_List_MaximumSet": { "$ref": "./examples/DrillRunResources_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/drillRunResources/{drillRunResourceName}": { "get": { "operationId": "DrillRunResources_Get", "tags": [ "DrillRunResources" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a DrillRunResource Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "drillRunResourceName", "in": "path", "description": "The unique name (GUID) of the recovery job resource.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRunResources_Get_MaximumSet": { "$ref": "./examples/DrillRunResources_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/failOver": { "post": { "operationId": "DrillRuns_FailOver", "tags": [ "DrillRuns" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This initiates a new Failover operation on this Drill Run. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/DrillRunFailoverRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunActionResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRuns_FailOver_MaximumSet": { "$ref": "./examples/DrillRuns_FailOver_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/markAsComplete": { "post": { "operationId": "DrillRuns_MarkAsComplete", "tags": [ "DrillRuns" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This enables the user to mark this stage as complete, disabling further retries on it. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/MarkAsCompleteRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MarkAsCompleteResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRuns_MarkAsComplete_MaximumSet": { "$ref": "./examples/DrillRuns_MarkAsComplete_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/reprotect": { "post": { "operationId": "DrillRuns_Reprotect", "tags": [ "DrillRuns" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This initiates a new Reprotect operation on this Drill Run. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunActionResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRuns_Reprotect_MaximumSet": { "$ref": "./examples/DrillRuns_Reprotect_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/resume": { "post": { "operationId": "DrillRuns_Resume", "tags": [ "DrillRuns" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This unblocks a Failover workflow that is paused after the Fault stage, to proceed to the Failover stage. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunActionResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRuns_Resume_MaximumSet": { "$ref": "./examples/DrillRuns_Resume_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/testFailOver": { "post": { "operationId": "DrillRuns_TestFailOver", "tags": [ "DrillRuns" ], "summary": "Deprecated with no direct replacement in 2026-09-30-preview.", "description": "This initiates a new Test-Failover operation on this Drill Run. Deprecated: The testFailOver operation is deprecated and has no direct replacement in 2026-09-30-preview. Clients must stop calling this operation.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/DrillRunTestFailoverRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunActionResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRuns_TestFailOver_MaximumSet": { "$ref": "./examples/DrillRuns_TestFailOver_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/testFailOverCleanup": { "post": { "operationId": "DrillRuns_TestFailOverCleanup", "tags": [ "DrillRuns" ], "summary": "Deprecated with no direct replacement in 2026-09-30-preview.", "description": "This initiates a new Test-Failover Cleanup operation on this Drill Run. Deprecated: The testFailOverCleanup operation is deprecated and has no direct replacement in 2026-09-30-preview. Clients must stop calling this operation.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "drillRunName", "in": "path", "description": "The name of the DrillRun (GUID).", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/DrillRunTestFailoverCleanupRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillRunActionResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "DrillRuns_TestFailOverCleanup_MaximumSet": { "$ref": "./examples/DrillRuns_TestFailOverCleanup_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/end": { "post": { "operationId": "Drills_End", "tags": [ "Drills" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This ends the currently running instance of the Drill. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/DrillEndRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillActionResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "Drills_End_MaximumSet": { "$ref": "./examples/Drills_End_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/refreshReadinessState": { "post": { "operationId": "Drills_RefreshReadinessState", "tags": [ "Drills" ], "summary": "Deprecated. Use Drills_ResyncReadinessCheck in 2026-09-30-preview or a later supported API version.", "description": "This triggers detection of any drifts from the desired state of Resources and RBAC. Deprecated: The refreshReadinessState operation is deprecated. Use Drills_ResyncReadinessCheck with API version 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "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": "Operation completed successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "Drills_RefreshReadinessState_MaximumSet": { "$ref": "./examples/Drills_RefreshReadinessState_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/start": { "post": { "operationId": "Drills_Start", "tags": [ "Drills" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This starts a new running instance of the Drill. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "drillName", "in": "path", "description": "The name of the Drill", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/DrillStartRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DrillActionResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "Drills_Start_MaximumSet": { "$ref": "./examples/Drills_Start_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/goalAssignments": { "get": { "operationId": "GoalAssignments_List", "tags": [ "GoalAssignments" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List GoalAssignment resources by tenant Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/QueryParameters.skipToken" }, { "$ref": "#/parameters/QueryParameters.top" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GoalAssignmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalAssignments_List_MaximumSet": { "$ref": "./examples/GoalAssignments_List_MaximumSet_Gen.json" }, "GoalAssignments_List_MinimumSet": { "$ref": "./examples/GoalAssignments_List_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/goalAssignments/{goalAssignmentName}": { "get": { "operationId": "GoalAssignments_Get", "tags": [ "GoalAssignments" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a GoalAssignment Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalAssignmentName", "in": "path", "description": "The name of the goal assignment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GoalAssignment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalAssignments_Get_MaximumSet": { "$ref": "./examples/GoalAssignments_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "GoalAssignments_CreateOrUpdate", "tags": [ "GoalAssignments" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Create a GoalAssignment Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalAssignmentName", "in": "path", "description": "The name of the goal assignment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/GoalAssignment" } } ], "responses": { "200": { "description": "Resource 'GoalAssignment' update operation succeeded", "schema": { "$ref": "#/definitions/GoalAssignment" } }, "201": { "description": "Resource 'GoalAssignment' create operation succeeded", "schema": { "$ref": "#/definitions/GoalAssignment" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalAssignments_CreateOrUpdate_MaximumSet": { "$ref": "./examples/GoalAssignments_CreateOrUpdate_MaximumSet_Gen.json" }, "GoalAssignments_CreateOrUpdate_MinimumSet": { "$ref": "./examples/GoalAssignments_CreateOrUpdate_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "GoalAssignments_Update", "tags": [ "GoalAssignments" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Update a GoalAssignment Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalAssignmentName", "in": "path", "description": "The name of the goal assignment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/GoalAssignmentUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GoalAssignment" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalAssignments_Update_MaximumSet": { "$ref": "./examples/GoalAssignments_Update_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "GoalAssignments_Delete", "tags": [ "GoalAssignments" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Delete a GoalAssignment Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalAssignmentName", "in": "path", "description": "The name of the goal assignment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalAssignments_Delete_MaximumSet": { "$ref": "./examples/GoalAssignments_Delete_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/goalAssignments/{goalAssignmentName}/goalResources": { "get": { "operationId": "GoalResources_List", "tags": [ "GoalResources" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List GoalResource resources by GoalAssignment Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/QueryParameters.skipToken" }, { "$ref": "#/parameters/QueryParameters.top" }, { "name": "goalAssignmentName", "in": "path", "description": "The name of the goal assignment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GoalResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalResources_List_MaximumSet": { "$ref": "./examples/GoalResources_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/goalAssignments/{goalAssignmentName}/goalResources/{goalResourceName}": { "get": { "operationId": "GoalResources_Get", "tags": [ "GoalResources" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a GoalResource Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalAssignmentName", "in": "path", "description": "The name of the goal assignment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "goalResourceName", "in": "path", "description": "The name of the goal resource.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GoalResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalResources_Get_Complete_Example": { "$ref": "./examples/GoalResources_Get_Complete_Example.json" }, "GoalResources_Get_MaximumSet": { "$ref": "./examples/GoalResources_Get_MaximumSet_Gen.json" }, "GoalResources_Get_MinimumSet": { "$ref": "./examples/GoalResources_Get_MinimumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/goalAssignments/{goalAssignmentName}/refreshGoalResources": { "post": { "operationId": "GoalAssignments_RefreshGoalResources", "tags": [ "GoalAssignments" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Refreshes the goal resources under a goal assignment. This operation scans for new resources under the scope of the assignment. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalAssignmentName", "in": "path", "description": "The name of the goal assignment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RefreshGoalResourcesResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalAssignments_RefreshGoalResources_MaximumSet": { "$ref": "./examples/GoalAssignments_RefreshGoalResources_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/goalAssignments/{goalAssignmentName}/updateGoalResources": { "post": { "operationId": "GoalAssignments_UpdateGoalResources", "tags": [ "GoalAssignments" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Action to exclude a resource from goal assignment. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalAssignmentName", "in": "path", "description": "The name of the goal assignment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/UpdateGoalResourceRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/UpdateGoalResourceResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalAssignments_UpdateGoalResources_MaximumSet": { "$ref": "./examples/GoalAssignments_UpdateGoalResources_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/goalTemplates": { "get": { "operationId": "GoalTemplates_List", "tags": [ "GoalTemplates" ], "summary": "Deprecated. Set resiliency intent on GoalAssignment and read resource posture from GoalResource instead.", "description": "Lists the goal templates of a service group. Deprecated: the GoalTemplate resource type is deprecated and is removed in 2026-09-30-preview. Set resiliency intent directly on the GoalAssignment (requireZonalResiliency, requireRegionalResiliency) and read resource posture from GoalResource (zonalResiliency, regionalResiliency) instead.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/QueryParameters.skipToken" }, { "$ref": "#/parameters/QueryParameters.top" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GoalTemplateListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalTemplates_List_MaximumSet": { "$ref": "./examples/GoalTemplates_List_MaximumSet_Gen.json" }, "GoalTemplates_List_MinimumSet": { "$ref": "./examples/GoalTemplates_List_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/goalTemplates/{goalTemplateName}": { "get": { "operationId": "GoalTemplates_Get", "tags": [ "GoalTemplates" ], "summary": "Deprecated. Set resiliency intent on GoalAssignment and read resource posture from GoalResource instead.", "description": "Gets a goal template. Deprecated: the GoalTemplate resource type is deprecated and is removed in 2026-09-30-preview. Set resiliency intent directly on the GoalAssignment (requireZonalResiliency, requireRegionalResiliency) and read resource posture from GoalResource (zonalResiliency, regionalResiliency) instead.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalTemplateName", "in": "path", "description": "The name of the goalTemplate", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GoalTemplate" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalTemplates_Get_MaximumSet": { "$ref": "./examples/GoalTemplates_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "GoalTemplates_CreateOrUpdate", "tags": [ "GoalTemplates" ], "summary": "Deprecated. Set resiliency intent on GoalAssignment and read resource posture from GoalResource instead.", "description": "Creates or updates a goal template. Deprecated: the GoalTemplate resource type is deprecated and is removed in 2026-09-30-preview. Set resiliency intent directly on the GoalAssignment (requireZonalResiliency, requireRegionalResiliency) and read resource posture from GoalResource (zonalResiliency, regionalResiliency) instead.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalTemplateName", "in": "path", "description": "The name of the goalTemplate", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/GoalTemplate" } } ], "responses": { "200": { "description": "Resource 'GoalTemplate' update operation succeeded", "schema": { "$ref": "#/definitions/GoalTemplate" } }, "201": { "description": "Resource 'GoalTemplate' create operation succeeded", "schema": { "$ref": "#/definitions/GoalTemplate" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalTemplates_CreateOrUpdate_MaximumSet": { "$ref": "./examples/GoalTemplates_CreateOrUpdate_MaximumSet_Gen.json" }, "GoalTemplates_CreateOrUpdate_MinimumSet": { "$ref": "./examples/GoalTemplates_CreateOrUpdate_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "GoalTemplates_Update", "tags": [ "GoalTemplates" ], "summary": "Deprecated. Set resiliency intent on GoalAssignment and read resource posture from GoalResource instead.", "description": "Updates a goal template. Deprecated: the GoalTemplate resource type is deprecated and is removed in 2026-09-30-preview. Set resiliency intent directly on the GoalAssignment (requireZonalResiliency, requireRegionalResiliency) and read resource posture from GoalResource (zonalResiliency, regionalResiliency) instead.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalTemplateName", "in": "path", "description": "The name of the goalTemplate", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/GoalTemplateUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GoalTemplate" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalTemplates_Update_MaximumSet": { "$ref": "./examples/GoalTemplates_Update_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "GoalTemplates_Delete", "tags": [ "GoalTemplates" ], "summary": "Deprecated. Set resiliency intent on GoalAssignment and read resource posture from GoalResource instead.", "description": "Deletes a goal template. Deprecated: the GoalTemplate resource type is deprecated and is removed in 2026-09-30-preview. Set resiliency intent directly on the GoalAssignment (requireZonalResiliency, requireRegionalResiliency) and read resource posture from GoalResource (zonalResiliency, regionalResiliency) instead.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "goalTemplateName", "in": "path", "description": "The name of the goalTemplate", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "GoalTemplates_Delete_MaximumSet": { "$ref": "./examples/GoalTemplates_Delete_MaximumSet_Gen.json" }, "GoalTemplates_Delete_MinimumSet": { "$ref": "./examples/GoalTemplates_Delete_MinimumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans": { "get": { "operationId": "RecoveryPlans_List", "tags": [ "RecoveryPlans" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List RecoveryPlan resources by tenant Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/QueryParameters.skipToken" }, { "$ref": "#/parameters/QueryParameters.top" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlanListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlans_List_MaximumSet": { "$ref": "./examples/RecoveryPlans_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}": { "get": { "operationId": "RecoveryPlans_Get", "tags": [ "RecoveryPlans" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a RecoveryPlan Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlans_Get_MaximumSet": { "$ref": "./examples/RecoveryPlans_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "RecoveryPlans_CreateOrUpdate", "tags": [ "RecoveryPlans" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Create a RecoveryPlan Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/RecoveryPlan" } } ], "responses": { "200": { "description": "Resource 'RecoveryPlan' update operation succeeded", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "201": { "description": "Resource 'RecoveryPlan' create operation succeeded", "schema": { "$ref": "#/definitions/RecoveryPlan" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlans_CreateOrUpdate_MaximumSet": { "$ref": "./examples/RecoveryPlans_CreateOrUpdate_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "RecoveryPlans_Update", "tags": [ "RecoveryPlans" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Update a RecoveryPlan Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/RecoveryPlanUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlans_Update_MaximumSet": { "$ref": "./examples/RecoveryPlans_Update_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "RecoveryPlans_Delete", "tags": [ "RecoveryPlans" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Delete a RecoveryPlan Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlans_Delete_MaximumSet": { "$ref": "./examples/RecoveryPlans_Delete_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/checkReadiness": { "post": { "operationId": "RecoveryPlanActions_CheckReadiness", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action performs the necessary readiness check on the recovery orchestration plan to ensure it is in the desired state and eligible for all recovery actions, including all protected resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlanActionBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_CheckReadiness_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_CheckReadiness_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/failover": { "post": { "operationId": "RecoveryPlanActions_Failover", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action triggers the failover operation on the recovery orchestration plan for the qualified resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/FailoverRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlanActionBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_Failover_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_Failover_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/failoverCommit": { "post": { "operationId": "RecoveryPlanActions_FailoverCommit", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action triggers the failover commit operation on the recovery orchestration plan for the qualified resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlanActionBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_FailoverCommit_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_FailoverCommit_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/finalize": { "post": { "operationId": "RecoveryPlanActions_Finalize", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action finalizes the recovery orchestration plan, ensuring all necessary configurations are in place. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_Finalize_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_Finalize_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryJobs": { "get": { "operationId": "RecoveryJobs_List", "tags": [ "RecoveryJobs" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List RecoveryJob resources by RecoveryPlan Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryJobListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryJobs_List_MaximumSet": { "$ref": "./examples/RecoveryJobs_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryJobs/{recoveryJobName}": { "get": { "operationId": "RecoveryJobs_Get", "tags": [ "RecoveryJobs" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a RecoveryJob Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "recoveryJobName", "in": "path", "description": "The unique name (GUID) of the recovery job.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryJob" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryJobs_Get_MaximumSet": { "$ref": "./examples/RecoveryJobs_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryJobs/{recoveryJobName}/cancel": { "post": { "operationId": "RecoveryJobs_Cancel", "tags": [ "RecoveryJobs" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action attempts to cancel the ongoing recovery orchestration job. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "recoveryJobName", "in": "path", "description": "The unique name (GUID) of the recovery job.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryJobs_Cancel_MaximumSet": { "$ref": "./examples/RecoveryJobs_Cancel_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryJobs/{recoveryJobName}/recoveryChildJobs": { "get": { "operationId": "RecoveryChildJobs_List", "tags": [ "RecoveryChildJobs" ], "summary": "Deprecated. Use RecoveryJobResources instead.", "description": "Lists the recovery child jobs of a recovery job. Deprecated: the RecoveryChildJob resource type is deprecated and is removed in 2026-04-01-preview. Use the recoveryJobResources child of the recovery job (RecoveryJobResources) instead.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "recoveryJobName", "in": "path", "description": "The unique name (GUID) of the recovery job.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryChildJobListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryChildJobs_List_MaximumSet": { "$ref": "./examples/RecoveryChildJobs_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryJobs/{recoveryJobName}/recoveryChildJobs/{recoveryChildJobName}": { "get": { "operationId": "RecoveryChildJobs_Get", "tags": [ "RecoveryChildJobs" ], "summary": "Deprecated. Use RecoveryJobResources instead.", "description": "Gets a recovery child job. Deprecated: the RecoveryChildJob resource type is deprecated and is removed in 2026-04-01-preview. Use the recoveryJobResources child of the recovery job (RecoveryJobResources) instead.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "recoveryJobName", "in": "path", "description": "The unique name (GUID) of the recovery job.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "recoveryChildJobName", "in": "path", "description": "The unique name (Guid) of the recovery child job", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryChildJob" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryChildJobs_Get_MaximumSet": { "$ref": "./examples/RecoveryChildJobs_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryJobs/{recoveryJobName}/recoveryJobResources": { "get": { "operationId": "RecoveryJobResources_List", "tags": [ "RecoveryJobResources" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List RecoveryJobResource resources by RecoveryJob Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "recoveryJobName", "in": "path", "description": "The unique name (GUID) of the recovery job.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryJobResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryJobResources_List_MaximumSet": { "$ref": "./examples/RecoveryJobResources_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryJobs/{recoveryJobName}/recoveryJobResources/{recoveryJobResourceName}": { "get": { "operationId": "RecoveryJobResources_Get", "tags": [ "RecoveryJobResources" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a RecoveryJobResource Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "recoveryJobName", "in": "path", "description": "The unique name (GUID) of the recovery job.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, { "name": "recoveryJobResourceName", "in": "path", "description": "The unique name (GUID) of the recovery job resource.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryJobResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryJobResources_Get_MaximumSet": { "$ref": "./examples/RecoveryJobResources_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryJobs/{recoveryJobName}/resume": { "post": { "operationId": "RecoveryJobs_Resume", "tags": [ "RecoveryJobs" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action resumes the ongoing recovery orchestration job that was paused for required user intervention. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "recoveryJobName", "in": "path", "description": "The unique name (GUID) of the recovery job.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryJobs_Resume_MaximumSet": { "$ref": "./examples/RecoveryJobs_Resume_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryJobs/{recoveryJobName}/retry": { "post": { "operationId": "RecoveryJobs_Retry", "tags": [ "RecoveryJobs" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action retries the ongoing recovery orchestration job for resources that failed in previous attempts. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "recoveryJobName", "in": "path", "description": "The unique name (GUID) of the recovery job.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryJobs_Retry_MaximumSet": { "$ref": "./examples/RecoveryJobs_Retry_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryResources": { "get": { "operationId": "RecoveryResources_List", "tags": [ "RecoveryResources" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List RecoveryResource resources by RecoveryPlan Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryResources_List_MaximumSet": { "$ref": "./examples/RecoveryResources_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/recoveryResources/{recoveryResourceName}": { "get": { "operationId": "RecoveryResources_Get", "tags": [ "RecoveryResources" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a RecoveryResource Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "recoveryResourceName", "in": "path", "description": "The unique name (Guid) of the recovery resource", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryResources_Get_MaximumSet": { "$ref": "./examples/RecoveryResources_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/reprotect": { "post": { "operationId": "RecoveryPlanActions_Reprotect", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action triggers the reprotect operation on the recovery orchestration plan for the qualified resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlanActionBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_Reprotect_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_Reprotect_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/testFailover": { "post": { "operationId": "RecoveryPlanActions_TestFailover", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action triggers the test failover operation on the recovery orchestration plan for the qualified resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/FailoverRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlanActionBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_TestFailover_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_TestFailover_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/testFailoverCleanup": { "post": { "operationId": "RecoveryPlanActions_TestFailoverCleanup", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action triggers the test failover cleanup operation on the recovery orchestration plan for the qualified resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/TestFailoverCleanupRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlanActionBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_TestFailoverCleanup_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_TestFailoverCleanup_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/updateResources": { "post": { "operationId": "RecoveryPlanActions_UpdateResources", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action adds or updates the resources to be included in the recovery orchestration plan. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/UpdateRecoveryResourcesRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/UpdateRecoveryResourcesResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_UpdateResources_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_UpdateResources_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/validateForFailover": { "post": { "operationId": "RecoveryPlanActions_ValidateForFailover", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action checks if the recovery orchestration plan is eligible for failover operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/FailoverRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ValidateForRecoveryOperationBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_ValidateForFailover_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_ValidateForFailover_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/validateForFailoverCommit": { "post": { "operationId": "RecoveryPlanActions_ValidateForFailoverCommit", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action checks if the recovery orchestration plan is eligible for failover commit operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ValidateForRecoveryOperationBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_ValidateForFailoverCommit_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_ValidateForFailoverCommit_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/validateForOperation": { "post": { "operationId": "RecoveryPlanActions_ValidateForOperation", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action checks if the recovery orchestration plan is eligible for operations like failover and reprotect, ensuring it meets the necessary criteria. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/ValidateForOperationRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_ValidateForOperation_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_ValidateForOperation_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/validateForReprotect": { "post": { "operationId": "RecoveryPlanActions_ValidateForReprotect", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action checks if the recovery orchestration plan is eligible for reprotect operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ValidateForRecoveryOperationBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_ValidateForReprotect_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_ValidateForReprotect_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/validateForTestFailover": { "post": { "operationId": "RecoveryPlanActions_ValidateForTestFailover", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action checks if the recovery orchestration plan is eligible for test failover operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/FailoverRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ValidateForRecoveryOperationBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_ValidateForTestFailover_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_ValidateForTestFailover_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/recoveryPlans/{recoveryPlanName}/validateForTestFailoverCleanup": { "post": { "operationId": "RecoveryPlanActions_ValidateForTestFailoverCleanup", "tags": [ "RecoveryPlanActions" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "This action checks if the recovery orchestration plan is eligible for test failover cleanup operation, ensuring it meets the necessary criteria and provides a list of qualified and unqualified resources. Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RequiredRequestHeaders" }, { "name": "recoveryPlanName", "in": "path", "description": "The name of the recovery orchestration plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{5,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ValidateForRecoveryOperationBaseResponse" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "RecoveryPlanActions_ValidateForTestFailoverCleanup_MaximumSet": { "$ref": "./examples/RecoveryPlanActions_ValidateForTestFailoverCleanup_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/unifiedResilienceItems": { "get": { "operationId": "UnifiedResilienceItems_List", "tags": [ "UnifiedResilienceItems" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "List UnifiedResilienceItem resources by tenant Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/QueryParameters.skipToken" }, { "$ref": "#/parameters/QueryParameters.top" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/UnifiedResilienceItemListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "UnifiedResilienceItems_List_MaximumSet": { "$ref": "./examples/UnifiedResilienceItems_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/unifiedResilienceItems/{unifiedResilienceItemName}": { "get": { "operationId": "UnifiedResilienceItems_Get", "tags": [ "UnifiedResilienceItems" ], "summary": "Deprecated API version. Use 2026-09-30-preview or a later supported API version.", "description": "Get a UnifiedResilienceItem Deprecated: API versions 2025-02-01-preview through 2026-08-31-preview are deprecated. Use 2026-09-30-preview or a later supported API version.", "parameters": [ { "$ref": "#/parameters/ServiceGroupBaseParameters" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "unifiedResilienceItemName", "in": "path", "description": "The name of the unified resilience item.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/UnifiedResilienceItem" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "deprecated": true, "x-ms-examples": { "UnifiedResilienceItems_Get_MaximumSet": { "$ref": "./examples/UnifiedResilienceItems_Get_MaximumSet_Gen.json" } } } } }, "definitions": { "AddOrUpdateResourcesRequest": { "type": "object", "description": "Request body of the AddOrUpdateResources API.", "properties": { "faultDurationInMin": { "type": "integer", "format": "int32", "description": "Duration of faults.", "minimum": 0 }, "resourceLists": { "$ref": "#/definitions/ResourceLists", "description": "Add, Update, Delete resource lists" }, "forceInclusionAndUpdate": { "$ref": "#/definitions/ForceInclusionAndUpdate", "description": "Whether to allow inclusion and update despite attention reasons." } }, "required": [ "faultDurationInMin" ] }, "AddOrUpdateResourcesResponse": { "type": "object", "description": "Response body of the AddOrUpdateResources API.", "properties": { "failedIncludeResourceList": { "type": "array", "description": "Failed Include resources.", "items": { "$ref": "#/definitions/FailedDrillResource" }, "readOnly": true, "x-ms-identifiers": [] }, "failedExcludeResourceList": { "type": "array", "description": "Failed Exclude resources.", "items": { "$ref": "#/definitions/FailedDrillResource" }, "readOnly": true, "x-ms-identifiers": [] }, "failedUpdateResourceList": { "type": "array", "description": "Failed Update resources.", "items": { "$ref": "#/definitions/FailedDrillResource" }, "readOnly": true, "x-ms-identifiers": [] } } }, "AdditionalParameter": { "type": "object", "description": "Definition of Name Value collection.", "properties": { "key": { "type": "string", "description": "Name of the key", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, "value": { "type": "string", "description": "Value of the key" } }, "required": [ "key", "value" ] }, "AssociatedIdentity": { "type": "object", "description": "Definition of associated identity linked with the various resources.", "properties": { "type": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentityType", "description": "Identity type linked with the resource" }, "userAssignedIdentity": { "type": "string", "format": "arm-id", "description": "User assigned identity id linked with the resource", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ManagedIdentity/userAssignedIdentities" } ] } } }, "required": [ "type" ] }, "AssociatedIdentityUpdate": { "type": "object", "description": "Definition of associated identity linked with the various resources.", "properties": { "type": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentityType", "description": "Identity type linked with the resource" }, "userAssignedIdentity": { "type": "string", "format": "arm-id", "description": "User assigned identity id linked with the resource", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ManagedIdentity/userAssignedIdentities" } ] } } } }, "AttentionReason": { "type": "object", "description": "Reason why the Drill is in NeedsAttention state, and not ready to run.", "properties": { "drillRbacOnExperiment": { "$ref": "#/definitions/RBACState", "description": "Drill object does not have the necessary RBAC to run the chaos experiment." }, "rbacNeededForDrillOnExperiment": { "type": "array", "description": "Permissions needed by the Drill MSI to run the chaos experiment.", "items": { "type": "string" } }, "drillRbacOnRecoveryPlan": { "$ref": "#/definitions/RBACState", "description": "Drill object does not have the necessary RBAC to run the Recovery Plan." }, "rbacNeededForDrillOnRecoveryPlan": { "type": "array", "description": "Permissions needed by the Drill MSI to run the Recovery Plan.", "items": { "type": "string" } }, "drillRbacOnAzureMonitoringWorkspace": { "$ref": "#/definitions/RBACState", "description": "Drill object does not have the necessary RBAC to read the Azure Monitoring Workspace account." }, "rbacNeededForDrillOnAzureMonitoringWorkspace": { "type": "array", "description": "Permissions needed by the Drill MSI to read Azure Monitoring Workspace account.", "items": { "type": "string" } }, "drillRbacOnSlo": { "$ref": "#/definitions/RBACState", "description": "Drill object does not have the necessary RBAC to read the SLO object." }, "rbacNeededForDrillOnSlo": { "type": "array", "description": "Permissions needed by the Drill MSI to read SLO object.", "items": { "type": "string" } }, "drillRbacOnAzureHealthModel": { "$ref": "#/definitions/RBACState", "description": "Drill object does not have the necessary RBAC to read the Azure Health Model." }, "rbacNeededForDrillOnAzureHealthModel": { "type": "array", "description": "Permissions needed by the Drill MSI to read Azure Health Model.", "items": { "type": "string" } }, "roReadiness": { "$ref": "#/definitions/RecoveryPlanState", "description": "Associated RO ready or not." }, "faultRbacOnTargets": { "$ref": "#/definitions/RBACState", "description": "RBAC required by Experiment MSI not setup on the target resources." }, "runbookFaultRbacOnTargets": { "$ref": "#/definitions/RBACState", "description": "RBAC required by AutomationAccount for runbook MSI not setup on the target resources." }, "targets": { "$ref": "#/definitions/ExtensionObjectState", "description": "One or more Target or Capability object is deleted." }, "recoveryPlanAndDrillResourcesState": { "$ref": "#/definitions/RelativeResourceCompositionState", "description": "Resources associated in Recovery Plan and Drill are out of sync." }, "serviceGroupAndDrillResourcesState": { "$ref": "#/definitions/RelativeResourceCompositionState", "description": "Resources in Service Group and Drill are out of sync." }, "drillUserMsi": { "$ref": "#/definitions/ExtensionObjectState", "description": "User MSI associated with Drill object is deleted." }, "chaosExperimentUserMsi": { "$ref": "#/definitions/ExtensionObjectState", "description": "User MSI associated with chaos experiment object is deleted." }, "includedResourceInDrill": { "$ref": "#/definitions/ExtensionObjectState", "description": "Included resource in Drill." } } }, "AttestationState": { "type": "string", "description": "Enum for the attestation status of the resource in the goal.", "enum": [ "NotAttested", "ManuallyAttested" ], "x-ms-enum": { "name": "AttestationState", "modelAsString": true, "values": [ { "name": "NotAttested", "value": "NotAttested", "description": "Resource is not manually attested." }, { "name": "ManuallyAttested", "value": "ManuallyAttested", "description": "Resource is manually attested." } ] } }, "AutoFailover": { "type": "string", "description": "Enum for AutoFailover", "enum": [ "Enable", "Disable" ], "x-ms-enum": { "name": "AutoFailover", "modelAsString": true, "values": [ { "name": "Enable", "value": "Enable", "description": "Enable AutoFailover." }, { "name": "Disable", "value": "Disable", "description": "Disable AutoFailover." } ] } }, "Azure.ResourceManager.ArmResponse": { "type": "object", "description": "Azure operation completed successfully.", "properties": { "body": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse", "description": "The body type of the operation request or response." } }, "required": [ "body" ] }, "Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate": { "type": "object", "description": "Managed service identity (system assigned and/or user assigned identities)", "properties": { "type": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentityType", "description": "The type of managed identity assigned to this resource." }, "userAssignedIdentities": { "type": "object", "description": "The identities assigned to this resource by the user.", "additionalProperties": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/UserAssignedIdentity", "x-nullable": true } } } }, "BaseJobProperties": { "type": "object", "description": "Definition of a job, including its type, status, timing, and additional details.", "properties": { "status": { "$ref": "#/definitions/JobStatus", "description": "The current status of the job execution.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job execution.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the job execution.", "readOnly": true }, "duration": { "type": "string", "format": "duration", "description": "The time elapsed during the execution of this job.", "readOnly": true }, "errorDetails": { "$ref": "#/definitions/JobErrorInfo", "description": "Details of any errors that occurred during the execution of this job." }, "resourceId": { "type": "string", "format": "arm-id", "description": "The resource for which this job was created. This is typically the resource that the job is intended to manage or operate on.", "readOnly": true }, "operation": { "type": "string", "description": "The operation that this job is intended to perform.", "readOnly": true }, "retryDetails": { "type": "array", "description": "Details of any retries that have been attempted for this job.", "items": { "$ref": "#/definitions/JobRetryDetails" }, "x-ms-identifiers": [] }, "jobExtendedInfo": { "$ref": "#/definitions/JobExtendedInfo", "description": "Additional information about the job." }, "userComments": { "type": "array", "description": "User Comments.", "items": { "$ref": "#/definitions/JobUserComment" }, "readOnly": true, "x-ms-identifiers": [] } } }, "ChaosExperimentPropertiesOfDrill": { "type": "object", "description": "Chaos Experiment properties.", "properties": { "subscription": { "type": "string", "description": "Subscription for chaosExperiment resource." }, "region": { "type": "string", "description": "Region for chaosExperiment resource." }, "identity": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity to use for Chaos Experiment operations." }, "chaosExperimentIdentityForFaults": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity to be used by the Chaos Experiment for invoking faults on resources." }, "chaosExperimentId": { "type": "string", "format": "arm-id", "description": "Chaos Experiment resource created for this Drill", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Chaos/experiments" } ] } }, "faultDurationInMin": { "type": "integer", "format": "int32", "description": "Duration of faults.", "minimum": 0, "readOnly": true } } }, "ChaosExperimentPropertiesOfDrillUpdate": { "type": "object", "description": "Chaos Experiment properties.", "properties": { "subscription": { "type": "string", "description": "Subscription for chaosExperiment resource." }, "region": { "type": "string", "description": "Region for chaosExperiment resource." }, "identity": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity to use for Chaos Experiment operations." }, "chaosExperimentIdentityForFaults": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity to be used by the Chaos Experiment for invoking faults on resources." } } }, "ChaosJob": { "type": "object", "description": "ChaosJob a AzureResilienceProviderHub resource", "properties": { "properties": { "$ref": "#/definitions/ChaosJobProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ChaosJobChildJob": { "type": "object", "description": "Chaos job Child job a AzureResilienceProviderHub resource", "properties": { "properties": { "$ref": "#/definitions/ChaosJobChildJobProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ChaosJobChildJobListResult": { "type": "object", "description": "The response of a ChaosJobChildJob list operation.", "properties": { "value": { "type": "array", "description": "The ChaosJobChildJob items on this page", "items": { "$ref": "#/definitions/ChaosJobChildJob" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ChaosJobChildJobProperties": { "type": "object", "description": "Definition of Chaos job child job properties.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the recovery child job.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/ChildJobProperties" } ], "x-ms-discriminator-value": "ChaosExperimentChild" }, "ChaosJobListResult": { "type": "object", "description": "The response of a ChaosJob list operation.", "properties": { "value": { "type": "array", "description": "The ChaosJob items on this page", "items": { "$ref": "#/definitions/ChaosJob" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ChaosJobProperties": { "type": "object", "description": "Definition of Chaos job properties.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the recovery child job.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/JobProperties" } ], "x-ms-discriminator-value": "ChaosExperiment" }, "ChaosJobResource": { "type": "object", "description": "Represents a chaos job resource in the Azure Resilience Management provider namespace.", "properties": { "properties": { "$ref": "#/definitions/ChaosJobResourceProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ChaosJobResourceListResult": { "type": "object", "description": "The response of a ChaosJobResource list operation.", "properties": { "value": { "type": "array", "description": "The ChaosJobResource items on this page", "items": { "$ref": "#/definitions/ChaosJobResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ChaosJobResourceProperties": { "type": "object", "description": "Properties of a Chaos job resource.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the Drill Run Resource.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/JobResourceProperties" } ], "x-ms-discriminator-value": "ChaosExperiment" }, "ChildJobProperties": { "type": "object", "description": "Represents the properties of a child job within the Resiliency Hub.", "properties": { "status": { "$ref": "#/definitions/JobStatus", "description": "The current status of the job execution.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job execution.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the job execution.", "readOnly": true }, "duration": { "type": "string", "format": "duration", "description": "The time elapsed during the execution of this job.", "readOnly": true }, "errorDetails": { "$ref": "#/definitions/JobErrorInfo", "description": "Details of any errors that occurred during the execution of this job." }, "resourceId": { "type": "string", "format": "arm-id", "description": "The resource for which this job was created. This is typically the resource that the job is intended to manage or operate on.", "readOnly": true }, "operation": { "type": "string", "description": "The operation that this job is intended to perform.", "readOnly": true }, "retryDetails": { "type": "array", "description": "Details of any retries that have been attempted for this job.", "items": { "$ref": "#/definitions/JobRetryDetails" }, "x-ms-identifiers": [] }, "jobExtendedInfo": { "$ref": "#/definitions/JobExtendedInfo", "description": "Additional information about the job." }, "userComments": { "type": "array", "description": "User Comments.", "items": { "$ref": "#/definitions/JobUserComment" }, "readOnly": true, "x-ms-identifiers": [] }, "parentJobId": { "type": "string", "format": "arm-id", "description": "The unique identifier of the parent job under which this child job exists.", "readOnly": true }, "parentJobTaskId": { "type": "string", "description": "The unique identifier of the task within the parent job for which this child job is created.", "readOnly": true }, "parentJobTaskName": { "type": "string", "description": "The friendly name of the task within the parent job for which this child job is created.", "readOnly": true }, "parentJobResourceId": { "type": "string", "format": "arm-id", "description": "The resource identifier of the parent job's job resource for which this child job is created.", "readOnly": true }, "parentJobRetryAttempt": { "type": "integer", "format": "int32", "description": "The retry count of the task within the parent job for which this child job is created.", "readOnly": true }, "jobType": { "$ref": "#/definitions/JobType", "description": "The discriminator for the Job Type hierarchy." } }, "discriminator": "jobType", "required": [ "jobType" ] }, "CustomFaultDetails": { "type": "object", "description": "Custom fault details", "properties": { "faultName": { "type": "string", "description": "fault name", "minLength": 3, "maxLength": 100 }, "scriptResourceId": { "type": "string", "format": "arm-id", "description": "ID of ARM resource used for automation (e.g. Automation runbook URL).", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Automation/automationAccounts/runbooks" } ] } } }, "required": [ "faultName", "scriptResourceId" ] }, "DiskReprotectInputDetails": { "type": "object", "description": "Disk Reprotect Input Details", "properties": { "diskResourceId": { "type": "string", "format": "arm-id", "description": "Disk Resource Id to Reprotect", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Compute/disks" } ] } }, "stagingStorageAccountResourceId": { "type": "string", "format": "arm-id", "description": "The staging StorageAccount Resource Id.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Storage/storageAccounts" } ] } } } }, "Drill": { "type": "object", "description": "Drill resource", "properties": { "properties": { "$ref": "#/definitions/DrillProperties", "description": "The resource-specific properties for this resource." }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "DrillActionResponse": { "type": "object", "description": "Response body of Drill actions", "properties": { "jobId": { "type": "string", "format": "arm-id", "description": "JobId of the Drill", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.AzureResilienceManagement/drills/drillRuns" } ] } } } }, "DrillAttestation": { "type": "string", "description": "Drill Attestation status on terminating.", "enum": [ "Success", "Failed" ], "x-ms-enum": { "name": "DrillAttestation", "modelAsString": true, "values": [ { "name": "AttestedSuccess", "value": "Success", "description": "Drill Attestation success." }, { "name": "AttestedFailed", "value": "Failed", "description": "Drill Attestation failure." } ] } }, "DrillEndRequest": { "type": "object", "description": "Request body of the End Action of Drill.", "properties": { "attestation": { "$ref": "#/definitions/DrillAttestation", "description": "Attestation Status" }, "attestationNotes": { "type": "string", "description": "Notes" } }, "required": [ "attestation", "attestationNotes" ] }, "DrillListResult": { "type": "object", "description": "The response of a Drill list operation.", "properties": { "value": { "type": "array", "description": "The Drill items on this page", "items": { "$ref": "#/definitions/Drill" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DrillMode": { "type": "string", "description": "Start mode of Drill.", "enum": [ "Failover", "TestFailover" ], "x-ms-enum": { "name": "DrillMode", "modelAsString": true, "values": [ { "name": "Failover", "value": "Failover", "description": "Failover mode." }, { "name": "TestFailover", "value": "TestFailover", "description": "TestFailover mode." } ] } }, "DrillPatchProperties": { "type": "object", "description": "PATCH properties for Drill.", "properties": { "metricsProperties": { "$ref": "#/definitions/MetricsPropertiesOfDrill", "description": "Metric properties." }, "recoveryPlanProperties": { "$ref": "#/definitions/RecoveryPlanPropertiesOfDrill", "description": "Recovery Plan properties." }, "chaosExperimentProperties": { "$ref": "#/definitions/ChaosExperimentPropertiesOfDrill", "description": "Chaos Experiment properties." }, "healthModelProperties": { "$ref": "#/definitions/HealthModelPropertiesOfDrill", "description": "HealthModel properties." }, "rbacSetupMode": { "$ref": "#/definitions/RBACSetupMode", "description": "RBAC setup mode." } } }, "DrillProperties": { "type": "object", "description": "Properties of the Resiliency Drill.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Status of the last operation.", "readOnly": true }, "serviceGroupId": { "type": "string", "format": "arm-id", "description": "Parent SG resource.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Management/serviceGroups" } ] } }, "metricsProperties": { "$ref": "#/definitions/MetricsPropertiesOfDrill", "description": "Metric properties." }, "healthModelProperties": { "$ref": "#/definitions/HealthModelPropertiesOfDrill", "description": "HealthModel properties." }, "recoveryPlanProperties": { "$ref": "#/definitions/RecoveryPlanPropertiesOfDrill", "description": "ROPlan properties." }, "chaosExperimentProperties": { "$ref": "#/definitions/ChaosExperimentPropertiesOfDrill", "description": "Chaos Experiment properties." }, "executionState": { "$ref": "#/definitions/ExecutionState", "description": "Execution state of the Drill. Whether it is currently running or not.", "readOnly": true }, "executionReadinessState": { "$ref": "#/definitions/ExecutionReadinessState", "description": "Readiness state of the Drill.", "readOnly": true }, "rbacSetupMode": { "$ref": "#/definitions/RBACSetupMode", "description": "RBAC setup mode." }, "attentionReason": { "$ref": "#/definitions/AttentionReason", "description": "Attention reason if the ReadinessState is 'NeedsAttention'.", "readOnly": true }, "systemMetadata": { "$ref": "#/definitions/SystemMetadata", "description": "Internal System Metadata, to be used by internal components only.", "readOnly": true }, "lastRunProperties": { "$ref": "#/definitions/LastRunProperties", "description": "Last run properties.", "readOnly": true }, "lastSyncTime": { "type": "string", "format": "date-time", "description": "Last sync time.", "readOnly": true }, "managedOnBehalfOfConfiguration": { "$ref": "#/definitions/ManagedOnBehalfOfConfiguration", "description": "Managed RG v2 properties.", "readOnly": true }, "drillType": { "$ref": "#/definitions/DrillType", "description": "The discriminator for the Drill object hierarchy.", "x-ms-mutability": [ "create" ] } }, "discriminator": "drillType", "required": [ "drillType" ] }, "DrillResource": { "type": "object", "description": "Drill Resource", "properties": { "properties": { "$ref": "#/definitions/DrillResourceProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "DrillResourceAttentionReason": { "type": "object", "description": "Reason why the Drill resource is in NeedsAttention state.", "properties": { "faultRbacOnTarget": { "$ref": "#/definitions/RBACState", "description": "Experiment MSI does not have the desired RBAC on the resource." }, "runbookFaultRbacOnTargets": { "$ref": "#/definitions/RBACState", "description": "RBAC required by AutomationAccount for runbook MSI not setup on the target resources." }, "target": { "$ref": "#/definitions/ExtensionObjectState", "description": "Target extension resource is missing on the resource." }, "resourceState": { "type": "array", "description": "Drill Resource State (wrt SG and RO).", "items": { "$ref": "#/definitions/DrillResourceState" } } } }, "DrillResourceFaultState": { "type": "string", "description": "Drill Resource Fault State", "enum": [ "SystemNative", "CustomScript", "NotDefined" ], "x-ms-enum": { "name": "DrillResourceFaultState", "modelAsString": true, "values": [ { "name": "SystemNative", "value": "SystemNative", "description": "Native fault available." }, { "name": "CustomScript", "value": "CustomScript", "description": "Custom script based fault associated with resource." }, { "name": "NotDefined", "value": "NotDefined", "description": "No fault configured for this resource." } ] } }, "DrillResourceInclusionState": { "type": "string", "description": "Drill Resource Inclusion State", "enum": [ "Excluded", "Included" ], "x-ms-enum": { "name": "DrillResourceInclusionState", "modelAsString": true, "values": [ { "name": "Excluded", "value": "Excluded", "description": "Resource excluded from Drill." }, { "name": "Included", "value": "Included", "description": "Resource included in Drill." } ] } }, "DrillResourceListResult": { "type": "object", "description": "The response of a DrillResource list operation.", "properties": { "value": { "type": "array", "description": "The DrillResource items on this page", "items": { "$ref": "#/definitions/DrillResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DrillResourceProperties": { "type": "object", "description": "Properties of the Resiliency Drill Resource", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "ARM Id of the underlying resource.", "x-ms-arm-id-details": { "allowedResources": [] } }, "resourceType": { "type": "string", "description": "Type of the Drill resource." }, "inclusionState": { "$ref": "#/definitions/DrillResourceInclusionState", "description": "Inclusion State of the Drill resource in Drill" }, "recoveryPlanInclusionState": { "$ref": "#/definitions/ResourceInclusionState", "description": "Inclusion State of the Drill resource in Recovery Plan", "readOnly": true }, "recoveryPlanExclusionReason": { "$ref": "#/definitions/RecoveryPlanExclusionReason", "description": "Exclusion reason of the Drill resource in Recovery Plan", "readOnly": true }, "resourceProtectionSolutionType": { "$ref": "#/definitions/ResourceProtectionSolutionType", "description": "Protection Solution Type of the Drill resource", "readOnly": true }, "readinessState": { "$ref": "#/definitions/DrillResourceReadinessState", "description": "Readiness State of the Drill resource", "readOnly": true }, "faultState": { "$ref": "#/definitions/DrillResourceFaultState", "description": "Fault State of the Drill resource", "readOnly": true }, "faultProperties": { "$ref": "#/definitions/FaultProperties", "description": "Fault Properties", "readOnly": true }, "forceInclusionState": { "$ref": "#/definitions/ForceInclusionAndUpdate", "description": "ForceInclusion status for this resource. Has the customer forceIncluded it?", "readOnly": true }, "haStatus": { "$ref": "#/definitions/HAStatus", "description": "HA status of the Drill resource", "readOnly": true }, "attentionReason": { "$ref": "#/definitions/DrillResourceAttentionReason", "description": "Attention reason if the Status is 'NeedsAttention'.", "readOnly": true }, "advisorRecommendationTypeId": { "type": "string", "description": "Recommendation Type Id for the recommendation.", "readOnly": true }, "advisorHaRecommendationId": { "type": "string", "format": "arm-id", "description": "Associated Advisor Recommendation link, if HA is not enabled on this resource.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Advisor/recommendations" } ] } }, "targetAndCapabilityAssignmentError": { "$ref": "#/definitions/ErrorDetails", "description": "Last Target and Capability assignment error, if any.", "readOnly": true }, "rbacAssignmentError": { "$ref": "#/definitions/ErrorDetails", "description": "Last RBAC assignment error, if any.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state", "readOnly": true } }, "required": [ "resourceId", "resourceType" ] }, "DrillResourceReadinessState": { "type": "string", "description": "Drill Resource Readiness State", "enum": [ "Ready", "NeedsAttention" ], "x-ms-enum": { "name": "DrillResourceReadinessState", "modelAsString": true, "values": [ { "name": "Ready", "value": "Ready", "description": "Resource ready." }, { "name": "NeedsAttention", "value": "NeedsAttention", "description": "Resource needs attention." } ] } }, "DrillResourceState": { "type": "string", "description": "Drill Resource State (wrt SG and RO).", "enum": [ "InServiceGroupNotInDrill", "InDrillNotInServiceGroup", "InRecoveryPlanNotInDrill", "InDrillNotInRecoveryPlan", "ResourceStateIncompatibleWithFault" ], "x-ms-enum": { "name": "DrillResourceState", "modelAsString": true, "values": [ { "name": "InServiceGroupNotInDrill", "value": "InServiceGroupNotInDrill", "description": "Resource is in SG but not part of the Drill" }, { "name": "InDrillNotInServiceGroup", "value": "InDrillNotInServiceGroup", "description": "Resource is in Drill but not part of the SG" }, { "name": "InRecoveryPlanNotInDrill", "value": "InRecoveryPlanNotInDrill", "description": "Resource is in RecoveryPlan but not part of the Drill" }, { "name": "InDrillNotInRecoveryPlan", "value": "InDrillNotInRecoveryPlan", "description": "Resource is in Drill but not part of the RecoveryPlan" }, { "name": "ResourceStateIncompatibleWithFault", "value": "ResourceStateIncompatibleWithFault", "description": "Resource is not in a state where it can be faulted." } ] } }, "DrillRun": { "type": "object", "description": "DrillRun resource.", "properties": { "properties": { "$ref": "#/definitions/DrillRunProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "DrillRunActionResponse": { "type": "object", "description": "Request body for TestFailoverCleanup API.", "properties": { "jobId": { "type": "string", "format": "arm-id", "description": "JobId of the RO job.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.AzureResilienceManagement/recoveryPlans/recoveryJobs" } ] } } } }, "DrillRunAddNotesRequest": { "type": "object", "description": "Request body for AddNotes API.", "properties": { "notes": { "type": "string", "description": "The notes string." }, "timestamp": { "type": "string", "format": "date-time", "description": "System generated current Timestamp.", "readOnly": true }, "author": { "type": "string", "description": "System generated Object Id of the notes author.", "readOnly": true } } }, "DrillRunChildJob": { "type": "object", "description": "DrillRun Child Job a AzureResilienceProviderHub resource", "properties": { "properties": { "$ref": "#/definitions/DrillRunChildJobProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "DrillRunChildJobListResult": { "type": "object", "description": "The response of a DrillRunChildJob list operation.", "properties": { "value": { "type": "array", "description": "The DrillRunChildJob items on this page", "items": { "$ref": "#/definitions/DrillRunChildJob" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DrillRunChildJobProperties": { "type": "object", "description": "Definition of Drill Run child job properties.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the recovery child job.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/ChildJobProperties" } ], "x-ms-discriminator-value": "DrillRunChild" }, "DrillRunFailoverRequest": { "type": "object", "description": "Request body for Failover API.", "properties": { "autoFailover": { "$ref": "#/definitions/AutoFailover", "description": "AutoFailover - whether to pause between Fault and Failover for manual input." }, "failoverProperties": { "$ref": "#/definitions/FailoverRequest", "description": "The failover properties." } }, "required": [ "autoFailover", "failoverProperties" ] }, "DrillRunListResult": { "type": "object", "description": "The response of a DrillRun list operation.", "properties": { "value": { "type": "array", "description": "The DrillRun items on this page", "items": { "$ref": "#/definitions/DrillRun" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DrillRunOperationVerbs": { "type": "string", "description": "Enum for DrillRun operation actions.", "enum": [ "Start", "Retry", "MarkAsComplete", "Cancel" ], "x-ms-enum": { "name": "DrillRunOperationVerbs", "modelAsString": true, "values": [ { "name": "Start", "value": "Start", "description": "Start Action." }, { "name": "Retry", "value": "Retry", "description": "Retry Action." }, { "name": "MarkAsComplete", "value": "MarkAsComplete", "description": "MarkAsComplete Action." }, { "name": "Cancel", "value": "Cancel", "description": "Cancel Action." } ] } }, "DrillRunProperties": { "type": "object", "description": "Properties of the Resiliency DrillRun.", "properties": { "drillId": { "type": "string", "format": "arm-id", "description": "Parent Drill resource.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.AzureResilienceManagement/drills" } ] } }, "metricValue": { "type": "string", "description": "Measured aggregated Metric value through the drill run.", "readOnly": true }, "healthStatus": { "$ref": "#/definitions/HealthStatus", "description": "Measured health status through the drill run.", "readOnly": true }, "drillMode": { "$ref": "#/definitions/DrillMode", "description": "Drill mode.", "readOnly": true }, "attestation": { "$ref": "#/definitions/DrillAttestation", "description": "Attestation of this Drill Run.", "readOnly": true }, "notes": { "type": "array", "description": "Notes for this Drill.", "items": { "type": "string" }, "readOnly": true }, "supportedVerbsForStage": { "type": "array", "description": "Matrix of Actions supported on Operations.", "items": { "$ref": "#/definitions/SupportedVerbsForStage" }, "readOnly": true, "x-ms-identifiers": [] }, "currentActiveOperationId": { "type": "string", "description": "The currently active operationID on this Drill Run. There can be only one active.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/JobProperties" } ], "x-ms-discriminator-value": "DrillRun" }, "DrillRunResource": { "type": "object", "description": "Represents a Drill Run job resource in the Azure Resilience Management provider namespace.", "properties": { "properties": { "$ref": "#/definitions/DrillRunResourceProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "DrillRunResourceListResult": { "type": "object", "description": "The response of a DrillRunResource list operation.", "properties": { "value": { "type": "array", "description": "The DrillRunResource items on this page", "items": { "$ref": "#/definitions/DrillRunResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DrillRunResourceProperties": { "type": "object", "description": "Properties of a Drill Run resource.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the Drill Run Resource.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/JobResourceProperties" } ], "x-ms-discriminator-value": "DrillRun" }, "DrillRunSubtasks": { "type": "string", "description": "Enum for Drill Run Subtasks.", "enum": [ "FaultInjection", "Failover", "TestFailover", "TestFailoverCleanup", "Reprotect", "FailoverReverse", "ReprotectReverse" ], "x-ms-enum": { "name": "DrillRunSubtasks", "modelAsString": true, "values": [ { "name": "FaultInjection", "value": "FaultInjection", "description": "FaultInjection Subtasks." }, { "name": "Failover", "value": "Failover", "description": "Failover Subtasks." }, { "name": "TestFailover", "value": "TestFailover", "description": "TestFailover Subtasks." }, { "name": "TestFailoverCleanup", "value": "TestFailoverCleanup", "description": "TestFailoverCleanup Subtasks." }, { "name": "Reprotect", "value": "Reprotect", "description": "Reprotect Subtasks." }, { "name": "FailoverReverse", "value": "FailoverReverse", "description": "FailoverReverse Subtasks." }, { "name": "ReprotectReverse", "value": "ReprotectReverse", "description": "ReprotectReverse Subtasks." } ] } }, "DrillRunTasks": { "type": "string", "description": "Enum for DrillRun Tasks.", "enum": [ "Failover", "TestFailover", "TestFailoverCleanup", "Reprotect", "FailoverReverse", "ReprotectReverse" ], "x-ms-enum": { "name": "DrillRunTasks", "modelAsString": true, "values": [ { "name": "Failover", "value": "Failover", "description": "Failover task." }, { "name": "TestFailover", "value": "TestFailover", "description": "TestFailover tasks." }, { "name": "TestFailoverCleanup", "value": "TestFailoverCleanup", "description": "TestFailoverCleanup tasks." }, { "name": "Reprotect", "value": "Reprotect", "description": "Reprotect task." }, { "name": "FailoverReverse", "value": "FailoverReverse", "description": "FailoverReverse task." }, { "name": "ReprotectReverse", "value": "ReprotectReverse", "description": "ReprotectReverse task." } ] } }, "DrillRunTestFailoverCleanupRequest": { "type": "object", "description": "Request body for TestFailoverCleanup API.", "properties": { "comments": { "type": "string", "description": "Comments for the request." } } }, "DrillRunTestFailoverRequest": { "type": "object", "description": "Request body for TestFailover API.", "properties": { "failoverProperties": { "$ref": "#/definitions/FailoverRequest", "description": "The failover properties." } }, "required": [ "failoverProperties" ] }, "DrillStartRequest": { "type": "object", "description": "Request body of the Start Action of Drill.", "properties": { "mode": { "$ref": "#/definitions/DrillMode", "description": "Mode of starting the Drill" }, "recoveryPlanInputs": { "type": "object", "description": "Inputs needed for the Recovery Orchestration Plan", "properties": { "failoverDirection": { "type": "string", "description": "Direction of the failover" } }, "required": [ "failoverDirection" ] } }, "required": [ "mode", "recoveryPlanInputs" ] }, "DrillType": { "type": "string", "description": "Enum for Drill type object hierarchy.", "enum": [ "Zonal", "Regional" ], "x-ms-enum": { "name": "DrillType", "modelAsString": true, "values": [ { "name": "Zonal", "value": "Zonal", "description": "Zonal Drill." }, { "name": "Regional", "value": "Regional", "description": "Regional Drill." } ] } }, "DrillUpdate": { "type": "object", "description": "The type used for update operations of the Drill.", "properties": { "identity": { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate", "description": "The managed service identities assigned to this resource." }, "properties": { "$ref": "#/definitions/DrillUpdateProperties", "description": "The resource-specific properties for this resource." } } }, "DrillUpdateProperties": { "type": "object", "description": "The updatable properties of the Drill.", "properties": { "metricsProperties": { "$ref": "#/definitions/MetricsPropertiesOfDrillUpdate", "description": "Metric properties." }, "recoveryPlanProperties": { "$ref": "#/definitions/RecoveryPlanPropertiesOfDrillUpdate", "description": "Recovery Plan properties." }, "chaosExperimentProperties": { "$ref": "#/definitions/ChaosExperimentPropertiesOfDrillUpdate", "description": "Chaos Experiment properties." }, "healthModelProperties": { "$ref": "#/definitions/HealthModelPropertiesOfDrillUpdate", "description": "HealthModel properties." }, "rbacSetupMode": { "$ref": "#/definitions/RBACSetupMode", "description": "RBAC setup mode." } } }, "ErrorDetails": { "type": "object", "description": "Errors in T&C / RBAC assignment.", "properties": { "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." } }, "required": [ "code", "message" ] }, "ExclusionReason": { "type": "string", "description": "Enum for the reason why a resource is excluded.", "enum": [ "UserSelectedExclusion", "FailedOverResource", "UnsupportedResource" ], "x-ms-enum": { "name": "ExclusionReason", "modelAsString": true, "values": [ { "name": "UserSelectedExclusion", "value": "UserSelectedExclusion", "description": "The resource was excluded by user selection." }, { "name": "FailedOverResource", "value": "FailedOverResource", "description": "The resource failed over and is excluded." }, { "name": "UnsupportedResource", "value": "UnsupportedResource", "description": "The resource is unsupported and excluded." } ] } }, "ExclusionState": { "type": "string", "description": "Enum for the status of the resource in the goal.", "enum": [ "Excluded", "Included" ], "x-ms-enum": { "name": "ExclusionState", "modelAsString": true, "values": [ { "name": "Excluded", "value": "Excluded", "description": "The resource is excluded from the goals." }, { "name": "Included", "value": "Included", "description": "The resource is included in the goals." } ] } }, "ExecutionReadinessState": { "type": "string", "description": "Drill Execution Readiness State", "enum": [ "Ready", "NeedsAttention" ], "x-ms-enum": { "name": "ExecutionReadinessState", "modelAsString": true, "values": [ { "name": "Ready", "value": "Ready", "description": "Drill is ready to run." }, { "name": "NeedsAttention", "value": "NeedsAttention", "description": "Drill is not ready to run. Details captured in AttentionReason field." } ] } }, "ExecutionState": { "type": "string", "description": "Drill Execution State", "enum": [ "NotRunning", "Running", "Paused" ], "x-ms-enum": { "name": "ExecutionState", "modelAsString": true, "values": [ { "name": "NotRunning", "value": "NotRunning", "description": "Drill is not running currently." }, { "name": "Running", "value": "Running", "description": "Drill is running currently." }, { "name": "Paused", "value": "Paused", "description": "Drill is paused, waiting for manual resume." } ] } }, "ExtensionObjectState": { "type": "string", "description": "Enum for AttentionReason - Extension Object State.", "enum": [ "Exists", "NotExists" ], "x-ms-enum": { "name": "ExtensionObjectState", "modelAsString": true, "values": [ { "name": "Exists", "value": "Exists", "description": "Extension object exists." }, { "name": "NotExists", "value": "NotExists", "description": "Extension object not exists." } ] } }, "FailedDrillResource": { "type": "object", "description": "Failed Include, Exclude or Update resource.", "properties": { "id": { "type": "string", "format": "arm-id", "description": "Id of the failed drill resource.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "microsoft.azureresiliencemanagement/drills/drillresources" } ] } }, "resourceId": { "type": "string", "format": "arm-id", "description": "Resource Id of the underlying resource of the failed Drill resource.", "x-ms-arm-id-details": { "allowedResources": [] } }, "targetAndCapabilityAssignmentError": { "$ref": "#/definitions/ErrorDetails", "description": "Target and Capability assignment error.", "readOnly": true }, "rbacAssignmentError": { "$ref": "#/definitions/ErrorDetails", "description": "RBAC assignment error.", "readOnly": true } }, "required": [ "id", "resourceId" ] }, "FailoverDirectionTypes": { "type": "string", "description": "Types of Failover directions.", "enum": [ "FromSpecificLocations" ], "x-ms-enum": { "name": "FailoverDirectionTypes", "modelAsString": true, "values": [ { "name": "FromSpecificLocations", "value": "FromSpecificLocations", "description": "Failover resources from specific locations." } ] } }, "FailoverRequest": { "type": "object", "description": "Failover post action request.", "properties": { "failoverDirection": { "$ref": "#/definitions/FailoverDirectionTypes", "description": "Type of Failover direction." }, "failoverRequestProperties": { "$ref": "#/definitions/FailoverRequestProperties", "description": "Additional properties for Failover." } }, "required": [ "failoverDirection" ] }, "FailoverRequestProperties": { "type": "object", "description": "Additional properties for Failover.", "properties": { "sourceLocations": { "type": "array", "description": "Source locations from where resources to be failed-over.", "items": { "type": "string" } } }, "required": [ "sourceLocations" ] }, "FailoverState": { "type": "string", "description": "A state specific to the resource that helps identify its Failover state.", "enum": [ "None", "FailedOver", "FailedOverCommitPending", "FailedOverReprotectPending" ], "x-ms-enum": { "name": "FailoverState", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "The resource is Not in failedOver state." }, { "name": "FailedOver", "value": "FailedOver", "description": "The resource is in failed-over state." }, { "name": "FailedOverCommitPending", "value": "FailedOverCommitPending", "description": "The resource is in failover commit pending state." }, { "name": "FailedOverReprotectPending", "value": "FailedOverReprotectPending", "description": "The resource is in reprotect pending state." } ] } }, "FaultDetails": { "type": "object", "description": "Fault Details", "properties": { "faultUrn": { "type": "string", "description": "fault urn.", "minLength": 1 }, "faultName": { "type": "string", "description": "fault name", "minLength": 1, "maxLength": 100 }, "targetResourceId": { "type": "string", "format": "arm-id", "description": "ARMId of the target resource where fault will be applied. For non-NSG, same as ResourceId. For NSG, its the NSG resource and not the actual resource which is to be simulated for faulting." } }, "required": [ "faultUrn", "faultName", "targetResourceId" ] }, "FaultProperties": { "type": "object", "description": "Fault Properties", "properties": { "availableFaults": { "type": "array", "description": "Available faults for this resource.", "items": { "$ref": "#/definitions/FaultDetails" }, "readOnly": true, "x-ms-identifiers": [] }, "defaultFault": { "$ref": "#/definitions/FaultDetails", "description": "Default fault provided by the system.", "readOnly": true }, "overriddenDefaultFault": { "$ref": "#/definitions/FaultDetails", "description": "Override fault provided by the user." }, "customFault": { "$ref": "#/definitions/CustomFaultDetails", "description": "Custom Fault Details selected by user" } } }, "ForceInclusionAndUpdate": { "type": "string", "description": "Enum for ForceInclusionAndUpdate", "enum": [ "Enable", "Disable" ], "x-ms-enum": { "name": "ForceInclusionAndUpdate", "modelAsString": true, "values": [ { "name": "Enable", "value": "Enable", "description": "Enable ForceInclusionAndUpdate." }, { "name": "Disable", "value": "Disable", "description": "Disable ForceInclusionAndUpdate." } ] } }, "GoalAssignment": { "type": "object", "description": "A goal assignment resource in the Azure Resilience Management provider.", "properties": { "properties": { "$ref": "#/definitions/GoalAssignmentProperties", "description": "The resource-specific properties for this resource." }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "GoalAssignmentListResult": { "type": "object", "description": "The response of a GoalAssignment list operation.", "properties": { "value": { "type": "array", "description": "The GoalAssignment items on this page", "items": { "$ref": "#/definitions/GoalAssignment" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "GoalAssignmentProperties": { "type": "object", "description": "Properties of a goal assignment.", "properties": { "goalTemplateId": { "type": "string", "format": "arm-id", "description": "Arm id of the goal template." }, "goalAssignmentType": { "$ref": "#/definitions/GoalAssignmentType", "description": "The type of goal assignment." }, "serviceLevelResources": { "type": "array", "description": "List of service level resources.", "items": { "$ref": "#/definitions/ServiceLevelResource" }, "x-ms-identifiers": [] }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the goal assignment.", "readOnly": true }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "Details of any errors encountered during the operation.", "readOnly": true } }, "required": [ "goalTemplateId", "goalAssignmentType" ] }, "GoalAssignmentPropertiesUpdate": { "type": "object", "description": "Properties of a goal assignment.", "properties": { "goalTemplateId": { "type": "string", "format": "arm-id", "description": "Arm id of the goal template." }, "goalAssignmentType": { "$ref": "#/definitions/GoalAssignmentType", "description": "The type of goal assignment." }, "serviceLevelResources": { "type": "array", "description": "List of service level resources.", "items": { "$ref": "#/definitions/ServiceLevelResource" }, "x-ms-identifiers": [] } } }, "GoalAssignmentType": { "type": "string", "description": "Supported type of goal assignment.", "enum": [ "Resiliency" ], "x-ms-enum": { "name": "GoalAssignmentType", "modelAsString": true, "values": [ { "name": "Resiliency", "value": "Resiliency", "description": "Resiliency goal assignment type." } ] } }, "GoalAssignmentUpdate": { "type": "object", "description": "A goal assignment resource in the Azure Resilience Management provider.", "properties": { "properties": { "$ref": "#/definitions/GoalAssignmentPropertiesUpdate", "description": "The resource-specific properties for this resource." }, "identity": { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate", "description": "The managed service identities assigned to this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "GoalResource": { "type": "object", "description": "A goal resource in the Azure Resilience Management provider.", "properties": { "properties": { "$ref": "#/definitions/GoalResourceProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "GoalResourceListResult": { "type": "object", "description": "The response of a GoalResource list operation.", "properties": { "value": { "type": "array", "description": "The GoalResource items on this page", "items": { "$ref": "#/definitions/GoalResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "GoalResourceProperties": { "type": "object", "description": "Properties of a goal resource.", "properties": { "resourceArmId": { "type": "string", "format": "arm-id", "description": "The fully qualified ARM resource ID represented by this goal resource." }, "highAvailabilityGoalParticipation": { "$ref": "#/definitions/ExclusionState", "description": "Flag which depicts whether the Arm resource is excluded for high availability recommendation." }, "highAvailabilityAttestationStatus": { "$ref": "#/definitions/AttestationState", "description": "Flag which depicts whether the Arm resource is manually attested for high availability recommendation." }, "disasterRecoveryGoalParticipation": { "$ref": "#/definitions/ExclusionState", "description": "Flag which depicts whether the Arm resource is excluded for disaster recovery recommendation." }, "disasterRecoveryAttestationStatus": { "$ref": "#/definitions/AttestationState", "description": "Flag which depicts whether the Arm resource is manually attested for disaster recovery recommendation." }, "exclusionReasonForHighAvailabilityGoals": { "$ref": "#/definitions/ExclusionReason", "description": "Reason for exclusion from high availability goals.", "readOnly": true }, "exclusionReasonForDisasterRecoveryGoals": { "$ref": "#/definitions/ExclusionReason", "description": "Reason for exclusion from disaster recovery goals.", "readOnly": true }, "serviceGroupMemberships": { "type": "array", "description": "List of service groups of which this resource is memberof.", "items": { "$ref": "#/definitions/ServiceGroupMembership" }, "readOnly": true, "x-ms-identifiers": [ "serviceGroupId" ] }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the goal resource.", "readOnly": true } }, "required": [ "resourceArmId", "highAvailabilityGoalParticipation", "highAvailabilityAttestationStatus" ] }, "GoalTemplate": { "type": "object", "description": "Goal template a AzureResilienceProviderHub resource", "properties": { "properties": { "$ref": "#/definitions/GoalTemplateProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "GoalTemplateListResult": { "type": "object", "description": "The response of a GoalTemplate list operation.", "properties": { "value": { "type": "array", "description": "The GoalTemplate items on this page", "items": { "$ref": "#/definitions/GoalTemplate" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "GoalTemplateProperties": { "type": "object", "description": "Definition of goal template property.", "properties": { "description": { "type": "string", "description": "Description string provided by customer." }, "requireHighAvailability": { "$ref": "#/definitions/RequirementSelected", "description": "Option specified by customer under high availability section of goal template" }, "requireDisasterRecovery": { "$ref": "#/definitions/RequirementSelected", "description": "Option specified by customer under disaster recovery section of goal template" }, "regionalRecoveryPointObjective": { "type": "string", "description": "Regional recovery point objective specified by customer. eg, PT15M for 15 minutes" }, "regionalRecoveryTimeObjective": { "type": "string", "description": "Regional recovery time objective specified by customer. eg, PT15M for 15 minutes" }, "goalType": { "$ref": "#/definitions/GoalType", "description": "Type of Goal Template created by customer" }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state", "readOnly": true }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "Details of any errors encountered during the operation.", "readOnly": true } }, "required": [ "goalType" ] }, "GoalTemplatePropertiesUpdate": { "type": "object", "description": "Definition of goal template property.", "properties": { "description": { "type": "string", "description": "Description string provided by customer." }, "requireHighAvailability": { "$ref": "#/definitions/RequirementSelected", "description": "Option specified by customer under high availability section of goal template" }, "requireDisasterRecovery": { "$ref": "#/definitions/RequirementSelected", "description": "Option specified by customer under disaster recovery section of goal template" }, "regionalRecoveryPointObjective": { "type": "string", "description": "Regional recovery point objective specified by customer. eg, PT15M for 15 minutes" }, "regionalRecoveryTimeObjective": { "type": "string", "description": "Regional recovery time objective specified by customer. eg, PT15M for 15 minutes" }, "goalType": { "$ref": "#/definitions/GoalType", "description": "Type of Goal Template created by customer" } } }, "GoalTemplateUpdate": { "type": "object", "description": "Goal template a AzureResilienceProviderHub resource", "properties": { "properties": { "$ref": "#/definitions/GoalTemplatePropertiesUpdate", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "GoalType": { "type": "string", "description": "Supported type of goal.", "enum": [ "Resiliency" ], "x-ms-enum": { "name": "GoalType", "modelAsString": true, "values": [ { "name": "Resiliency", "value": "Resiliency", "description": "Resiliency goal type." } ] } }, "GoalsData": { "type": "object", "description": "Definition of goals data in unified resilience item.", "properties": { "templateId": { "type": "string", "format": "arm-id", "description": "Arm id of the goal template." }, "assignmentId": { "type": "string", "format": "arm-id", "description": "Arm id of the goal assignment." }, "regionalRecoveryPointObjectiveInMinutes": { "$ref": "#/definitions/IsoDuration", "description": "Regional RPO set in resilience goal in minutes." }, "regionalRecoveryPointEstimatedInMinutes": { "$ref": "#/definitions/IsoDuration", "description": "Computed recovery point estimated for the service group in minutes." }, "regionalRecoveryPointObjectiveStatus": { "$ref": "#/definitions/ResilienceHealthStatus", "description": "Regional RPO status of the service group." }, "regionalRecoveryTimeObjectiveInMinutes": { "$ref": "#/definitions/IsoDuration", "description": "Regional RTO set in resilience goal in minutes." }, "regionalRecoveryTimeActualInMinutes": { "$ref": "#/definitions/IsoDuration", "description": "Computed RTA for the service group in minutes." }, "regionalRecoveryTimeObjectiveStatus": { "$ref": "#/definitions/ResilienceHealthStatus", "description": "Regional RTO status of the service group." }, "requireHighAvailability": { "$ref": "#/definitions/UnifiedResilienceItemRequirementSelected", "description": "Whether the resource is required for high availability." }, "requireDisasterRecovery": { "$ref": "#/definitions/UnifiedResilienceItemRequirementSelected", "description": "Whether the resource is required for disaster recovery." } }, "required": [ "templateId", "assignmentId", "regionalRecoveryPointObjectiveStatus", "regionalRecoveryTimeObjectiveStatus" ] }, "HAStatus": { "type": "string", "description": "HA Status", "enum": [ "Enabled", "NotEnabled" ], "x-ms-enum": { "name": "HAStatus", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "HA enabled." }, { "name": "NotEnabled", "value": "NotEnabled", "description": "HA not enabled." } ] } }, "HealthModelPropertiesOfDrill": { "type": "object", "description": "Health Model properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity to use for Health Model operations." }, "healthModelId": { "type": "string", "format": "arm-id", "description": "Full ARM Id of the Health Model.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.CloudHealth/healthmodels" } ] } } }, "required": [ "identity", "healthModelId" ] }, "HealthModelPropertiesOfDrillUpdate": { "type": "object", "description": "Health Model properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity to use for Health Model operations." }, "healthModelId": { "type": "string", "format": "arm-id", "description": "Full ARM Id of the Health Model.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.CloudHealth/healthmodels" } ] } } } }, "HealthStatus": { "type": "string", "description": "Enum for Health Status.", "enum": [ "Healthy", "Degraded", "Unhealthy" ], "x-ms-enum": { "name": "HealthStatus", "modelAsString": true, "values": [ { "name": "Healthy", "value": "Healthy", "description": "Healthy status." }, { "name": "Degraded", "value": "Degraded", "description": "Degraded status." }, { "name": "Unhealthy", "value": "Unhealthy", "description": "Unhealthy Status." } ] } }, "IncludeOrUpdateResource": { "type": "object", "description": "Include or Update resource", "properties": { "id": { "type": "string", "format": "arm-id", "description": "Id of the DrillResource to be included (NOT the ARM Id of the underlying resource).", "x-ms-arm-id-details": { "allowedResources": [ { "type": "microsoft.azureresiliencemanagement/drills/drillresources" } ] } }, "faultProperties": { "$ref": "#/definitions/FaultProperties", "description": "Fault properties." } }, "required": [ "id" ] }, "InitialConfig": { "type": "string", "description": "Enum for Initial config of Drill object.", "enum": [ "Pending", "Complete" ], "x-ms-enum": { "name": "InitialConfig", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending", "description": "Initial config pending." }, { "name": "Complete", "value": "Complete", "description": "Initial config complete." } ] } }, "IsoDuration": { "type": "string", "description": "ISO 8601 duration formats.", "enum": [ "PT15M", "PT1H", "PT4H", "PT24H" ], "x-ms-enum": { "name": "IsoDuration", "modelAsString": true, "values": [ { "name": "PT15M", "value": "PT15M", "description": "15 minutes." }, { "name": "PT1H", "value": "PT1H", "description": "1 hour." }, { "name": "PT4H", "value": "PT4H", "description": "4 hours." }, { "name": "PT24H", "value": "PT24H", "description": "24 hours." } ] } }, "JobErrorInfo": { "type": "object", "description": "Job Error information.", "properties": { "errorCode": { "type": "string", "description": "A code representing the error.", "readOnly": true }, "errorMessage": { "type": "string", "description": "A detailed message explaining the error.", "readOnly": true }, "recommendations": { "type": "array", "description": "A list of recommendations to resolve the error.", "items": { "type": "string" }, "readOnly": true } } }, "JobExecutionDetails": { "type": "object", "description": "Job Execution Details.", "properties": { "status": { "$ref": "#/definitions/JobStatus", "description": "The current status of the job execution.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job execution.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the job execution.", "readOnly": true }, "duration": { "type": "string", "format": "duration", "description": "The time elapsed during the execution of this job.", "readOnly": true }, "errorDetails": { "$ref": "#/definitions/JobErrorInfo", "description": "Details of any errors that occurred during the execution of this job." } } }, "JobExtendedInfo": { "type": "object", "description": "Additional information for job.", "properties": { "tasksList": { "type": "array", "description": "List of tasks associated with this job.", "items": { "$ref": "#/definitions/JobTaskDetail" }, "readOnly": true, "x-ms-identifiers": [] }, "dynamicErrorMessage": { "type": "string", "description": "Non localized error message on job execution.", "readOnly": true } } }, "JobProperties": { "type": "object", "description": "Definition of a job, including its type, status, timing, and additional details.", "properties": { "status": { "$ref": "#/definitions/JobStatus", "description": "The current status of the job execution.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job execution.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the job execution.", "readOnly": true }, "duration": { "type": "string", "format": "duration", "description": "The time elapsed during the execution of this job.", "readOnly": true }, "errorDetails": { "$ref": "#/definitions/JobErrorInfo", "description": "Details of any errors that occurred during the execution of this job." }, "resourceId": { "type": "string", "format": "arm-id", "description": "The resource for which this job was created. This is typically the resource that the job is intended to manage or operate on.", "readOnly": true }, "operation": { "type": "string", "description": "The operation that this job is intended to perform.", "readOnly": true }, "retryDetails": { "type": "array", "description": "Details of any retries that have been attempted for this job.", "items": { "$ref": "#/definitions/JobRetryDetails" }, "x-ms-identifiers": [] }, "jobExtendedInfo": { "$ref": "#/definitions/JobExtendedInfo", "description": "Additional information about the job." }, "userComments": { "type": "array", "description": "User Comments.", "items": { "$ref": "#/definitions/JobUserComment" }, "readOnly": true, "x-ms-identifiers": [] }, "jobType": { "$ref": "#/definitions/JobType", "description": "The type of job.", "readOnly": true }, "triggeredBy": { "$ref": "#/definitions/JobTriggeredBy", "description": "Indicates whether the job was triggered by the system or a user.", "readOnly": true } }, "discriminator": "jobType", "required": [ "jobType" ] }, "JobResourceProperties": { "type": "object", "description": "Definition of job-resource.", "properties": { "status": { "$ref": "#/definitions/JobStatus", "description": "The current status of the job execution.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job execution.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the job execution.", "readOnly": true }, "duration": { "type": "string", "format": "duration", "description": "The time elapsed during the execution of this job.", "readOnly": true }, "errorDetails": { "$ref": "#/definitions/JobErrorInfo", "description": "Details of any errors that occurred during the execution of this job." }, "resourceId": { "type": "string", "format": "arm-id", "description": "The resource for which this job was created. This is typically the resource that the job is intended to manage or operate on.", "readOnly": true }, "operation": { "type": "string", "description": "The operation that this job is intended to perform.", "readOnly": true }, "retryDetails": { "type": "array", "description": "Details of any retries that have been attempted for this job.", "items": { "$ref": "#/definitions/JobRetryDetails" }, "x-ms-identifiers": [] }, "jobExtendedInfo": { "$ref": "#/definitions/JobExtendedInfo", "description": "Additional information about the job." }, "userComments": { "type": "array", "description": "User Comments.", "items": { "$ref": "#/definitions/JobUserComment" }, "readOnly": true, "x-ms-identifiers": [] }, "jobId": { "type": "string", "description": "Id of the Job under which this job-resource exists.", "readOnly": true }, "taskId": { "type": "string", "description": "Id of the job-task to which this job resource is associated.", "readOnly": true }, "taskName": { "type": "string", "description": "Friendly name of the job-task to which this job resource is associated.", "readOnly": true }, "jobResourceType": { "$ref": "#/definitions/JobResourceType", "description": "Discriminator for the JobResource object hierarchy." } }, "discriminator": "jobResourceType", "required": [ "jobResourceType" ] }, "JobResourceType": { "type": "string", "description": "A job resource type indicates the kind of jobresource.", "enum": [ "Invalid", "RecoveryPlan", "RecoveryPlanChild", "DrillRun", "ChaosExperiment" ], "x-ms-enum": { "name": "JobResourceType", "modelAsString": true, "values": [ { "name": "Invalid", "value": "Invalid", "description": "Abstract job resource - invalid." }, { "name": "RecoveryPlan", "value": "RecoveryPlan", "description": "Recovery Orchestration Plan created job resource." }, { "name": "RecoveryPlanChild", "value": "RecoveryPlanChild", "description": "Recovery Orchestration Plan child created job resource." }, { "name": "DrillRun", "value": "DrillRun", "description": "Drill Run job resource." }, { "name": "ChaosExperiment", "value": "ChaosExperiment", "description": "Chaos job resource created by Drill to represent a Experiment Run." } ] } }, "JobRetryDetails": { "type": "object", "description": "Job Retry Details.", "properties": { "status": { "$ref": "#/definitions/JobStatus", "description": "The current status of the job execution.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job execution.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the job execution.", "readOnly": true }, "duration": { "type": "string", "format": "duration", "description": "The time elapsed during the execution of this job.", "readOnly": true }, "errorDetails": { "$ref": "#/definitions/JobErrorInfo", "description": "Details of any errors that occurred during the execution of this job." }, "retryAttempt": { "type": "integer", "format": "int32", "description": "The retry attempt number of the job." } }, "required": [ "retryAttempt" ] }, "JobStatus": { "type": "string", "description": "Job Statuses", "enum": [ "NotStarted", "Pending", "InProgress", "Completed", "CompletedWithWarnings", "Failed", "Skipped", "Cancelling", "Cancelled", "Paused" ], "x-ms-enum": { "name": "JobStatus", "modelAsString": true, "values": [ { "name": "NotStarted", "value": "NotStarted", "description": "The job has not started yet." }, { "name": "Pending", "value": "Pending", "description": "The job is pending execution, awaiting the completion of dependent stages." }, { "name": "InProgress", "value": "InProgress", "description": "The job is currently in progress." }, { "name": "Completed", "value": "Completed", "description": "The job has been completed successfully." }, { "name": "CompletedWithWarnings", "value": "CompletedWithWarnings", "description": "The job has been completed with warnings." }, { "name": "Failed", "value": "Failed", "description": "The job has failed." }, { "name": "Skipped", "value": "Skipped", "description": "The job skipped for the resource (resource not qualified or not applicable)." }, { "name": "Cancelling", "value": "Cancelling", "description": "The job is in the process of being cancelled." }, { "name": "Cancelled", "value": "Cancelled", "description": "The job has been cancelled." }, { "name": "Paused", "value": "Paused", "description": "The job is currently paused." } ] } }, "JobTaskDetail": { "type": "object", "description": "Job task details.", "properties": { "status": { "$ref": "#/definitions/JobStatus", "description": "The current status of the job execution.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job execution.", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "The end time of the job execution.", "readOnly": true }, "duration": { "type": "string", "format": "duration", "description": "The time elapsed during the execution of this job.", "readOnly": true }, "errorDetails": { "$ref": "#/definitions/JobErrorInfo", "description": "Details of any errors that occurred during the execution of this job." }, "taskId": { "type": "string", "description": "Identifier of the task.", "readOnly": true }, "taskName": { "type": "string", "description": "Friendly name of the task.", "readOnly": true }, "linkedJobIds": { "type": "array", "description": "Identifiers of linked jobs to this task.", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource." }, "readOnly": true }, "userComments": { "type": "array", "description": "User Comments.", "items": { "$ref": "#/definitions/JobUserComment" }, "readOnly": true, "x-ms-identifiers": [] }, "subTasksList": { "type": "array", "description": "List of sub-tasks associated with this job.", "items": { "$ref": "#/definitions/JobTaskDetail" }, "readOnly": true, "x-ms-identifiers": [] } } }, "JobTriggeredBy": { "type": "string", "description": "Job TriggeredBy", "enum": [ "System", "User" ], "x-ms-enum": { "name": "JobTriggeredBy", "modelAsString": true, "values": [ { "name": "System", "value": "System", "description": "Triggered by the system." }, { "name": "User", "value": "User", "description": "Triggered by the user." } ] } }, "JobType": { "type": "string", "description": "A job type indicates the kind of job.", "enum": [ "Invalid", "RecoveryPlan", "RecoveryPlanChild", "DrillRun", "DrillRunChild", "ChaosExperiment", "ChaosExperimentChild" ], "x-ms-enum": { "name": "JobType", "modelAsString": true, "values": [ { "name": "Invalid", "value": "Invalid", "description": "Abstract job - invalid." }, { "name": "RecoveryPlan", "value": "RecoveryPlan", "description": "Recovery Orchestration Plan created job." }, { "name": "RecoveryPlanChild", "value": "RecoveryPlanChild", "description": "Recovery Orchestration Plan child created job." }, { "name": "DrillRun", "value": "DrillRun", "description": "Drill Oober job which represents a given instance of Drill." }, { "name": "DrillRunChild", "value": "DrillRunChild", "description": "Drill Run child job." }, { "name": "ChaosExperiment", "value": "ChaosExperiment", "description": "Chaos job created by Drill to represent a Experiment Run." }, { "name": "ChaosExperimentChild", "value": "ChaosExperimentChild", "description": "Chaos job's child job." } ] } }, "JobUserComment": { "type": "object", "description": "Job User's Comment.", "properties": { "commentTime": { "type": "string", "format": "date-time", "description": "The time of user comment.", "readOnly": true }, "comments": { "type": "string", "description": "User Comment", "readOnly": true } } }, "LastRunProperties": { "type": "object", "description": "Definition of Last Run properties.", "properties": { "lastRunTime": { "type": "string", "format": "date-time", "description": "Timestamp of the last run of this Drill.", "readOnly": true }, "lastRunState": { "$ref": "#/definitions/JobStatus", "description": "Status of the last run of this Drill.", "readOnly": true }, "lastRunDuration": { "type": "string", "format": "duration", "description": "Timespan of the last run of this Drill.", "readOnly": true }, "lastRunAttestation": { "$ref": "#/definitions/DrillAttestation", "description": "Attestation state of the last run of this Drill.", "readOnly": true } } }, "ManagedOnBehalfOfConfiguration": { "type": "object", "description": "Configuration of the managed on behalf of resource.", "properties": { "moboBrokerResources": { "type": "array", "description": "Associated MoboBrokerResources.", "items": { "$ref": "#/definitions/MoboBrokerResource" }, "readOnly": true } } }, "MarkAsCompleteRequest": { "type": "object", "description": "Request body for MarkAsComplete API.", "properties": { "drillRunStage": { "$ref": "#/definitions/DrillRunSubtasks", "description": "State of the Drill Run." } }, "required": [ "drillRunStage" ] }, "MarkAsCompleteResponse": { "type": "object", "description": "Response body for MarkAsComplete API.", "properties": { "supportedVerbsForStage": { "type": "array", "description": "Matrix of Actions supported on Operations.", "items": { "$ref": "#/definitions/SupportedVerbsForStage" }, "readOnly": true, "x-ms-identifiers": [] } } }, "MembershipType": { "type": "string", "description": "Membership type of the service group to resource.", "enum": [ "Direct", "ThroughSubscription", "ThroughResourceGroup" ], "x-ms-enum": { "name": "MembershipType", "modelAsString": true, "values": [ { "name": "Direct", "value": "Direct", "description": "Resource is direct member of service group." }, { "name": "ThroughSubscription", "value": "ThroughSubscription", "description": "Resource is member of service group through subscription." }, { "name": "ThroughResourceGroup", "value": "ThroughResourceGroup", "description": "Resource is member of service group through resource group." } ] } }, "MetricsPropertiesOfDrill": { "type": "object", "description": "Metrics properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity to use for metrics operations." }, "metricsToTrack": { "type": "array", "description": "Metrics associated with this Drill. These will be tracked through the Drill Run.", "items": { "$ref": "#/definitions/MetricsToTrack" }, "x-ms-identifiers": [] } }, "required": [ "identity", "metricsToTrack" ] }, "MetricsPropertiesOfDrillUpdate": { "type": "object", "description": "Metrics properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity to use for metrics operations." }, "metricsToTrack": { "type": "array", "description": "Metrics associated with this Drill. These will be tracked through the Drill Run.", "items": { "$ref": "#/definitions/MetricsToTrack" }, "x-ms-identifiers": [] } } }, "MetricsToTrack": { "type": "object", "description": "Metrics object", "properties": { "metricName": { "type": "string", "description": "Name of the metric.", "minLength": 1 }, "metricId": { "type": "string", "format": "arm-id", "description": "Full url of the metric.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Monitor/slos" } ] } }, "destinationAmwAccountUrl": { "type": "string", "format": "arm-id", "description": "Destination AMW account where the time-series data of the metric lives.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Automation/automationAccounts" } ] } } }, "required": [ "metricName", "metricId", "destinationAmwAccountUrl" ] }, "MoboBrokerResource": { "type": "object", "description": "MoboBroker resource.", "properties": { "id": { "type": "string", "description": "The fully qualified resource ID of the MoboBroker resource.\nExample: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}`", "readOnly": true } } }, "NotQualifiedReasons": { "type": "string", "description": "Protection details of resource.", "enum": [ "InclusionStateExcluded", "ResourceTypeDoesNotSupportOperation", "ResourceProtectionStateDoesNotSupportOperation", "ResourceActiveLocationNotAsPerInput" ], "x-ms-enum": { "name": "NotQualifiedReasons", "modelAsString": true, "values": [ { "name": "InclusionStateExcluded", "value": "InclusionStateExcluded", "description": "Resource is excluded from the Recovery Orchestration Plan." }, { "name": "ResourceTypeDoesNotSupportOperation", "value": "ResourceTypeDoesNotSupportOperation", "description": "Resource Type does not support this operation." }, { "name": "ResourceProtectionStateDoesNotSupportOperation", "value": "ResourceProtectionStateDoesNotSupportOperation", "description": "Resource current protection state does bot support this operation." }, { "name": "ResourceActiveLocationNotAsPerInput", "value": "ResourceActiveLocationNotAsPerInput", "description": "Resource current active location does not match the input." } ] } }, "OperationQualificationDetails": { "type": "object", "description": "Details of qualification for an operation.", "properties": { "qualificationState": { "$ref": "#/definitions/QualificationState", "description": "Resource qualification state for the operation." }, "notQualifiedReasons": { "type": "array", "description": "Reasons for resource not qualified for the operation.", "items": { "type": "string" } } }, "required": [ "qualificationState" ] }, "ProvisioningState": { "type": "string", "description": "The status of the current operation.", "enum": [ "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted" ], "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": "Provisioning", "value": "Provisioning", "description": "Initial provisioning in progress" }, { "name": "Updating", "value": "Updating", "description": "Update in progress" }, { "name": "Deleting", "value": "Deleting", "description": "Deletion in progress" }, { "name": "Accepted", "value": "Accepted", "description": "Change accepted for processing" } ] }, "readOnly": true }, "QualificationState": { "type": "string", "description": "A state type that indicates qualification of a resource for an operation.", "enum": [ "Unknown", "Qualified", "NotQualified", "Excluded" ], "x-ms-enum": { "name": "QualificationState", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "A state that indicates the qualification state is unknown." }, { "name": "Qualified", "value": "Qualified", "description": "A state that indicates the resource is qualified for the operation." }, { "name": "NotQualified", "value": "NotQualified", "description": "A state that indicates the resource is not qualified for the operation." }, { "name": "Excluded", "value": "Excluded", "description": "A state that indicates the resource is excluded from the recovery plan itself." } ] } }, "RBACSetupMode": { "type": "string", "description": "RBAC setup mode.", "enum": [ "AutomatedCustomRole", "AutomatedBuiltinRoles", "Manual" ], "x-ms-enum": { "name": "RBACSetupMode", "modelAsString": true, "values": [ { "name": "AutomatedCustomRole", "value": "AutomatedCustomRole", "description": "Automated-CustomRole mode." }, { "name": "AutomatedBuiltinRoles", "value": "AutomatedBuiltinRoles", "description": "Automated-BuiltinRoles mode." }, { "name": "Manual", "value": "Manual", "description": "Manual mode." } ] } }, "RBACState": { "type": "string", "description": "Enum for AttentionReason - RBAC state on a resource.", "enum": [ "Set", "NotSet" ], "x-ms-enum": { "name": "RBACState", "modelAsString": true, "values": [ { "name": "Set", "value": "Set", "description": "RBAC set." }, { "name": "NotSet", "value": "NotSet", "description": "RBAC not set." } ] } }, "RecommendationsData": { "type": "object", "description": "Definition of recommendations data in unified resilience item.", "properties": { "highAvailability": { "$ref": "#/definitions/RecommendationsHighAvailabilityData", "description": "The high availability section of resilience recommendation." } }, "required": [ "highAvailability" ] }, "RecommendationsHighAvailabilityData": { "type": "object", "description": "Definition of recommendation data related to high availability in unified resilience item.", "properties": { "enabledResourceCount": { "type": "integer", "format": "int64", "description": "Count of resources that have high availability enabled." }, "notEnabledResourceCount": { "type": "integer", "format": "int64", "description": "Count of resources that do not have high availability enabled." }, "notEvaluatedResourceCount": { "type": "integer", "format": "int64", "description": "Count of resources that have not been evaluated for high availability." }, "evaluationDateTime": { "type": "string", "format": "date-time", "description": "The date and time when the high availability recommendations were last evaluated." } } }, "RecoveryChildJob": { "type": "object", "description": "RecoveryPlan Child Job a AzureResilienceProviderHub resource", "properties": { "properties": { "$ref": "#/definitions/RecoveryChildJobProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RecoveryChildJobListResult": { "type": "object", "description": "The response of a RecoveryChildJob list operation.", "properties": { "value": { "type": "array", "description": "The RecoveryChildJob items on this page", "items": { "$ref": "#/definitions/RecoveryChildJob" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RecoveryChildJobProperties": { "type": "object", "description": "Definition of recovery child job associated with Recovery Orchestration Plan.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the recovery child job.", "readOnly": true }, "protectionSolutionType": { "$ref": "#/definitions/ResourceProtectionSolutionType", "description": "A setting that indicates the protection solution selected.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/ChildJobProperties" } ], "x-ms-discriminator-value": "RecoveryPlanChild" }, "RecoveryGroup": { "type": "object", "description": "Represents a recovery orchestration group resource in the Azure Resilience Management provider namespace.", "properties": { "properties": { "$ref": "#/definitions/RecoveryGroupProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RecoveryGroupActionType": { "type": "string", "description": "Specifies the type of recovery orchestration group actions.", "enum": [ "ManualAction", "CustomRunbook" ], "x-ms-enum": { "name": "RecoveryGroupActionType", "modelAsString": true, "values": [ { "name": "ManualAction", "value": "ManualAction", "description": "A manual action type for the recovery orchestration group." }, { "name": "CustomRunbook", "value": "CustomRunbook", "description": "A custom runbook action type for the recovery orchestration group." } ] } }, "RecoveryGroupBaseAction": { "type": "object", "description": "Defines an action for the recovery orchestration group.", "properties": { "name": { "type": "string", "description": "The name of the recovery orchestration group action.", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, "description": { "type": "string", "description": "A description of the recovery orchestration group action, containing the instructions to be performed during this action.", "maxLength": 100 }, "type": { "$ref": "#/definitions/RecoveryGroupActionType", "description": "The type of the recovery orchestration group action." }, "timeoutInMinutes": { "type": "integer", "format": "int32", "description": "The maximum amount of time, in minutes, allowed for the action to complete before it times out.", "minimum": 0, "maximum": 10000 } }, "discriminator": "type", "required": [ "name", "type", "timeoutInMinutes" ] }, "RecoveryGroupCustomRunbookAction": { "type": "object", "description": "Defines a custom runbook action for the recovery orchestration group.", "properties": { "actionResourceId": { "type": "string", "format": "arm-id", "description": "The ARM Resource ID of the resource that includes the actionable script, such as a Runbook in an Automation Account.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Automation/automationAccounts/runbooks" } ] } }, "parameters": { "type": "object", "description": "Key-value parameters for the operation.", "additionalProperties": { "type": "string" } }, "associatedIdentity": { "$ref": "#/definitions/AssociatedIdentity", "description": "The identity associated with actionResourceId for RBAC." } }, "allOf": [ { "$ref": "#/definitions/RecoveryGroupBaseAction" } ], "x-ms-discriminator-value": "CustomRunbook" }, "RecoveryGroupManualAction": { "type": "object", "description": "Defines a manual action for the recovery orchestration group.", "allOf": [ { "$ref": "#/definitions/RecoveryGroupBaseAction" } ], "x-ms-discriminator-value": "ManualAction" }, "RecoveryGroupProperties": { "type": "object", "description": "Properties of the recovery orchestration group.", "properties": { "groupUniqueId": { "type": "string", "description": "A unique id for the recovery orchestration group, which is a GUID.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "orderId": { "type": "integer", "format": "int32", "description": "The order ID of the recovery orchestration group.", "minimum": 0, "maximum": 15 }, "description": { "type": "string", "description": "A description of the recovery orchestration group.", "minLength": 5, "maxLength": 50 }, "preActions": { "type": "array", "description": "Pre-actions for the recovery orchestration group.", "maxItems": 10, "items": { "$ref": "#/definitions/RecoveryGroupBaseAction" }, "x-ms-identifiers": [] }, "postActions": { "type": "array", "description": "Post-actions for the recovery orchestration group.", "maxItems": 10, "items": { "$ref": "#/definitions/RecoveryGroupBaseAction" }, "x-ms-identifiers": [] } }, "required": [ "groupUniqueId", "orderId", "description" ] }, "RecoveryGroupPropertiesUpdate": { "type": "object", "description": "Properties of the recovery orchestration group.", "properties": { "groupUniqueId": { "type": "string", "description": "A unique id for the recovery orchestration group, which is a GUID.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "orderId": { "type": "integer", "format": "int32", "description": "The order ID of the recovery orchestration group.", "minimum": 0, "maximum": 15 }, "description": { "type": "string", "description": "A description of the recovery orchestration group.", "minLength": 5, "maxLength": 50 }, "preActions": { "type": "array", "description": "Pre-actions for the recovery orchestration group.", "maxItems": 10, "items": { "$ref": "#/definitions/RecoveryGroupBaseAction" }, "x-ms-identifiers": [] }, "postActions": { "type": "array", "description": "Post-actions for the recovery orchestration group.", "maxItems": 10, "items": { "$ref": "#/definitions/RecoveryGroupBaseAction" }, "x-ms-identifiers": [] } } }, "RecoveryGroupUpdate": { "type": "object", "description": "Represents a recovery orchestration group resource in the Azure Resilience Management provider namespace.", "properties": { "properties": { "$ref": "#/definitions/RecoveryGroupPropertiesUpdate", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RecoveryGroupsSetting": { "type": "object", "description": "Settings for the recovery orchestration groups.", "properties": { "defaultGroup": { "$ref": "#/definitions/RecoveryGroup", "description": "The default recovery orchestration group setting. Every recovery orchestration plan has a default recovery orchestration group." }, "additionalGroups": { "type": "array", "description": "Additional recovery orchestration group settings.", "maxItems": 14, "items": { "$ref": "#/definitions/RecoveryGroup" }, "x-ms-identifiers": [] } }, "required": [ "defaultGroup" ] }, "RecoveryGroupsSettingUpdate": { "type": "object", "description": "Settings for the recovery orchestration groups.", "properties": { "defaultGroup": { "$ref": "#/definitions/RecoveryGroupUpdate", "description": "The default recovery orchestration group setting. Every recovery orchestration plan has a default recovery orchestration group." }, "additionalGroups": { "type": "array", "description": "Additional recovery orchestration group settings.", "maxItems": 14, "items": { "$ref": "#/definitions/RecoveryGroup" }, "x-ms-identifiers": [] } } }, "RecoveryJob": { "type": "object", "description": "Represents a recovery job resource in the Azure Resilience Management provider namespace.", "properties": { "properties": { "$ref": "#/definitions/RecoveryJobProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RecoveryJobListResult": { "type": "object", "description": "The response of a RecoveryJob list operation.", "properties": { "value": { "type": "array", "description": "The RecoveryJob items on this page", "items": { "$ref": "#/definitions/RecoveryJob" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RecoveryJobProperties": { "type": "object", "description": "Definition of recovery job associated with Recovery Orchestration Plan.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the recovery job.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/JobProperties" } ], "x-ms-discriminator-value": "RecoveryPlan" }, "RecoveryJobResource": { "type": "object", "description": "Represents a recovery orchestration job resource in the Azure Resilience Management provider namespace.", "properties": { "properties": { "$ref": "#/definitions/RecoveryJobResourceProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RecoveryJobResourceListResult": { "type": "object", "description": "The response of a RecoveryJobResource list operation.", "properties": { "value": { "type": "array", "description": "The RecoveryJobResource items on this page", "items": { "$ref": "#/definitions/RecoveryJobResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RecoveryJobResourceProperties": { "type": "object", "description": "Properties of a recovery orchestration job resource associated with a recovery orchestration plan.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the recovery job resource.", "readOnly": true }, "protectionSolutionType": { "$ref": "#/definitions/ResourceProtectionSolutionType", "description": "A setting that indicates the protection solution selected.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/JobResourceProperties" } ], "x-ms-discriminator-value": "RecoveryPlan" }, "RecoveryOperationNames": { "type": "string", "description": "Defines the set of operations that can be executed on a Recovery Orchestration Plan. These operations are applicable only to resources that meet the qualification criteria.", "enum": [ "Failover", "FailoverCommit", "Reprotect", "TestFailover", "TestFailoverCleanup" ], "x-ms-enum": { "name": "RecoveryOperationNames", "modelAsString": true, "values": [ { "name": "Failover", "value": "Failover", "description": "Initiates a failover process to recover eligible resources to the target location." }, { "name": "FailoverCommit", "value": "FailoverCommit", "description": "Commits the failover for resources that require an explicit commit after recovery." }, { "name": "Reprotect", "value": "Reprotect", "description": "Performs re-protection or configuration changes for resources that have failed over, as required." }, { "name": "TestFailover", "value": "TestFailover", "description": "Initiates a test failover process for qualified resources and those that support test failover." }, { "name": "TestFailoverCleanup", "value": "TestFailoverCleanup", "description": "Cleans up resources and configurations created during a test failover, as required." } ] } }, "RecoveryOperationStatus": { "type": "string", "description": "Specifies the operation status for failover and validation.", "enum": [ "NotStarted", "ValidationInProgress", "InProgress", "Succeeded", "CompletedWithWarning", "ValidationFailed", "Failed", "Canceled" ], "x-ms-enum": { "name": "RecoveryOperationStatus", "modelAsString": true, "values": [ { "name": "NotStarted", "value": "NotStarted", "description": "Operation has not started or ran." }, { "name": "ValidationInProgress", "value": "ValidationInProgress", "description": "Operation is in the process of being validated." }, { "name": "InProgress", "value": "InProgress", "description": "Operation is in progress." }, { "name": "Succeeded", "value": "Succeeded", "description": "Operation has completed successfully." }, { "name": "CompletedWithWarning", "value": "CompletedWithWarning", "description": "Operation has completed but ran into some warning state." }, { "name": "ValidationFailed", "value": "ValidationFailed", "description": "Operation has completed but ran into some validation error state." }, { "name": "Failed", "value": "Failed", "description": "Operation has completed but ran into some error state." }, { "name": "Canceled", "value": "Canceled", "description": "Operation has been canceled by the user." } ] }, "readOnly": true }, "RecoveryPlan": { "type": "object", "description": "Represents a recovery orchestration plan resource in the Azure Resilience Management provider namespace.", "properties": { "properties": { "$ref": "#/definitions/RecoveryPlanProperties", "description": "The resource-specific properties for this resource." }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RecoveryPlanActionBaseResponse": { "type": "object", "description": "Recovery Orchestration Plan post action response.", "properties": { "jobId": { "type": "string", "description": "JobId of the job triggered for Recovery Orchestration Plan." } }, "required": [ "jobId" ] }, "RecoveryPlanExclusionReason": { "type": "string", "description": "Enum for RecoveryPlan Exclusion reason.", "enum": [ "ExcludedFromRecoveryPlan", "ProtectionStatus" ], "x-ms-enum": { "name": "RecoveryPlanExclusionReason", "modelAsString": true, "values": [ { "name": "ExcludedFromRecoveryPlan", "value": "ExcludedFromRecoveryPlan", "description": "Excluded From RecoveryPlan by user." }, { "name": "ProtectionStatus", "value": "ProtectionStatus", "description": "Protection not configured." } ] } }, "RecoveryPlanFailoverOperationStatus": { "type": "object", "description": "Details of the recovery orchestration plan failover operation execution.", "properties": { "lastExecutedAt": { "type": "string", "format": "date-time", "description": "The most recent execution time of the recovery orchestration plan in UTC.", "readOnly": true }, "operationStatus": { "$ref": "#/definitions/RecoveryOperationStatus", "description": "The status of the most recent execution of the recovery orchestration plan.", "readOnly": true }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "Error details for the most recent execution of the recovery orchestration plan.", "readOnly": true }, "recoveryTimeActual": { "type": "string", "format": "duration", "description": "The actual recovery time of the most recent recovery orchestration plan.", "readOnly": true } } }, "RecoveryPlanListResult": { "type": "object", "description": "The response of a RecoveryPlan list operation.", "properties": { "value": { "type": "array", "description": "The RecoveryPlan items on this page", "items": { "$ref": "#/definitions/RecoveryPlan" }, "x-ms-identifiers": [ "id" ] }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RecoveryPlanOperationStatus": { "type": "object", "description": "Details of the recovery orchestration plan operation execution.", "properties": { "lastExecutedAt": { "type": "string", "format": "date-time", "description": "The most recent execution time of the recovery orchestration plan in UTC.", "readOnly": true }, "operationStatus": { "$ref": "#/definitions/RecoveryOperationStatus", "description": "The status of the most recent execution of the recovery orchestration plan.", "readOnly": true }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "Error details for the most recent execution of the recovery orchestration plan.", "readOnly": true } } }, "RecoveryPlanProperties": { "type": "object", "description": "Properties of the recovery orchestration plan.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the recovery orchestration plan.", "readOnly": true }, "planType": { "$ref": "#/definitions/RecoveryPlanType", "description": "The type of the recovery orchestration plan, which can be set during creation but cannot be changed afterward.", "x-ms-mutability": [ "create" ] }, "planState": { "$ref": "#/definitions/RecoveryPlanState", "description": "The current state of the recovery orchestration plan.", "readOnly": true }, "planDescription": { "type": "string", "description": "A description of the recovery orchestration plan.", "minLength": 5, "maxLength": 50 }, "recoveryGroupsSetting": { "$ref": "#/definitions/RecoveryGroupsSetting", "description": "Settings for the recovery orchestration groups associated with the recovery orchestration plan." }, "latestFailoverStatus": { "$ref": "#/definitions/RecoveryPlanFailoverOperationStatus", "description": "The status of the most recent failover operation executed.", "readOnly": true }, "latestValidationStatus": { "$ref": "#/definitions/RecoveryPlanOperationStatus", "description": "The status of the most recent validation performed.", "readOnly": true } }, "required": [ "planType", "planDescription", "recoveryGroupsSetting" ] }, "RecoveryPlanPropertiesOfDrill": { "type": "object", "description": "RecoveryPlan properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity to use for RecoveryPlan operations." }, "recoveryPlanId": { "type": "string", "format": "arm-id", "description": "Recovery Orchestration plan associated with this Drill.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.AzureResilienceManagement/recoveryPlans" } ] } }, "recoveryPlanResourceExcludedCount": { "type": "integer", "format": "int32", "description": "Excluded resource count in RecoveryPlan.", "readOnly": true } }, "required": [ "identity" ] }, "RecoveryPlanPropertiesOfDrillUpdate": { "type": "object", "description": "RecoveryPlan properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity to use for RecoveryPlan operations." } } }, "RecoveryPlanPropertiesUpdate": { "type": "object", "description": "Properties of the recovery orchestration plan.", "properties": { "planDescription": { "type": "string", "description": "A description of the recovery orchestration plan.", "minLength": 5, "maxLength": 50 }, "recoveryGroupsSetting": { "$ref": "#/definitions/RecoveryGroupsSettingUpdate", "description": "Settings for the recovery orchestration groups associated with the recovery orchestration plan." } } }, "RecoveryPlanState": { "type": "string", "description": "Specifies the state of the recovery orchestration plan.", "enum": [ "UnderEdit", "Warning", "Ready" ], "x-ms-enum": { "name": "RecoveryPlanState", "modelAsString": true, "values": [ { "name": "UnderEdit", "value": "UnderEdit", "description": "The recovery orchestration plan is currently being edited." }, { "name": "Warning", "value": "Warning", "description": "The recovery orchestration plan is in a warning state." }, { "name": "Ready", "value": "Ready", "description": "The recovery orchestration plan is ready." } ] } }, "RecoveryPlanType": { "type": "string", "description": "Specifies the type of recovery orchestration plan.", "enum": [ "Regional", "Zonal" ], "x-ms-enum": { "name": "RecoveryPlanType", "modelAsString": true, "values": [ { "name": "Regional", "value": "Regional", "description": "A recovery orchestration plan for regional resiliency." }, { "name": "Zonal", "value": "Zonal", "description": "A recovery orchestration plan for zonal resiliency." } ] } }, "RecoveryPlanUpdate": { "type": "object", "description": "Represents a recovery orchestration plan resource in the Azure Resilience Management provider namespace.", "properties": { "properties": { "$ref": "#/definitions/RecoveryPlanPropertiesUpdate", "description": "The resource-specific properties for this resource." }, "identity": { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ManagedServiceIdentityUpdate", "description": "The managed service identities assigned to this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RecoveryResource": { "type": "object", "description": "RecoveryPlan Resource a AzureResilienceProviderHub resource", "properties": { "properties": { "$ref": "#/definitions/RecoveryResourceProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RecoveryResourceListResult": { "type": "object", "description": "The response of a RecoveryResource list operation.", "properties": { "value": { "type": "array", "description": "The RecoveryResource items on this page", "items": { "$ref": "#/definitions/RecoveryResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RecoveryResourceProperties": { "type": "object", "description": "Definition of recovery orchestration resource property associated with recovery orchestration plan.", "properties": { "recoveryResourceUniqueId": { "type": "string", "description": "A unique id for the recovery resource, which is a GUID.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state", "readOnly": true }, "resourceId": { "type": "string", "format": "arm-id", "description": "Resource ID of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.", "readOnly": true }, "resourceLocation": { "type": "string", "description": "Original location of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.", "readOnly": true }, "inclusionState": { "$ref": "#/definitions/ResourceInclusionState", "description": "A state that indicates the resource status with respect to the recovery orchestration plan." }, "needsAttention": { "type": "boolean", "description": "Indicating if resource needs user attention and action, details will be found in attentionReasons", "default": false, "readOnly": true }, "attentionReasons": { "type": "array", "description": "Reason for the resource to be in need of attention", "items": { "type": "string" }, "readOnly": true }, "protectionStatus": { "$ref": "#/definitions/ResourceProtectionStatus", "description": "A status that indicates the protection status of a resource with an Azure solution for regional or zonal recovery.", "readOnly": true }, "resourceProtectionSolutions": { "type": "array", "description": "A list of ResourceProtectionSolutions with which the recovery orchestration resource is protected.", "items": { "$ref": "#/definitions/ResourceProtectionSolutionSettings" }, "readOnly": true, "x-ms-identifiers": [] }, "selectedProtectionSolutionType": { "$ref": "#/definitions/ResourceProtectionSolutionType", "description": "A setting that indicates the protection solution selected." }, "selectedProtectionSolutionSetting": { "$ref": "#/definitions/ResourceBaseProtectionSolutionSetting", "description": "Resource protection solution settings of the protection solutions recovery orchestration resource is protected with." }, "recoveryGroupId": { "type": "string", "description": "The recovery orchestration group id associated with the recovery resources.", "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "associatedIdentity": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity details associated to the resource, which will be used for performing any operations on it" }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "Error details associated with the resource.", "readOnly": true } }, "required": [ "recoveryResourceUniqueId" ] }, "RecoveryResourceQualification": { "type": "object", "description": "Details of resource and its qualification for an operation", "properties": { "recoveryResource": { "$ref": "#/definitions/RecoveryResource", "description": "Recovery orchestration resource." }, "operationQualificationDetails": { "$ref": "#/definitions/OperationQualificationDetails", "description": "Details of qualification for the operation." } }, "required": [ "recoveryResource", "operationQualificationDetails" ] }, "RefreshGoalResourcesResponse": { "type": "object", "description": "Response model for refresh goal resources.", "properties": { "resourceCount": { "type": "integer", "format": "int32", "description": "Total count of resources under the goal assignment after refresh." }, "lastRefreshTime": { "type": "string", "format": "date-time", "description": "Time when the refresh operation was last performed." } } }, "RegionalDrill": { "type": "object", "description": "Regional Drill resource", "properties": { "properties": { "$ref": "#/definitions/RegionalDrillProperties", "description": "The resource-specific properties for this resource." }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "RegionalDrillProperties": { "type": "object", "description": "Definition of Regional Drill properties.", "allOf": [ { "$ref": "#/definitions/DrillProperties" } ], "x-ms-discriminator-value": "Regional" }, "RelativeResourceCompositionState": { "type": "string", "description": "Enum for AttentionReason - Resource state sync between two objects.", "enum": [ "InSync", "OutOfSync" ], "x-ms-enum": { "name": "RelativeResourceCompositionState", "modelAsString": true, "values": [ { "name": "InSync", "value": "InSync", "description": "Resources in sync." }, { "name": "OutOfSync", "value": "OutOfSync", "description": "Resources out of sync." } ] } }, "RequirementSelected": { "type": "string", "description": "Enum for the requirement status of the resource in the goal.", "enum": [ "NotRequired", "Required" ], "x-ms-enum": { "name": "RequirementSelected", "modelAsString": true, "values": [ { "name": "NotRequired", "value": "NotRequired", "description": "The resource is not required for the specified goal." }, { "name": "Required", "value": "Required", "description": "The resource is required for the specified goal." } ] } }, "ResilienceHealthStatus": { "type": "string", "description": "enum for Resilience health status.", "enum": [ "NotEvaluated", "Unhealthy", "Healthy" ], "x-ms-enum": { "name": "ResilienceHealthStatus", "modelAsString": true, "values": [ { "name": "NotEvaluated", "value": "NotEvaluated", "description": "Resource is not evaluated." }, { "name": "Unhealthy", "value": "Unhealthy", "description": "Resource is Unhealthy." }, { "name": "Healthy", "value": "Healthy", "description": "Resource is Healthy." } ] } }, "ResourceBaseProtectionSolutionSetting": { "type": "object", "description": "Definition of recovery orchestration resource protection solution setting with recovery orchestration plan.", "properties": { "protectionSolutionType": { "$ref": "#/definitions/ResourceProtectionSolutionType", "description": "A setting that indicates the resource protected with which recovery solution." } }, "discriminator": "protectionSolutionType", "required": [ "protectionSolutionType" ] }, "ResourceCustomProtectionAction": { "type": "object", "description": "Definition of recovery resource custom action setting with Recovery Orchestration Plan.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "The Azure resource ID hosting the custom action automation script.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Automation/automationAccounts/runbooks" } ] } } }, "required": [ "resourceId" ] }, "ResourceCustomProtectionSetting": { "type": "object", "description": "Definition of recovery orchestration resource custom protection setting with recovery orchestration plan.", "properties": { "failoverAction": { "$ref": "#/definitions/ResourceCustomProtectionAction", "description": "The Azure resource ID hosting the failover automation script." }, "failoverCommitAction": { "$ref": "#/definitions/ResourceCustomProtectionAction", "description": "The Azure resource ID hosting the failover commit automation script." }, "testFailoverAction": { "$ref": "#/definitions/ResourceCustomProtectionAction", "description": "The Azure resource ID hosting the test failover automation script." }, "testFailoverCleanupAction": { "$ref": "#/definitions/ResourceCustomProtectionAction", "description": "The Azure resource ID hosting the test failover cleanup automation script." }, "reprotectAction": { "$ref": "#/definitions/ResourceCustomProtectionAction", "description": "The Azure resource ID hosting the reprotect automation script." } }, "allOf": [ { "$ref": "#/definitions/ResourceBaseProtectionSolutionSetting" } ], "x-ms-discriminator-value": "CustomRunbook" }, "ResourceInclusionState": { "type": "string", "description": "A state type that indicates inclusion of the resource with respect to the resiliency support.", "enum": [ "Included", "Excluded" ], "x-ms-enum": { "name": "ResourceInclusionState", "modelAsString": true, "values": [ { "name": "Included", "value": "Included", "description": "A state that indicates the resource is included." }, { "name": "Excluded", "value": "Excluded", "description": "A state that indicates the resource is excluded." } ] } }, "ResourceLists": { "type": "object", "description": "Add, Update, Delete resource lists", "properties": { "includeResources": { "type": "array", "description": "Include resource", "items": { "$ref": "#/definitions/IncludeOrUpdateResource" }, "x-ms-identifiers": [] }, "excludeResources": { "type": "array", "description": "Excluded resource", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource.", "x-ms-arm-id-details": { "allowedResources": [] } } }, "updateResources": { "type": "array", "description": "Update resource", "items": { "$ref": "#/definitions/IncludeOrUpdateResource" }, "x-ms-identifiers": [] } } }, "ResourceNativeProtectionSolutionSetting": { "type": "object", "description": "Definition of recovery orchestration resource native protection solution setting with recovery orchestration plan.", "allOf": [ { "$ref": "#/definitions/ResourceBaseProtectionSolutionSetting" } ], "x-ms-discriminator-value": "AzureNative" }, "ResourceProtectionSolutionSettings": { "type": "object", "description": "Definition of recovery resource resource protection solution settings.", "properties": { "protectionSolutionType": { "$ref": "#/definitions/ResourceProtectionSolutionType", "description": "A setting that indicates the resource protected with which recovery solution.", "readOnly": true }, "protectionStatus": { "$ref": "#/definitions/ResourceProtectionStatus", "description": "A status that indicates the protection status of a resource with an Azure solution for regional or zonal recovery.", "readOnly": true }, "resourceId": { "type": "string", "format": "arm-id", "description": "Resource ID of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.", "readOnly": true }, "activeLocation": { "type": "string", "description": "Active location of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.", "readOnly": true }, "recoveryLocations": { "type": "array", "description": "List of recovery locations of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.", "items": { "type": "string" }, "readOnly": true }, "replicationRole": { "$ref": "#/definitions/ResourceReplicationRole", "description": "Specifies the role of the resource in the replication process.", "readOnly": true }, "primaryResource": { "type": "string", "format": "arm-id", "description": "Primary resource which is getting replicated.", "readOnly": true }, "replicaResources": { "type": "array", "description": "List of Replica resources to which replication is happening.", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource." }, "readOnly": true }, "isAutoFailover": { "type": "boolean", "description": "Is AutoFailover configured for the resource replication.", "default": false, "readOnly": true }, "failoverState": { "$ref": "#/definitions/FailoverState", "description": "Failover state of the recovery orchestration resource.", "readOnly": true }, "testFailoverState": { "$ref": "#/definitions/TestFailoverState", "description": "TestFailover state of the recovery orchestration resource.", "readOnly": true } }, "required": [ "isAutoFailover" ] }, "ResourceProtectionSolutionType": { "type": "string", "description": "Protection solution type for the resources by which recovery takes place", "enum": [ "None", "AzureNative", "AzureSiteRecovery", "CrossZoneVMRecovery", "CustomRunbook" ], "x-ms-enum": { "name": "ResourceProtectionSolutionType", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "Resource is not protected with any protection solution." }, { "name": "AzureNative", "value": "AzureNative", "description": "Resource is protected with the Azure native solution provided by the native Azure service." }, { "name": "AzureSiteRecovery", "value": "AzureSiteRecovery", "description": "Resource protected with the Azure solution provided by the native Azure Site Service for Azure VMs." }, { "name": "CrossZoneVMRecovery", "value": "CrossZoneVMRecovery", "description": "Cross zone recovery enabled Azure VMs." }, { "name": "CustomRunbook", "value": "CustomRunbook", "description": "Resource is not protected with native solution and using custom runbook automation scripts for recovery verbs." } ] } }, "ResourceProtectionStatus": { "type": "string", "description": "A state type that indicates the protection status of a resource with an Azure solution for regional or zonal recovery.", "enum": [ "Unknown", "Protected", "NotProtected" ], "x-ms-enum": { "name": "ResourceProtectionStatus", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "The protection status of the resource is unknown." }, { "name": "Protected", "value": "Protected", "description": "A state indicating that the resource is protected by the recovery solution." }, { "name": "NotProtected", "value": "NotProtected", "description": "A state indicating that the resource is not protected by any recovery solution." } ] } }, "ResourceReplicationRole": { "type": "string", "description": "A state specific to the resource that helps identify its role in replication.", "enum": [ "Unknown", "Primary", "Replica" ], "x-ms-enum": { "name": "ResourceReplicationRole", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "The role of the resource is unknown." }, { "name": "Primary", "value": "Primary", "description": "A state indicating that the resource is primary and actively replicating data to other replicas." }, { "name": "Replica", "value": "Replica", "description": "A state indicating that the resource is a replica, receiving data from the primary." } ] } }, "ResourceSiteRecoveryProtectionSetting": { "type": "object", "description": "Definition of recovery orchestration resource protection with azure site recovery.", "properties": { "testFailoverParams": { "$ref": "#/definitions/ResourceSiteRecoveryTestFailoverParams", "description": "Test failover params for azure site recovery solution." }, "testFailoverCleanupParams": { "$ref": "#/definitions/ResourceSiteRecoveryTestFailoverCleanupParams", "description": "Test failover params for azure site recovery solution." }, "reprotectParams": { "$ref": "#/definitions/ResourceSiteRecoveryReprotectParams", "description": "Reprotect params for azure site recovery solution." } }, "allOf": [ { "$ref": "#/definitions/ResourceBaseProtectionSolutionSetting" } ], "x-ms-discriminator-value": "AzureSiteRecovery" }, "ResourceSiteRecoveryReprotectParams": { "type": "object", "description": "Definition of recovery resource reprotect params for site recovery solution.", "properties": { "diskReprotectInputDetails": { "type": "array", "description": "Disk Reprotect Input Details", "items": { "$ref": "#/definitions/DiskReprotectInputDetails" }, "x-ms-identifiers": [] } } }, "ResourceSiteRecoveryTestFailoverCleanupParams": { "type": "object", "description": "Definition of recovery resource reprotect params for site recovery solution.", "properties": { "comments": { "type": "string", "description": "Comments for testfailover cleanup" } } }, "ResourceSiteRecoveryTestFailoverParams": { "type": "object", "description": "Definition of recovery resource failover params for site recovery solution.", "properties": { "networkResourceId": { "type": "string", "format": "arm-id", "description": "The Azure network resource is which will be used for test failover virtual machine.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Network/virtualNetworks" } ] } } } }, "ServiceGroupAndRequestHeadersParameters": { "type": "object", "description": "ServiceGroup tenant and request headers as parameter", "properties": { "serviceGroupName": { "type": "string", "description": "The name of the service group.", "pattern": "^[a-zA-Z0-9\\-_().~]{1,90}$" }, "apiVersion": { "type": "string", "description": "The API version to use for this operation.", "minLength": 1 } }, "required": [ "serviceGroupName", "apiVersion" ] }, "ServiceGroupMembership": { "type": "object", "description": "Model for service group membership.", "properties": { "serviceGroupId": { "type": "string", "format": "arm-id", "description": "Arm Id of the service group." }, "membershipType": { "$ref": "#/definitions/MembershipType", "description": "Membership type of the service group to resource." } }, "required": [ "serviceGroupId", "membershipType" ] }, "ServiceGroupParameters": { "type": "object", "description": "ServiceGroup as parameter", "properties": { "serviceGroupName": { "type": "string", "description": "The name of the service group.", "pattern": "^[a-zA-Z0-9\\-_().~]{1,90}$" }, "apiVersion": { "type": "string", "description": "The API version to use for this operation.", "minLength": 1 } }, "required": [ "serviceGroupName", "apiVersion" ] }, "ServiceGroupTenantParameters": { "type": "object", "description": "ServiceGroup tenant as parameter", "properties": { "serviceGroupName": { "type": "string", "description": "The name of the service group.", "pattern": "^[a-zA-Z0-9\\-_().~]{1,90}$" }, "apiVersion": { "type": "string", "description": "The API version to use for this operation.", "minLength": 1 }, "skipToken": { "type": "string", "description": "Skip over when retrieving results." }, "top": { "type": "integer", "format": "int32", "description": "Number of elements to return when retrieving results.", "minimum": 1, "maximum": 100 } }, "required": [ "serviceGroupName", "apiVersion" ] }, "ServiceLevelResource": { "type": "object", "description": "A service-level resource associated with a goal assignment.", "properties": { "serviceLevelIndicatorResourceId": { "type": "string", "format": "arm-id", "description": "The ARM resource ID of the service-level indicator resource." }, "serviceLevelObjectiveResourceId": { "type": "string", "format": "arm-id", "description": "The ARM resource ID of the service-level objective resource." } }, "required": [ "serviceLevelIndicatorResourceId", "serviceLevelObjectiveResourceId" ] }, "SupportedVerbsForStage": { "type": "object", "description": "Model for supported verbs for stage.", "properties": { "drillRunStage": { "$ref": "#/definitions/DrillRunSubtasks", "description": "Name of stage." }, "supportedVerbs": { "type": "array", "description": "Supported Verbs for stage.", "items": { "$ref": "#/definitions/DrillRunOperationVerbs" } } }, "required": [ "drillRunStage", "supportedVerbs" ] }, "SystemMetadata": { "type": "object", "description": "Internal System Metadata, to be used by internal components only.", "properties": { "initialConfig": { "$ref": "#/definitions/InitialConfig", "description": "Indicates if the Initial system configuration of the Drill is complete or not." } }, "required": [ "initialConfig" ] }, "TestFailoverCleanupRequest": { "type": "object", "description": "TestFailoverCleanup post action request.", "properties": { "comments": { "type": "string", "description": "Comments for test failover cleanup.", "maxLength": 1024 } } }, "TestFailoverState": { "type": "string", "description": "A state specific to the resource that helps identify its TestFailover state.", "enum": [ "None", "TestFailoverCleanupPending" ], "x-ms-enum": { "name": "TestFailoverState", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "The resource is Not in TestFailedOver state (No test failover cleanup pending)." }, { "name": "TestFailoverCleanupPending", "value": "TestFailoverCleanupPending", "description": "he resource is in test failover cleanup pending state." } ] } }, "UnifiedResilienceItem": { "type": "object", "description": "A unified resilience item represents a computed and aggregated resilience information of Azure Applications.", "properties": { "properties": { "$ref": "#/definitions/UnifiedResilienceItemProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "UnifiedResilienceItemListResult": { "type": "object", "description": "The response of a UnifiedResilienceItem list operation.", "properties": { "value": { "type": "array", "description": "The UnifiedResilienceItem items on this page", "items": { "$ref": "#/definitions/UnifiedResilienceItem" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "UnifiedResilienceItemProperties": { "type": "object", "description": "Definition of unified resilience item property.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state", "readOnly": true }, "goals": { "$ref": "#/definitions/GoalsData", "description": "Computed and copied data of resilience goals." }, "recommendations": { "$ref": "#/definitions/RecommendationsData", "description": "Computed and copied data of Azure recommendations." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Last modified time of the unified resilience item." } }, "required": [ "goals", "recommendations", "lastModifiedTime" ] }, "UnifiedResilienceItemRequirementSelected": { "type": "string", "description": "Enum for the requirement status of the resource in the goal.", "enum": [ "NotRequired", "Required", "NotSelected" ], "x-ms-enum": { "name": "UnifiedResilienceItemRequirementSelected", "modelAsString": true, "values": [ { "name": "NotRequired", "value": "NotRequired", "description": "The resource is not required for the specified goal." }, { "name": "Required", "value": "Required", "description": "The resource is required for the specified goal." }, { "name": "NotSelected", "value": "NotSelected", "description": "The resource is not selected for the specified goal." } ] } }, "UpdateGoalResourceRequest": { "type": "object", "description": "Request body for updating goal resources.", "properties": { "resources": { "type": "array", "description": "The goal resources to update.", "items": { "$ref": "#/definitions/GoalResource" } } }, "required": [ "resources" ] }, "UpdateGoalResourceResponse": { "type": "object", "description": "Response from updating goal resources.", "properties": { "resources": { "type": "array", "description": "The updated goal resources.", "items": { "$ref": "#/definitions/GoalResource" } } }, "required": [ "resources" ] }, "UpdateRecoveryResourcesRequest": { "type": "object", "description": "RecoveryResources post action request to update in batch.", "properties": { "resourcesToUpdate": { "type": "array", "description": "A list of recovery orchestration resources whose properties need to be updated.", "items": { "$ref": "#/definitions/RecoveryResource" }, "x-ms-identifiers": [] }, "resourcesToRemove": { "type": "array", "description": "A list of recovery orchestration resources that need to be removed from the recovery orchestration plan.", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.AzureResilienceManagement/recoveryPlans/recoveryResources" } ] } } } } }, "UpdateRecoveryResourcesResponse": { "type": "object", "description": "RecoveryResources post action request to update in batch.", "properties": { "failedResources": { "type": "array", "description": "A list of error details associated with resources for which the update has failed.", "items": { "$ref": "#/definitions/RecoveryResource" }, "x-ms-identifiers": [] } } }, "VMPresent": { "type": "string", "description": "Enum for VM presence.", "enum": [ "Present", "Absent" ], "x-ms-enum": { "name": "VMPresent", "modelAsString": true, "values": [ { "name": "Present", "value": "Present", "description": "At least one VM is present." }, { "name": "Absent", "value": "Absent", "description": "No VM present." } ] } }, "ValidateForOperationRequest": { "type": "object", "description": "ValidateForOperation post action request to check if operation can be performed.", "properties": { "operationName": { "$ref": "#/definitions/RecoveryOperationNames", "description": "Operation Name to validate." } }, "required": [ "operationName" ] }, "ValidateForRecoveryOperationBaseResponse": { "type": "object", "description": "ValidateForRecoveryOperation post action response.", "properties": { "recoveryResourceQualifications": { "type": "array", "description": "Qualification details of resources for the operation.", "items": { "$ref": "#/definitions/RecoveryResourceQualification" }, "x-ms-identifiers": [] } }, "required": [ "recoveryResourceQualifications" ] }, "ZonalDrill": { "type": "object", "description": "Zonal Drill resource", "properties": { "properties": { "$ref": "#/definitions/ZonalDrillProperties", "description": "The resource-specific properties for this resource." }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ZonalDrillProperties": { "type": "object", "description": "Definition of Zonal Drill properties.", "properties": { "vmsPresent": { "$ref": "#/definitions/VMPresent", "description": "An indication whether a VM is included in this Zonal Drill. If not, RO is not needed.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/DrillProperties" } ], "x-ms-discriminator-value": "Zonal" } }, "parameters": { "QueryParameters.skipToken": { "name": "$skipToken", "in": "query", "description": "Skip over when retrieving results.", "required": false, "type": "string", "x-ms-parameter-location": "method", "x-ms-client-name": "skipToken" }, "QueryParameters.top": { "name": "$top", "in": "query", "description": "Number of elements to return when retrieving results.", "required": false, "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "x-ms-parameter-location": "method", "x-ms-client-name": "top" }, "RequiredRequestHeaders": { "name": "operation-id", "in": "header", "description": "A GUID that represents the Long Running OperationId.", "required": true, "type": "string", "x-ms-parameter-location": "method", "x-ms-client-name": "operationId" }, "ServiceGroupBaseParameters": { "name": "serviceGroupName", "in": "path", "description": "The name of the service group.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9\\-_().~]{1,90}$", "x-ms-parameter-location": "method" } } }