{ "swagger": "2.0", "info": { "title": "Microsoft.AzureResilienceManagement", "version": "2026-10-01", "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": "GoalResources" }, { "name": "RecoveryPlans" }, { "name": "RecoveryPlanActions" }, { "name": "RecoveryResources" }, { "name": "RecoveryJobs" }, { "name": "RecoveryJobResources" }, { "name": "Drills" }, { "name": "DrillResources" }, { "name": "DrillRuns" }, { "name": "DrillRunResources" }, { "name": "UnifiedResilienceItems" }, { "name": "UsagePlans" }, { "name": "Enrollments" } ], "paths": { "/providers/Microsoft.AzureResilienceManagement/locations/{location}/operationStatuses/{operationId}": { "get": { "operationId": "OperationStatus_Get", "tags": [ "OperationStatus" ], "description": "Returns the current status of an async operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/OperationIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationStatusResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "OperationStatus_Get_MaximumSet": { "$ref": "./examples/OperationStatus_Get_MaximumSet_Gen.json" } } } }, "/providers/Microsoft.AzureResilienceManagement/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "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" ], "description": "List Drill resources by tenant", "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" } } }, "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" ], "description": "Get a Drill", "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" } } }, "x-ms-examples": { "Drills_Get_MaximumSet": { "$ref": "./examples/Drills_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "Drills_Create", "tags": [ "Drills" ], "description": "Create a Drill", "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" } } }, "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" ], "description": "Update a Drill", "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" } } }, "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" ], "description": "Delete a Drill", "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" } } }, "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" ], "description": "This enables the user to include, exclude or update resources from their Drill.", "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": { "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" } } }, "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" ], "description": "List DrillResource resources by Drill", "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" } } }, "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" ], "description": "Get a DrillResource", "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" } } }, "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" ], "description": "List DrillRun resources by Drill", "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" } } }, "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" ], "description": "Get a DrillRun", "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" } } }, "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" ], "description": "This enables the user to add notes on this Drill Run.", "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" } } }, "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}/drillRunResources": { "get": { "operationId": "DrillRunResources_List", "tags": [ "DrillRunResources" ], "description": "List DrillRunResource resources by DrillRun", "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" } } }, "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" ], "description": "Get a DrillRunResource", "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" } } }, "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" ], "description": "This initiates a new Failover operation on this Drill Run.", "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": false, "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" } } }, "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}/generateReport": { "post": { "operationId": "DrillRuns_GenerateReport", "tags": [ "DrillRuns" ], "description": "This generates, or regenerates, the report for this Drill Run. The action is idempotent and is safe to call at any time: a call that arrives while a generation is already running joins it, and a call made after a failed attempt retries it. A report that has been finalized is never regenerated.", "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/DrillReportSummary" } }, "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" } } }, "x-ms-examples": { "DrillRuns_GenerateReport_MaximumSet": { "$ref": "./examples/DrillRuns_GenerateReport_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/drills/{drillName}/drillRuns/{drillRunName}/listReportDownloadUrl": { "post": { "operationId": "DrillRuns_ListReportDownloadUrl", "tags": [ "DrillRuns" ], "description": "This returns a short-lived, read-only URL to download the report for this Drill Run. The URL expires at the returned expiryTimestamp and grants access to that single report only.", "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/ListReportDownloadUrlRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ListReportDownloadUrlResponse" } }, "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" } } }, "x-ms-examples": { "DrillRuns_ListReportDownloadUrl_MaximumSet": { "$ref": "./examples/DrillRuns_ListReportDownloadUrl_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "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" ], "description": "This enables the user to mark this stage as complete, disabling further retries on it.", "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" } } }, "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" ], "description": "This initiates a new Reprotect operation on this Drill Run.", "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": false, "schema": { "$ref": "#/definitions/DrillRunReprotectRequest" } } ], "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" } } }, "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" ], "description": "This unblocks a Failover workflow that is paused after the Fault stage, to proceed to the Failover stage.", "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" } } }, "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}/end": { "post": { "operationId": "Drills_End", "tags": [ "Drills" ], "description": "This ends the currently running instance of the Drill.", "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" } } }, "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}/resyncReadinessCheck": { "post": { "operationId": "Drills_ResyncReadinessCheck", "tags": [ "Drills" ], "description": "This triggers detection of any drifts from the desired state of Resources and RBAC.", "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" } } }, "x-ms-examples": { "Drills_ResyncReadinessCheck_MaximumSet": { "$ref": "./examples/Drills_ResyncReadinessCheck_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" ], "description": "This starts a new running instance of the Drill.", "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" } } }, "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/drills/{drillName}/validateForExecution": { "post": { "operationId": "Drills_ValidateForExecution", "tags": [ "Drills" ], "description": "This returns eligible resource to be faulted or failed over.", "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/ValidateForExecutionRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ValidateForExecutionResponse" } }, "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" } } }, "x-ms-examples": { "Drills_ValidateForExecution_MaximumSet": { "$ref": "./examples/Drills_ValidateForExecution_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" ], "description": "Lists goal assignments in a service group.", "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" } } }, "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" ], "description": "Gets a goal assignment.", "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" } } }, "x-ms-examples": { "GoalAssignments_Get_MaximumSet": { "$ref": "./examples/GoalAssignments_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "GoalAssignments_CreateOrUpdate", "tags": [ "GoalAssignments" ], "description": "Creates or updates a goal assignment.", "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" } } }, "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" ], "description": "Updates a goal assignment.", "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" } } }, "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" ], "description": "Deletes a goal assignment.", "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" } } }, "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" ], "description": "Lists goal resources under a goal assignment.", "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" } } }, "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" ], "description": "Gets a goal resource.", "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" } } }, "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}/recommendCapacity": { "post": { "operationId": "GoalAssignments_RecommendCapacity", "tags": [ "GoalAssignments" ], "description": "Recommends capacity improvements for resources under the goal assignment's scope. Returns AI-powered capacity assessments and recommendations.", "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/RecommendCapacityRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecommendCapacityResult" } }, "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" } } }, "x-ms-examples": { "GoalAssignments_RecommendCapacity_MaximumSet": { "$ref": "./examples/GoalAssignments_RecommendCapacity_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}/refreshGoalResources": { "post": { "operationId": "GoalAssignments_RefreshGoalResources", "tags": [ "GoalAssignments" ], "description": "Refreshes the goal resources under a goal assignment. This operation scans for new resources under the scope of the assignment.", "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" } } }, "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" ], "description": "Updates goal resources under a goal assignment.", "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" } } }, "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/recoveryPlans": { "get": { "operationId": "RecoveryPlans_List", "tags": [ "RecoveryPlans" ], "description": "List RecoveryPlan resources by tenant", "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" } } }, "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" ], "description": "Get a RecoveryPlan", "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" } } }, "x-ms-examples": { "RecoveryPlans_Get_MaximumSet": { "$ref": "./examples/RecoveryPlans_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "RecoveryPlans_CreateOrUpdate", "tags": [ "RecoveryPlans" ], "description": "Create a RecoveryPlan", "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" } } }, "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" ], "description": "Update a RecoveryPlan", "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" } } }, "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" ], "description": "Delete a RecoveryPlan", "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" } } }, "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" ], "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.", "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" } } }, "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" ], "description": "This action triggers the failover operation on the recovery orchestration plan for the qualified resources.", "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" } } }, "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" ], "description": "This action triggers the failover commit operation on the recovery orchestration plan for the qualified resources.", "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" } } }, "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" ], "description": "This action finalizes the recovery orchestration plan, ensuring all necessary configurations are in place.", "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" } } }, "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" ], "description": "List RecoveryJob resources by RecoveryPlan", "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" } } }, "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" ], "description": "Get a RecoveryJob", "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" } } }, "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" ], "description": "This action attempts to cancel the ongoing recovery orchestration job.", "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}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/RecoveryActionRequest" } } ], "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" } } }, "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}/recoveryJobResources": { "get": { "operationId": "RecoveryJobResources_List", "tags": [ "RecoveryJobResources" ], "description": "List RecoveryJobResource resources by RecoveryJob", "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" } } }, "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" ], "description": "Get a RecoveryJobResource", "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" } } }, "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" ], "description": "This action resumes the ongoing recovery orchestration job that was paused for required user intervention.", "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}$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/RecoveryActionRequest" } } ], "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" } } }, "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" ], "description": "This action retries the ongoing recovery orchestration job for resources that failed in previous attempts.", "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" } } }, "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" ], "description": "List RecoveryResource resources by RecoveryPlan", "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" } } }, "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" ], "description": "Get a RecoveryResource", "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" } } }, "x-ms-examples": { "RecoveryResources_Get_CrossZoneVMRecovery": { "$ref": "./examples/RecoveryResources_Get_CrossZoneVMRecovery.json" }, "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" ], "description": "This action triggers the reprotect operation on the recovery orchestration plan for the qualified resources.", "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": false, "schema": { "$ref": "#/definitions/ReprotectRequest" } } ], "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" } } }, "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" ], "description": "This action triggers the test failover operation on the recovery orchestration plan for the qualified resources.", "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" } } }, "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" ], "description": "This action triggers the test failover cleanup operation on the recovery orchestration plan for the qualified resources.", "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" } } }, "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" ], "description": "This action adds or updates the resources to be included in the recovery orchestration plan.", "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" } } }, "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" ], "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.", "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" } } }, "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" ], "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.", "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" } } }, "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" ], "description": "This action checks if the recovery orchestration plan is eligible for operations like failover and reprotect, ensuring it meets the necessary criteria.", "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" } } }, "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" ], "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.", "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": false, "schema": { "$ref": "#/definitions/ReprotectRequest" } } ], "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" } } }, "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" ], "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.", "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" } } }, "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" ], "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.", "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" } } }, "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" ], "description": "List UnifiedResilienceItem resources by tenant", "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" } } }, "x-ms-examples": { "UnifiedResilienceItems_List_MaximumSet": { "$ref": "./examples/UnifiedResilienceItems_List_MaximumSet_Gen.json" }, "UnifiedResilienceItems_List_MaximumSet - generated by [MinimumSet] rule": { "$ref": "./examples/UnifiedResilienceItems_List_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/serviceGroups/{serviceGroupName}/providers/Microsoft.AzureResilienceManagement/unifiedResilienceItems/{unifiedResilienceItemName}": { "get": { "operationId": "UnifiedResilienceItems_Get", "tags": [ "UnifiedResilienceItems" ], "description": "Get a UnifiedResilienceItem", "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" } } }, "x-ms-examples": { "UnifiedResilienceItems_Get_MaximumSet": { "$ref": "./examples/UnifiedResilienceItems_Get_MaximumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.AzureResilienceManagement/usagePlans": { "get": { "operationId": "UsagePlans_ListBySubscription", "tags": [ "UsagePlans" ], "description": "List UsagePlan resources by subscription ID", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/UsagePlanListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "UsagePlans_ListBySubscription_MaximumSet": { "$ref": "./examples/UsagePlans_ListBySubscription_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureResilienceManagement/usagePlans": { "get": { "operationId": "UsagePlans_ListByResourceGroup", "tags": [ "UsagePlans" ], "description": "List UsagePlan resources by resource group", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/UsagePlanListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "UsagePlans_ListByResourceGroup_MaximumSet": { "$ref": "./examples/UsagePlans_ListByResourceGroup_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureResilienceManagement/usagePlans/{usagePlanName}": { "get": { "operationId": "UsagePlans_Get", "tags": [ "UsagePlans" ], "description": "Get a UsagePlan", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "usagePlanName", "in": "path", "description": "The name of the usage plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/UsagePlan" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "UsagePlans_Get_MaximumSet": { "$ref": "./examples/UsagePlans_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "UsagePlans_CreateOrUpdate", "tags": [ "UsagePlans" ], "description": "Create a UsagePlan", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "usagePlanName", "in": "path", "description": "The name of the usage plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/UsagePlan" } } ], "responses": { "200": { "description": "Resource 'UsagePlan' update operation succeeded", "schema": { "$ref": "#/definitions/UsagePlan" } }, "201": { "description": "Resource 'UsagePlan' create operation succeeded", "schema": { "$ref": "#/definitions/UsagePlan" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "UsagePlans_CreateOrUpdate_MaximumSet": { "$ref": "./examples/UsagePlans_CreateOrUpdate_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "UsagePlans_Update", "tags": [ "UsagePlans" ], "description": "Update a UsagePlan", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "usagePlanName", "in": "path", "description": "The name of the usage plan.", "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/UsagePlanTagsUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/UsagePlan" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "UsagePlans_Update_MaximumSet": { "$ref": "./examples/UsagePlans_Update_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "UsagePlans_Delete", "tags": [ "UsagePlans" ], "description": "Delete a UsagePlan", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "usagePlanName", "in": "path", "description": "The name of the usage plan.", "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" } } }, "x-ms-examples": { "UsagePlans_Delete_MaximumSet": { "$ref": "./examples/UsagePlans_Delete_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureResilienceManagement/usagePlans/{usagePlanName}/enrollments": { "get": { "operationId": "Enrollments_List", "tags": [ "Enrollments" ], "description": "List Enrollments by Usage Plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "usagePlanName", "in": "path", "description": "The name of the usage plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EnrollmentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Enrollments_List_MaximumSet": { "$ref": "./examples/Enrollments_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureResilienceManagement/usagePlans/{usagePlanName}/enrollments/{enrollmentName}": { "get": { "operationId": "Enrollments_Get", "tags": [ "Enrollments" ], "description": "Get an Enrollment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "usagePlanName", "in": "path", "description": "The name of the usage plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "enrollmentName", "in": "path", "description": "The name of the enrollment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Enrollment" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Enrollments_Get_MaximumSet": { "$ref": "./examples/Enrollments_Get_MaximumSet_Gen.json" } } }, "put": { "operationId": "Enrollments_CreateOrUpdate", "tags": [ "Enrollments" ], "description": "Create or update an Enrollment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "usagePlanName", "in": "path", "description": "The name of the usage plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "enrollmentName", "in": "path", "description": "The name of the enrollment.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Enrollment" } } ], "responses": { "200": { "description": "Resource 'Enrollment' update operation succeeded", "schema": { "$ref": "#/definitions/Enrollment" } }, "201": { "description": "Resource 'Enrollment' create operation succeeded", "schema": { "$ref": "#/definitions/Enrollment" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Enrollments_CreateOrUpdate_MaximumSet": { "$ref": "./examples/Enrollments_CreateOrUpdate_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Enrollments_Delete", "tags": [ "Enrollments" ], "description": "Delete an Enrollment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "usagePlanName", "in": "path", "description": "The name of the usage plan.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "enrollmentName", "in": "path", "description": "The name of the enrollment.", "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" } } }, "x-ms-examples": { "Enrollments_Delete_MaximumSet": { "$ref": "./examples/Enrollments_Delete_MaximumSet_Gen.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "ActionTask": { "type": "string", "description": "An action task type indicates the type of action task.", "enum": [ "None", "PreActionTask", "PostActionTask" ], "x-ms-enum": { "name": "ActionTask", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "No action task." }, { "name": "PreActionTask", "value": "PreActionTask", "description": "Pre-action task." }, { "name": "PostActionTask", "value": "PostActionTask", "description": "Post-action task." } ] } }, "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" ] }, "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" ] }, "AssetPropertiesOfDrill": { "type": "object", "description": "Drill asset properties.", "properties": { "subscription": { "type": "string", "description": "Subscription where Drill's internal resources will be created." }, "region": { "type": "string", "description": "Region where Drill's internal resources will be created." }, "resourceGroup": { "type": "string", "description": "Resource group where Drill's internal resources will be created. If not specified, defaults to 'AzureResilienceManagementDrills'. This value is immutable after drill creation.", "minLength": 1, "maxLength": 90, "pattern": "^[-\\w\\._\\(\\)]+$", "x-ms-mutability": [ "read", "create" ] } }, "required": [ "subscription", "region" ] }, "AssetPropertiesOfDrillUpdate": { "type": "object", "description": "Drill asset properties.", "properties": { "subscription": { "type": "string", "description": "Subscription where Drill's internal resources will be created." }, "region": { "type": "string", "description": "Region where Drill's internal resources will be created." } } }, "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": { "drillRbacOnChaosResource": { "$ref": "#/definitions/RBACState", "description": "Drill object does not have the necessary RBAC to run the chaos resource." }, "rbacNeededForDrillOnChaosResource": { "type": "array", "description": "Permissions needed by the Drill MSI to run the chaos resource.", "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" } }, "roReadiness": { "$ref": "#/definitions/RecoveryPlanState", "description": "Associated RO ready or not." }, "rbacOnTargetResources": { "$ref": "#/definitions/RBACState", "description": "RBAC required by Chaos Resource 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." }, "chaosResource": { "$ref": "#/definitions/ExtensionObjectState", "description": "Chaos resource for faulting exists or not." }, "chaosResourceCreationFailureReasons": { "type": "array", "description": "Reason for Chaos Resource Creation failure", "items": { "type": "string" } }, "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." }, "chaosResourceUserMsi": { "$ref": "#/definitions/ExtensionObjectState", "description": "User MSI associated with chaos resource object is deleted." }, "includedResourceInDrill": { "$ref": "#/definitions/ExtensionObjectState", "description": "Included resource in Drill." }, "drillRbacOnMonitoringResources": { "$ref": "#/definitions/RBACState", "description": "Drill MSI does not have the necessary RBAC to read the Drill Monitoring resources." }, "drillMonitoringErrors": { "type": "array", "description": "Errors related to Drill Monitoring resources.", "items": { "$ref": "#/definitions/ErrorDetails" }, "x-ms-identifiers": [] }, "drillMonitoringResources": { "$ref": "#/definitions/ExtensionObjectState", "description": "Monitoring Resources created for Drill", "readOnly": true }, "monitoringRbacOnDrillResources": { "$ref": "#/definitions/RBACState", "description": "Monitoring RBAC required by Drill MSI not setup on the target resources." }, "rbacNeededForDrillOnDrillMonitoringResources": { "type": "array", "description": "Permissions needed by the Drill MSI to Upload service group health data for monitoring.", "items": { "type": "string" } }, "rbacNeededForDrillOnDrillResources": { "type": "array", "description": "Permissions needed by the Drill MSI to read health metrics data for resources in service group.", "items": { "type": "string" } }, "missingRequiredResourceProviders": { "type": "array", "description": "List of required required Azure resource providers that are not registered in the subscription specified for chaos resource.", "items": { "type": "string" } }, "monitoringSourceNotConfigured": { "type": "boolean", "description": "Neither an Azure Health Model nor an SLI is configured for the Drill. Execution is blocked until a monitoring source is configured." }, "healthModelExists": { "$ref": "#/definitions/ExtensionObjectState", "description": "Whether the selected Azure Health Model still exists." }, "discoveryRuleExists": { "$ref": "#/definitions/ExtensionObjectState", "description": "Whether the selected discovery rule still exists." }, "drillRbacOnHealthModel": { "$ref": "#/definitions/RBACState", "description": "Whether the Drill identity has the necessary RBAC (Reader) to read the selected Azure Health Model." }, "rbacNeededForDrillOnHealthModel": { "type": "array", "description": "Permissions needed by the Drill identity to read the selected Azure Health Model.", "items": { "type": "string" } }, "drillRbacOnSli": { "$ref": "#/definitions/RBACState", "description": "Rolled-up RBAC state: NotSet if the Drill identity is missing the necessary RBAC to read any selected SLI." }, "sliAttentionStatuses": { "type": "array", "description": "Per-SLI attention status for each SLI selected for Drill monitoring.", "items": { "$ref": "#/definitions/SliAttentionStatus" }, "x-ms-identifiers": [] }, "drillRbacOnGoalAssignment": { "$ref": "#/definitions/RBACState", "description": "Drill object does not have the necessary RBAC on Goal Assignment." }, "rbacNeededForDrillOnGoalAssignment": { "type": "array", "description": "Permissions needed by the Drill MSI on Goal Assignment.", "items": { "type": "string" } }, "goalAssignment": { "$ref": "#/definitions/ExtensionObjectState", "description": "Goal Assignment not present." }, "recoveryPlan": { "$ref": "#/definitions/ExtensionObjectState", "description": "Recovery plan not present." }, "healthModelAssociatedWithServiceGroup": { "$ref": "#/definitions/ExtensionObjectState", "description": "Indicates whether any entity in the selected Azure Health Model references the Drill Service Group through properties.signalGroups.azureResource.azureResourceId.", "readOnly": true } } }, "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": [] } } }, "ChaosResourcePropertiesOfDrill": { "type": "object", "description": "Chaos Resource properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity to use for Chaos Resource operations." }, "chaosResourceIdentityForFaults": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity to be used by the Chaos Resource for invoking faults on resources." }, "chaosResourceId": { "type": "string", "format": "arm-id", "description": "Chaos Resource created for this Drill", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Chaos/workspaces" } ] } }, "faultDurationInMin": { "type": "integer", "format": "int32", "description": "Duration of faults.", "minimum": 0, "readOnly": true } }, "required": [ "identity", "chaosResourceIdentityForFaults" ] }, "ChaosResourcePropertiesOfDrillUpdate": { "type": "object", "description": "Chaos Resource properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity to use for Chaos Resource operations." }, "chaosResourceIdentityForFaults": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity to be used by the Chaos Resource for invoking faults on resources." } } }, "CommentType": { "type": "string", "description": "The type of user comment.", "enum": [ "Description", "ResumeReason" ], "x-ms-enum": { "name": "CommentType", "modelAsString": true, "values": [ { "name": "Description", "value": "Description", "description": "A general description comment." }, { "name": "ResumeReason", "value": "ResumeReason", "description": "A comment indicating the reason for resuming a job." } ] } }, "ConfirmationStatus": { "type": "string", "description": "Enum for the confirmation status of a high availability solution.", "enum": [ "ApprovedByUser", "ApprovalPending", "ApprovalNotNeeded", "RejectedByUser" ], "x-ms-enum": { "name": "ConfirmationStatus", "modelAsString": true, "values": [ { "name": "ApprovedByUser", "value": "ApprovedByUser", "description": "The high availability solution has been approved by the user." }, { "name": "ApprovalPending", "value": "ApprovalPending", "description": "The high availability solution is pending approval from the user." }, { "name": "ApprovalNotNeeded", "value": "ApprovalNotNeeded", "description": "The high availability solution does not require user approval." }, { "name": "RejectedByUser", "value": "RejectedByUser", "description": "The high availability solution has been rejected by the user." } ] } }, "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" ], "x-ms-enum": { "name": "DrillMode", "modelAsString": true, "values": [ { "name": "Failover", "value": "Failover", "description": "Failover mode." } ] } }, "DrillPatchProperties": { "type": "object", "description": "PATCH properties for Drill.", "properties": { "recoveryPlanProperties": { "$ref": "#/definitions/RecoveryPlanPropertiesOfDrill", "description": "Recovery Plan properties." }, "goalAssignmentProperties": { "$ref": "#/definitions/GoalAssignmentPropertiesOfDrill", "description": "Goal Assignment properties." }, "drillAssetProperties": { "$ref": "#/definitions/AssetPropertiesOfDrill", "description": "Properties for internal resources that are created for the Drill." }, "chaosResourceProperties": { "$ref": "#/definitions/ChaosResourcePropertiesOfDrill", "description": "Chaos Resource properties." }, "rbacSetupMode": { "$ref": "#/definitions/RBACSetupMode", "description": "RBAC setup mode." }, "monitoringProperties": { "$ref": "#/definitions/MonitoringPropertiesOfDrill", "description": "Monitoring properties of the Drill." }, "healthModelMonitoringProperties": { "$ref": "#/definitions/HealthModelMonitoringProperties", "description": "Azure Health Model monitoring properties of the Drill. Send null to clear the selection.", "x-nullable": true }, "sliMonitoringProperties": { "$ref": "#/definitions/SliMonitoringProperties", "description": "SLI monitoring properties of the Drill. Send null to clear the selection; the submitted slis array is the new desired state.", "x-nullable": true } } }, "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" } ] } }, "recoveryPlanProperties": { "$ref": "#/definitions/RecoveryPlanPropertiesOfDrill", "description": "ROPlan properties." }, "goalAssignmentProperties": { "$ref": "#/definitions/GoalAssignmentPropertiesOfDrill", "description": "Goal Assignment properties." }, "drillAssetProperties": { "$ref": "#/definitions/AssetPropertiesOfDrill", "description": "Properties for internal resources that are created for the Drill." }, "chaosResourceProperties": { "$ref": "#/definitions/ChaosResourcePropertiesOfDrill", "description": "Chaos Resource 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 }, "lastResyncReadinessCheckTime": { "type": "string", "format": "date-time", "description": "Last resync and readiness check time.", "readOnly": true }, "drillType": { "$ref": "#/definitions/DrillType", "description": "The discriminator for the Drill object hierarchy.", "x-ms-mutability": [ "read", "create" ] }, "monitoringProperties": { "$ref": "#/definitions/MonitoringPropertiesOfDrill", "description": "Monitoring properties of the Drill." }, "healthModelMonitoringProperties": { "$ref": "#/definitions/HealthModelMonitoringProperties", "description": "Azure Health Model monitoring properties of the Drill." }, "sliMonitoringProperties": { "$ref": "#/definitions/SliMonitoringProperties", "description": "SLI monitoring properties of the Drill." }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "Error details associated with the resource.", "readOnly": true } }, "discriminator": "drillType", "required": [ "drillType" ] }, "DrillReportFinalizationState": { "type": "string", "description": "Finalization state of a Drill Run report.", "enum": [ "NotFinalized", "Finalized" ], "x-ms-enum": { "name": "DrillReportFinalizationState", "modelAsString": true, "values": [ { "name": "NotFinalized", "value": "NotFinalized", "description": "The report is not finalized and may still change." }, { "name": "Finalized", "value": "Finalized", "description": "The report is finalized and immutable." } ] } }, "DrillReportFormat": { "type": "string", "description": "Format of a Drill Run report.", "enum": [ "Html" ], "x-ms-enum": { "name": "DrillReportFormat", "modelAsString": true, "values": [ { "name": "Html", "value": "Html", "description": "Human readable HTML report." } ] } }, "DrillReportGenerationStatus": { "type": "string", "description": "Report generation status.", "enum": [ "NotStarted", "InProgress", "Succeeded", "Failed" ], "x-ms-enum": { "name": "DrillReportGenerationStatus", "modelAsString": true, "values": [ { "name": "NotStarted", "value": "NotStarted", "description": "Report generation has not been attempted yet." }, { "name": "InProgress", "value": "InProgress", "description": "Report generation is currently running." }, { "name": "Succeeded", "value": "Succeeded", "description": "Report generation completed successfully." }, { "name": "Failed", "value": "Failed", "description": "Report generation failed. Details are captured in the lastError field." } ] }, "readOnly": true }, "DrillReportSummary": { "type": "object", "description": "Public, read-only summary of report generation for a Drill Run. Exposes status and pointers only - the report content and internal storage locations are never surfaced.", "properties": { "generationStatus": { "$ref": "#/definitions/DrillReportGenerationStatus", "description": "Overall report generation status for the Drill Run.", "readOnly": true }, "stageStatuses": { "type": "array", "description": "Per-stage report generation statuses.", "items": { "$ref": "#/definitions/ReportStageStatus" }, "readOnly": true, "x-ms-identifiers": [] }, "availableFormats": { "type": "array", "description": "Formats the report is currently available for download in.", "items": { "$ref": "#/definitions/DrillReportFormat" }, "readOnly": true }, "lastGeneratedTimestamp": { "type": "string", "format": "date-time", "description": "Timestamp of the last successful report generation.", "readOnly": true }, "schemaVersion": { "type": "string", "description": "Schema version of the generated report content.", "readOnly": true }, "finalizationState": { "$ref": "#/definitions/DrillReportFinalizationState", "description": "Finalization state of the report. A finalized report is immutable.", "readOnly": true }, "lastError": { "$ref": "#/definitions/ErrorDetails", "description": "Error from the last failed report generation attempt.", "readOnly": true } } }, "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": { "faultRbacOnTargetResource": { "$ref": "#/definitions/RBACState", "description": "Chaos Resource 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." }, "monitoringRbacOnTargets": { "$ref": "#/definitions/RBACState", "description": "RBAC required by Drill MSI on the target resource for monitoring." }, "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" ] }, "DrillResourceNonQualificationReasons": { "type": "string", "description": "A state type that indicates qualification of a resource for an operation.", "enum": [ "ResourceNotIncludedInRecoveryPlan", "ResourceNotIncludedInDrill", "ResourceLocationNotMatchingWithSourceLocation", "ResourceZoneNotMatchingWithSourceZone" ], "x-ms-enum": { "name": "DrillResourceNonQualificationReasons", "modelAsString": true, "values": [ { "name": "ResourceNotIncludedInRecoveryPlan", "value": "ResourceNotIncludedInRecoveryPlan", "description": "Resource is not included in the recovery plan." }, { "name": "ResourceNotIncludedInDrill", "value": "ResourceNotIncludedInDrill", "description": "Resource is not included in the drill." }, { "name": "ResourceLocationNotMatchingWithSourceLocation", "value": "ResourceLocationNotMatchingWithSourceLocation", "description": "Resource location does not match the source location." }, { "name": "ResourceZoneNotMatchingWithSourceZone", "value": "ResourceZoneNotMatchingWithSourceZone", "description": "Resource zone does not match the source zone." } ] } }, "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." }, "activeLocations": { "type": "array", "description": "Active location and zones of the Azure resource.", "items": { "type": "string" }, "readOnly": true }, "recoveryLocations": { "type": "array", "description": "List of recovery locations and zones of the Azure resource.", "items": { "type": "string" }, "readOnly": true }, "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 }, "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 }, "rbacAssignmentError": { "$ref": "#/definitions/ErrorDetails", "description": "Last RBAC assignment error, if any.", "readOnly": true }, "monitoringRbacAssignmentError": { "$ref": "#/definitions/ErrorDetails", "description": "Monitoring RBAC assignment error, if any.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state", "readOnly": true }, "drillType": { "$ref": "#/definitions/DrillType", "description": "The discriminator for the Drill Resource object hierarchy. Matches the parent Drill type.", "readOnly": true } }, "discriminator": "drillType", "required": [ "resourceId", "resourceType", "drillType" ] }, "DrillResourceQualification": { "type": "object", "description": "Details of qualified resources for validateForExecution operation.", "properties": { "drillsQualifiedResource": { "$ref": "#/definitions/DrillsQualifiedResource", "description": "Drill resource.", "readOnly": true }, "resourceQualificationDetails": { "$ref": "#/definitions/ResourceQualificationDetails", "description": "Details of qualification for the operation.", "readOnly": true } }, "required": [ "drillsQualifiedResource", "resourceQualificationDetails" ] }, "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 } } }, "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" } ] } }, "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 }, "report": { "$ref": "#/definitions/DrillReportSummary", "description": "Summary of report generation for this Drill Run.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/JobProperties" } ], "x-ms-discriminator-value": "DrillRun" }, "DrillRunReprotectRequest": { "type": "object", "description": "Request body for Reprotect API.", "properties": { "reprotectProperties": { "$ref": "#/definitions/ReprotectRequest", "description": "The reprotect properties." } }, "required": [ "reprotectProperties" ] }, "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", "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": "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", "Reprotect", "FailoverReverse", "ReprotectReverse" ], "x-ms-enum": { "name": "DrillRunTasks", "modelAsString": true, "values": [ { "name": "Failover", "value": "Failover", "description": "Failover task." }, { "name": "Reprotect", "value": "Reprotect", "description": "Reprotect task." }, { "name": "FailoverReverse", "value": "FailoverReverse", "description": "FailoverReverse task." }, { "name": "ReprotectReverse", "value": "ReprotectReverse", "description": "ReprotectReverse task." } ] } }, "DrillStartRequest": { "type": "object", "description": "Request body of the Start Action of Drill.", "properties": { "mode": { "$ref": "#/definitions/DrillMode", "description": "Mode of starting the Drill" } }, "required": [ "mode" ] }, "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": { "recoveryPlanProperties": { "$ref": "#/definitions/RecoveryPlanPropertiesOfDrillUpdate", "description": "Recovery Plan properties." }, "goalAssignmentProperties": { "$ref": "#/definitions/GoalAssignmentPropertiesOfDrillUpdate", "description": "Goal Assignment properties." }, "drillAssetProperties": { "$ref": "#/definitions/AssetPropertiesOfDrillUpdate", "description": "Properties for internal resources that are created for the Drill." }, "chaosResourceProperties": { "$ref": "#/definitions/ChaosResourcePropertiesOfDrillUpdate", "description": "Chaos Resource properties." }, "rbacSetupMode": { "$ref": "#/definitions/RBACSetupMode", "description": "RBAC setup mode." }, "monitoringProperties": { "$ref": "#/definitions/MonitoringPropertiesOfDrillUpdate", "description": "Monitoring properties of the Drill." }, "healthModelMonitoringProperties": { "$ref": "#/definitions/HealthModelMonitoringPropertiesUpdate", "description": "Azure Health Model monitoring properties of the Drill. Send null to clear the selection.", "x-nullable": true }, "sliMonitoringProperties": { "$ref": "#/definitions/SliMonitoringPropertiesUpdate", "description": "SLI monitoring properties of the Drill. Send null to clear the selection; the submitted slis array is the new desired state.", "x-nullable": true } } }, "DrillsQualifiedResource": { "type": "object", "description": "Qualified resource.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "ARM Resource ID of the Azure resource.", "readOnly": true }, "drillResourceId": { "type": "string", "format": "arm-id", "description": "Drill Resource ID of the Azure resource.", "readOnly": true }, "activeLocations": { "type": "array", "description": "Active Resource location and zones of Azure Resource.", "items": { "type": "string" }, "readOnly": true }, "recoveryLocations": { "type": "array", "description": "Recovery Resource location and zones of HA Azure Resource.", "items": { "type": "string" }, "readOnly": true }, "activePhysicalZones": { "type": "array", "description": "Active Resource location and physical zones of Azure Resource.", "items": { "type": "string" }, "readOnly": true }, "recoveryPhysicalZones": { "type": "array", "description": "Recovery Resource location and physical zones of HA Azure Resource.", "items": { "type": "string" }, "readOnly": true }, "drillInclusionState": { "$ref": "#/definitions/DrillResourceInclusionState", "description": "Inclusion State of the Drill resource in Drill", "readOnly": true }, "recoveryInclusionState": { "$ref": "#/definitions/ResourceInclusionState", "description": "A state that indicates the resource status with respect to the recovery orchestration plan.", "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 }, "selectedProtectionSolutionType": { "$ref": "#/definitions/ResourceProtectionSolutionType", "description": "A setting that indicates the protection solution selected.", "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": [] }, "selectedProtectionSolutionSetting": { "$ref": "#/definitions/ResourceBaseProtectionSolutionSetting", "description": "Resource protection solution settings of the protection solutions recovery orchestration resource is protected with.", "readOnly": true }, "faultState": { "$ref": "#/definitions/DrillResourceFaultState", "description": "Fault State of the Drill resource", "readOnly": true }, "faultProperties": { "$ref": "#/definitions/FaultProperties", "description": "Fault Properties", "readOnly": true }, "resourceProtectionSolutionDisplayName": { "type": "string", "description": "Resource Protection Solution Display Name", "readOnly": true } }, "required": [ "resourceId" ] }, "Enrollment": { "type": "object", "description": "An enrollment that links a usage plan to a service group.", "properties": { "properties": { "$ref": "#/definitions/EnrollmentProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "EnrollmentListResult": { "type": "object", "description": "The response of a Enrollment list operation.", "properties": { "value": { "type": "array", "description": "The Enrollment items on this page", "items": { "$ref": "#/definitions/Enrollment" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "EnrollmentProperties": { "type": "object", "description": "Definition of enrollment properties.", "properties": { "serviceGroupId": { "type": "string", "format": "arm-id", "description": "ARM resource identifier of the service group associated with this usage plan.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Management/serviceGroups" } ] } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the enrollment.", "readOnly": true }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "Details of any errors encountered during Enrollment create or update.", "readOnly": true } }, "required": [ "serviceGroupId" ] }, "ErrorDetails": { "type": "object", "description": "Errors in T&C / RBAC assignment.", "properties": { "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." }, "recommendations": { "type": "array", "description": "A list of recommendations to resolve the error.", "items": { "type": "string" } } }, "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." } ] } }, "ExecutionConfigurations": { "type": "object", "description": "Execution configurations for recovery action.", "properties": { "userConsent": { "$ref": "#/definitions/UserConsent", "description": "User consent for performing recovery action." } }, "required": [ "userConsent" ] }, "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": [] } }, "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" } }, "selectedResourceIds": { "type": "array", "description": "Selected recovery resource Ids to be processed. If not provided, all qualified resources based on the source location(s) will be processed.", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource." } }, "executionConfigurations": { "$ref": "#/definitions/ExecutionConfigurations", "description": "Execution configurations for the recovery action." } }, "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." } }, "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": { "requireZonalResiliency": { "type": "boolean", "description": "Whether zonal resiliency is required for this 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": [ "requireZonalResiliency" ] }, "GoalAssignmentPropertiesOfDrill": { "type": "object", "description": "Goal assignment properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity to use for goal assignment operations." }, "goalAssignmentId": { "type": "string", "format": "arm-id", "description": "Goal assignment id.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.AzureResilienceManagement/goalAssignments" } ] } } }, "required": [ "identity" ] }, "GoalAssignmentPropertiesOfDrillUpdate": { "type": "object", "description": "Goal assignment properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity to use for goal assignment operations." } } }, "GoalAssignmentPropertiesUpdate": { "type": "object", "description": "Properties of a goal assignment.", "properties": { "requireZonalResiliency": { "type": "boolean", "description": "Whether zonal resiliency is required for this goal assignment." }, "serviceLevelResources": { "type": "array", "description": "List of service level resources.", "items": { "$ref": "#/definitions/ServiceLevelResource" }, "x-ms-identifiers": [] } } }, "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." } }, "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." }, "zonalResiliency": { "$ref": "#/definitions/ResiliencyProperties", "description": "The zonal resiliency posture for the ARM resource, including participation, attestation, exclusion reason, and user confirmations." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the goal resource.", "readOnly": true } }, "required": [ "resourceArmId" ] }, "GoalsData": { "type": "object", "description": "Definition of goals data in unified resilience item.", "properties": { "assignmentId": { "type": "string", "format": "arm-id", "description": "Arm id of the goal assignment." }, "zonalResiliency": { "$ref": "#/definitions/UnifiedResilienceItemGoalRequirement", "description": "Zonal resiliency goal copied from the goal assignment." } }, "required": [ "assignmentId" ] }, "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." } ] } }, "HealthModelMonitoringProperties": { "type": "object", "description": "Azure Health Model monitoring properties of a Drill. Exactly one Health Model may be selected per Drill.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity that the Drill uses to read the Azure Health Model. The Drill is granted Reader on the Health Model for this identity." }, "healthModelId": { "type": "string", "format": "arm-id", "description": "Full ARM Id of the Azure Health Model selected for Drill monitoring.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.CloudHealth/healthmodels" } ] } } }, "required": [ "identity", "healthModelId" ] }, "HealthModelMonitoringPropertiesUpdate": { "type": "object", "description": "Azure Health Model monitoring properties of a Drill. Exactly one Health Model may be selected per Drill.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity that the Drill uses to read the Azure Health Model. The Drill is granted Reader on the Health Model for this identity." }, "healthModelId": { "type": "string", "format": "arm-id", "description": "Full ARM Id of the Azure Health Model selected for Drill monitoring.", "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 }, "executionConfigurations": { "$ref": "#/definitions/ExecutionConfigurations", "description": "Execution configurations for the 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", "DrillRun" ], "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": "DrillRun", "value": "DrillRun", "description": "Drill Run job resource." } ] } }, "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." }, "userComments": { "type": "array", "description": "User Comments.", "items": { "$ref": "#/definitions/JobUserComment" }, "readOnly": true, "x-ms-identifiers": [] } }, "required": [ "retryAttempt" ] }, "JobStatus": { "type": "string", "description": "Job Statuses", "enum": [ "NotApplicable", "NotStarted", "Pending", "InProgress", "Completed", "CompletedWithWarnings", "Failed", "Skipped", "Cancelling", "Cancelled", "Paused" ], "x-ms-enum": { "name": "JobStatus", "modelAsString": true, "values": [ { "name": "NotApplicable", "value": "NotApplicable", "description": "The job status is not applicable." }, { "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": [] }, "retryDetails": { "type": "array", "description": "Retry details of the task.", "items": { "$ref": "#/definitions/JobRetryDetails" }, "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", "DrillRun" ], "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": "DrillRun", "value": "DrillRun", "description": "Drill Oober job which represents a given instance of Drill." } ] } }, "JobUserComment": { "type": "object", "description": "Job User's Comment.", "properties": { "commentType": { "$ref": "#/definitions/CommentType", "description": "The type of the user comment.", "readOnly": true }, "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 } } }, "ListReportDownloadUrlRequest": { "type": "object", "description": "Request to mint a short-lived, read-only download URL for a Drill Run report.", "properties": { "format": { "$ref": "#/definitions/DrillReportFormat", "description": "Format of the report to download. Defaults to Html when not specified." } } }, "ListReportDownloadUrlResponse": { "type": "object", "description": "Response containing a short-lived, read-only download URL for a Drill Run report.", "properties": { "format": { "$ref": "#/definitions/DrillReportFormat", "description": "Format of the report the download URL refers to.", "readOnly": true }, "downloadUrl": { "type": "string", "format": "password", "description": "Short-lived, read-only URL to download the report.", "readOnly": true, "x-ms-secret": true }, "expiryTimestamp": { "type": "string", "format": "date-time", "description": "Timestamp at which the download URL expires.", "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": [] } } }, "MonitoringPropertiesOfDrill": { "type": "object", "description": "Drill monitoring properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity to use for Drill monitoring operations." }, "logAnalyticsWorkspaceId": { "type": "string", "format": "arm-id", "description": "Full ARM Id of the Log analytics workspace created by Resiliency service where health data is collected.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.OperationalInsights/workspaces" } ] } }, "rawMetricsDataCollectionRuleId": { "type": "string", "format": "arm-id", "description": "Full ARM Id of the Data collection rule created by Resiliency service which will route data for RAW health data for service group resources.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Insights/datacollectionrules" } ] } }, "serviceGroupMetricsDataCollectionRuleId": { "type": "string", "format": "arm-id", "description": "Full ARM Id of the Data collection rule created by Resiliency service which will route data for Aggregate health data of service group.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Insights/datacollectionrules" } ] } }, "dataCollectionEndpointId": { "type": "string", "format": "arm-id", "description": "Full ARM Id of the Data collection endpoint created by Resiliency service which will route data for service group and its resources.", "readOnly": true, "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Insights/dataCollectionEndpoints" } ] } } } }, "MonitoringPropertiesOfDrillUpdate": { "type": "object", "description": "Drill monitoring properties.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity to use for Drill monitoring operations." } } }, "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" } }, "resourceFeasibilityReviews": { "type": "array", "description": "Advisory resource feasibility reviews. Absent when no review was evaluated for this resource.", "maxItems": 10, "items": { "$ref": "#/definitions/ResourceFeasibilityReview" }, "x-ms-identifiers": [ "feasibilityType", "resourceType" ] } }, "required": [ "qualificationState" ] }, "ProvisioningState": { "type": "string", "description": "The status of the current operation.", "enum": [ "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", "NeedsAttention" ], "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" }, { "name": "NeedsAttention", "value": "NeedsAttention", "description": "The resource needs attention from the user." } ] }, "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." } ] } }, "ReasonForRequestingConfirmation": { "type": "string", "description": "Enum for the reason for requesting user confirmation for a high availability solution.", "enum": [ "ZonePinnedZrsDataDisksConditional", "VmInMultiZoneScaleSetStatelessOnly" ], "x-ms-enum": { "name": "ReasonForRequestingConfirmation", "modelAsString": true, "values": [ { "name": "ZonePinnedZrsDataDisksConditional", "value": "ZonePinnedZrsDataDisksConditional", "description": "Zone pinned ZRS data disks conditional." }, { "name": "VmInMultiZoneScaleSetStatelessOnly", "value": "VmInMultiZoneScaleSetStatelessOnly", "description": "VM in multi-zone scale set stateless only." } ] } }, "RecommendCapacityRequest": { "type": "object", "description": "Request body for the recommend capacity action. Provide specific resource IDs to evaluate, or pass an empty array to let the service automatically select non-resilient resources from the goal assignment.", "properties": { "resourceIds": { "type": "array", "description": "Azure resource IDs to evaluate for resiliency. Pass an empty array to automatically discover and evaluate non-resilient resources in the service group. Maximum 50 resources per request.", "maxItems": 50, "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource." } } }, "required": [ "resourceIds" ] }, "RecommendCapacityResourceResult": { "type": "object", "description": "Resiliency assessment for a single Azure resource, including eligibility category, actionable guidance, and alternate configurations.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "Fully qualified ARM resource ID of the evaluated resource." }, "resourceType": { "type": "string", "description": "ARM resource type (e.g., 'Microsoft.Compute/virtualMachines', 'Microsoft.Storage/storageAccounts')." }, "skuName": { "type": "string", "description": "Current SKU or pricing tier of the resource (e.g., 'Standard_D4s_v3', 'Standard_LRS')." }, "location": { "type": "string", "description": "Azure region where the resource is deployed (e.g., 'eastus', 'westeurope')." }, "capacityAssessment": { "type": "string", "description": "Human-readable assessment of this resource's resiliency posture. Contains actionable recommendations when available, or null when the AI advisor is unavailable." }, "error": { "type": "string", "description": "Error message if the resource could not be evaluated (e.g., resource not found or access denied). Other fields may be empty when this is set." }, "category": { "$ref": "#/definitions/ResiliencyEligibilityCategory", "description": "Resiliency eligibility classification for this resource. See ResiliencyEligibilityCategory for possible values." }, "suggestedRegions": { "type": "array", "description": "Alternative Azure regions that support resiliency for this resource type. Populated when the current region does not support the required redundancy.", "items": { "type": "string" } }, "suggestedSkus": { "type": "array", "description": "Alternative SKUs that support redundancy for this resource type in the current region. Populated when the current SKU is not eligible for resiliency.", "items": { "type": "string" } }, "steps": { "type": "array", "description": "Ordered list of actions to enable or improve resiliency for this resource.", "items": { "type": "string" } }, "links": { "type": "array", "description": "Links to relevant Azure documentation for configuring resiliency.", "items": { "type": "string" } } }, "required": [ "resourceId" ] }, "RecommendCapacityResult": { "type": "object", "description": "Result of a completed recommend capacity operation, containing per-resource assessments and cross-cutting recommendations.", "properties": { "resourceCapacities": { "type": "array", "description": "Individual resiliency assessment for each evaluated resource.", "items": { "$ref": "#/definitions/RecommendCapacityResourceResult" }, "x-ms-identifiers": [ "resourceId" ] }, "recommendations": { "type": "array", "description": "High-level recommendations that apply across multiple resources (e.g., regional migration patterns, common SKU upgrades).", "items": { "type": "string" } }, "agentError": { "type": "string", "description": "Error message from the AI advisor, if the advisory enrichment failed. The deterministic assessment results are still available even when this field is set." } }, "required": [ "resourceCapacities", "recommendations" ] }, "RecoveryActionRequest": { "type": "object", "description": "Request body for providing user input for a recovery action.", "properties": { "description": { "type": "string", "description": "User-provided input for the action.", "maxLength": 100 } } }, "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" } ] }, "RecoveryGroupActionSettings": { "type": "object", "description": "Settings for a recovery group action.", "properties": { "actionTask": { "$ref": "#/definitions/ActionTask", "description": "The action task associated with this job resource.", "readOnly": true }, "actionSequence": { "type": "integer", "format": "int32", "description": "Sequence number for the action.", "readOnly": true }, "recoveryGroupActionType": { "$ref": "#/definitions/RecoveryGroupActionType", "description": "Type of the recovery group action.", "readOnly": true }, "actionName": { "type": "string", "description": "Name of the action.", "readOnly": true }, "actionDescription": { "type": "string", "description": "User description of the action.", "readOnly": true } } }, "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 }, "recoveryGroupActionSettings": { "$ref": "#/definitions/RecoveryGroupActionSettings", "description": "The recovery action settings.", "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 }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "Error details associated with the resource.", "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 }, "resourcePhysicalZones": { "type": "array", "description": "Physical zones of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.", "items": { "type": "string" }, "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" }, "RegionalDrillResourceProperties": { "type": "object", "description": "Properties of a resource in a regional Resiliency Drill.", "allOf": [ { "$ref": "#/definitions/DrillResourceProperties" } ], "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." } ] } }, "ReportStageStatus": { "type": "object", "description": "Report generation status for a single Drill Run stage.", "properties": { "drillRunStage": { "$ref": "#/definitions/DrillRunSubtasks", "description": "Name of the Drill Run stage this status applies to." }, "generationStatus": { "$ref": "#/definitions/DrillReportGenerationStatus", "description": "Report generation status for this stage.", "readOnly": true }, "lastAttemptTimestamp": { "type": "string", "format": "date-time", "description": "Timestamp of the last report generation attempt for this stage.", "readOnly": true }, "lastError": { "$ref": "#/definitions/ErrorDetails", "description": "Error from the last failed report generation attempt for this stage.", "readOnly": true } }, "required": [ "drillRunStage" ] }, "ReprotectRequest": { "type": "object", "description": "Reprotect post action request.", "properties": { "reprotectRequestProperties": { "$ref": "#/definitions/ReprotectRequestProperties", "description": "Additional properties for Reprotect." } } }, "ReprotectRequestProperties": { "type": "object", "description": "Additional properties for Reprotect.", "properties": { "selectedResourceIds": { "type": "array", "description": "Selected recovery resource Ids to be processed. If not provided, all qualified resources will be processed.", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource." } } } }, "ResiliencyEligibilityCategory": { "type": "string", "description": "Classification of a resource's resiliency eligibility. Determines what guidance and alternate configurations are returned.", "enum": [ "Unsupported", "ZrEligible", "SkuCapacityConstrained", "SkuIneligible", "RegionUnsupported" ], "x-ms-enum": { "name": "ResiliencyEligibilityCategory", "modelAsString": true, "values": [ { "name": "Unsupported", "value": "Unsupported", "description": "This resource type is not yet covered by the resiliency capability catalog." }, { "name": "ZrEligible", "value": "ZrEligible", "description": "The resource is eligible for resiliency in its current region and SKU. Review the steps field for enablement guidance." }, { "name": "SkuCapacityConstrained", "value": "SkuCapacityConstrained", "description": "The resource's SKU supports resiliency but available capacity is limited. Consider the suggested SKUs or regions for better availability." }, { "name": "SkuIneligible", "value": "SkuIneligible", "description": "The current SKU does not support resiliency in this region. Upgrade to one of the suggested SKUs to enable redundancy." }, { "name": "RegionUnsupported", "value": "RegionUnsupported", "description": "The resource's current region does not support resiliency for this resource type. Migrate to one of the suggested regions." } ] } }, "ResiliencyProperties": { "type": "object", "description": "Resiliency posture for a goal resource.", "properties": { "goalParticipation": { "$ref": "#/definitions/ExclusionState", "description": "Indicates whether the ARM resource is excluded from resiliency recommendations." }, "attestationStatus": { "$ref": "#/definitions/AttestationState", "description": "Indicates whether the ARM resource's resiliency posture is manually attested." }, "exclusionReason": { "$ref": "#/definitions/ExclusionReason", "description": "The reason the ARM resource is excluded from resiliency goals.", "readOnly": true }, "userConfirmation": { "type": "array", "description": "User confirmations for resiliency solutions recommended for the ARM resource.", "items": { "$ref": "#/definitions/UserConfirmationItem" }, "x-ms-identifiers": [ "solutionDisplayName" ] } } }, "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" ] }, "ResourceCrossZoneVmRecoveryProtectionSetting": { "type": "object", "description": "Definition of recovery orchestration resource protection with cross-zone (zonally resilient) VM recovery.", "properties": { "targetZone": { "type": "string", "description": "Customer-requested logical target availability zone for zonal failover (a positive availability-zone id, e.g. \"1\", \"2\", \"3\"; additional zones are accepted where the region exposes them). Always optional; when omitted the service selects a healthy zone. Immutable per failover." }, "capacityReservationGroupId": { "type": "string", "format": "arm-id", "description": "ARM resource ID of the Capacity Reservation Group (in the same subscription as the VM) to use when moving the VM to the target zone.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Compute/capacityReservationGroups" } ] } } }, "allOf": [ { "$ref": "#/definitions/ResourceBaseProtectionSolutionSetting" } ], "x-ms-discriminator-value": "CrossZoneVMRecovery" }, "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" }, "ResourceFeasibilityReview": { "type": "object", "description": "Result of a single feasibility review performed against one resource in a recovery plan.", "properties": { "feasibilityType": { "$ref": "#/definitions/ResourceFeasibilityReviewType", "description": "The resource feasibility review type." }, "resourceType": { "type": "string", "description": "Fully qualified ARM resource type evaluated, e.g. `Microsoft.Compute/virtualMachines`.", "pattern": "^[a-zA-Z0-9]+\\.[a-zA-Z0-9]+(/[a-zA-Z0-9]+)+$" }, "currentTargetSku": { "$ref": "#/definitions/SkuDetails", "description": "The SKU the resource is currently configured to recover into, enriched for comparison against the recommendations. Absent when it could not be resolved, and always absent on `Passed` and `NotApplicable` reviews." }, "status": { "$ref": "#/definitions/ResourceFeasibilityReviewStatus", "description": "Outcome of this feasibility review." }, "recommendedTargetSkus": { "type": "array", "description": "Alternative SKUs surfaced for this review. Absent or empty means a `Flagged` review has no alternatives, an `Unavailable` review has no applicable recommendations to surface, or the review has a minimal `Passed` / `NotApplicable` outcome. Callers should treat an absent array and an empty array identically.", "maxItems": 5, "items": { "$ref": "#/definitions/SkuDetails" }, "x-ms-identifiers": [ "sku" ] } }, "required": [ "feasibilityType", "resourceType", "status" ] }, "ResourceFeasibilityReviewStatus": { "type": "string", "description": "Outcome of a resource feasibility review for a recovery resource.", "enum": [ "Unavailable", "Passed", "Flagged", "NotApplicable" ], "x-ms-enum": { "name": "ResourceFeasibilityReviewStatus", "modelAsString": true, "values": [ { "name": "Unavailable", "value": "Unavailable", "description": "The review could not complete. Advisory only; it never blocks failover." }, { "name": "Passed", "value": "Passed", "description": "The review identified no risk." }, { "name": "Flagged", "value": "Flagged", "description": "The review identified a risk the operator should consider." }, { "name": "NotApplicable", "value": "NotApplicable", "description": "The review did not apply to this resource and was skipped." } ] } }, "ResourceFeasibilityReviewType": { "type": "string", "description": "The resource feasibility review category for a recovery resource.", "enum": [ "SkuCapacity" ], "x-ms-enum": { "name": "ResourceFeasibilityReviewType", "modelAsString": true, "values": [ { "name": "SkuCapacity", "value": "SkuCapacity", "description": "SKU capacity availability check in the target region or zone." } ] } }, "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 }, "activeLocations": { "type": "array", "description": "Active locations of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.", "items": { "type": "string" }, "readOnly": true }, "activePhysicalZones": { "type": "array", "description": "Active Resource location and physical zones of Azure Resource.", "items": { "type": "string" }, "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", "HighlyAvailable" ], "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." }, { "name": "HighlyAvailable", "value": "HighlyAvailable", "description": "A state indicating that the resource is protected by the highly available recovery solution." } ] } }, "ResourceQualificationDetails": { "type": "object", "description": "Details of qualification for an operation.", "properties": { "drillQualificationState": { "$ref": "#/definitions/QualificationState", "description": "Resource qualification state for the operation.", "readOnly": true }, "recoveryQualificationState": { "$ref": "#/definitions/QualificationState", "description": "Resource qualification state for the operation.", "readOnly": true }, "recoveryNotQualifiedReasons": { "type": "array", "description": "Reasons for resource not qualified for the recovery operation.", "items": { "type": "string" }, "readOnly": true }, "drillsNotQualifiedReasons": { "type": "array", "description": "Reasons for resource not qualified for the drills operation.", "items": { "$ref": "#/definitions/DrillResourceNonQualificationReasons" }, "readOnly": true } }, "required": [ "drillQualificationState", "recoveryQualificationState" ] }, "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" } ] } } } }, "ResourceTypeCategories": { "type": "string", "description": "A state type that indicates qualification of a resource for an operation.", "enum": [ "AzureSiteRecoveryVMsPresent" ], "x-ms-enum": { "name": "ResourceTypeCategories", "modelAsString": true, "values": [ { "name": "AzureSiteRecoveryVMsPresent", "value": "AzureSiteRecoveryVMsPresent", "description": "Indicates that at least one Azure Site Recovery VM is present." } ] } }, "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" ] }, "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." } }, "required": [ "serviceLevelIndicatorResourceId" ] }, "SkuDetails": { "type": "object", "description": "SKU details for a resource feasibility review, used for both the current target SKU and the recommended alternate SKUs.", "properties": { "sku": { "type": "string", "description": "The Azure SKU name." }, "vCpu": { "type": "integer", "format": "int32", "description": "Number of virtual CPUs for the SKU. Absent when SKU specifications are unavailable." }, "ram": { "type": "integer", "format": "int32", "description": "Memory in GiB for the SKU. Absent when SKU specifications are unavailable." }, "monthlyPrice": { "type": "number", "format": "double", "description": "Estimated monthly price. Absent when pricing is unavailable." }, "currency": { "type": "string", "description": "ISO 4217 currency code for `monthlyPrice`." }, "offeringId": { "type": "string", "description": "Identifier of the Azure offering used to estimate `monthlyPrice`." } }, "required": [ "sku" ] }, "SliAttentionStatus": { "type": "object", "description": "Per-SLI attention status of a Drill.", "properties": { "sliId": { "type": "string", "format": "arm-id", "description": "Full ARM Id of the SLI this status refers to.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Monitor/slis" } ] } }, "type": { "$ref": "#/definitions/SliType", "description": "User-declared category of the SLI." }, "exists": { "$ref": "#/definitions/ExtensionObjectState", "description": "Whether the selected SLI still exists.", "readOnly": true }, "typeMatch": { "$ref": "#/definitions/SliTypeMatchState", "description": "Whether the user-declared SLI type matches the SLI's actual category.", "readOnly": true }, "drillRbacOnDestinationAmw": { "$ref": "#/definitions/RBACState", "description": "Rolled-up RBAC state: NotSet if the Drill identity is missing Monitoring Reader on any of the SLI's destination Azure Monitor Workspaces.", "readOnly": true }, "rbacNeededOnDestinationAmws": { "type": "array", "description": "The destination Azure Monitor Workspaces that are still missing the Monitoring Reader grant for the Drill identity.", "items": { "type": "string" }, "readOnly": true } }, "required": [ "sliId", "type" ] }, "SliMonitoringProperties": { "type": "object", "description": "SLI monitoring properties of a Drill. At most two SLIs may be selected: at most one Availability and one Latency.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentity", "description": "Identity that the Drill uses to read evaluated SLI results from each SLI's destination Azure Monitor Workspace. The Drill is granted Monitoring Reader on every destination AMW of every selected SLI for this identity." }, "slis": { "type": "array", "description": "The SLIs selected for Drill monitoring. Maximum of two entries: at most one Availability and one Latency. Duplicate types or duplicate SLI Ids are rejected.", "minItems": 1, "maxItems": 2, "items": { "$ref": "#/definitions/SliSelection" }, "x-ms-identifiers": [] } }, "required": [ "identity", "slis" ] }, "SliMonitoringPropertiesUpdate": { "type": "object", "description": "SLI monitoring properties of a Drill. At most two SLIs may be selected: at most one Availability and one Latency.", "properties": { "identity": { "$ref": "#/definitions/AssociatedIdentityUpdate", "description": "Identity that the Drill uses to read evaluated SLI results from each SLI's destination Azure Monitor Workspace. The Drill is granted Monitoring Reader on every destination AMW of every selected SLI for this identity." }, "slis": { "type": "array", "description": "The SLIs selected for Drill monitoring. Maximum of two entries: at most one Availability and one Latency. Duplicate types or duplicate SLI Ids are rejected.", "minItems": 1, "maxItems": 2, "items": { "$ref": "#/definitions/SliSelection" }, "x-ms-identifiers": [] } } }, "SliSelection": { "type": "object", "description": "A single SLI selected for Drill monitoring.", "properties": { "sliId": { "type": "string", "format": "arm-id", "description": "Full ARM Id of the SLI.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Monitor/slis" } ] } }, "type": { "$ref": "#/definitions/SliType", "description": "User-declared category of the SLI. Must be unique across the selected SLIs." } }, "required": [ "sliId", "type" ] }, "SliType": { "type": "string", "description": "Category of an SLI selected for Drill monitoring.", "enum": [ "Availability", "Latency" ], "x-ms-enum": { "name": "SliType", "modelAsString": true, "values": [ { "name": "Availability", "value": "Availability", "description": "Availability SLI." }, { "name": "Latency", "value": "Latency", "description": "Latency SLI." } ] } }, "SliTypeMatchState": { "type": "string", "description": "Whether the user-declared SLI type matches the SLI's actual category.", "enum": [ "Matched", "Mismatched" ], "x-ms-enum": { "name": "SliTypeMatchState", "modelAsString": true, "values": [ { "name": "Matched", "value": "Matched", "description": "Declared type matches the SLI's actual category." }, { "name": "Mismatched", "value": "Mismatched", "description": "Declared type does not match the SLI's actual category." } ] } }, "SolutionDisplayName": { "type": "string", "description": "Identifies a high-availability solution that can be applied to a resource (for example, zone-pinned VM with ZRS disk).", "enum": [ "ZonePinnedVmWithZrsDisk", "VmInMultiZoneVmss" ], "x-ms-enum": { "name": "SolutionDisplayName", "modelAsString": true, "values": [ { "name": "ZonePinnedVmWithZrsDisk", "value": "ZonePinnedVmWithZrsDisk", "description": "Zone pinned VM with ZRS disk." }, { "name": "VmInMultiZoneVmss", "value": "VmInMultiZoneVmss", "description": "VM in multi-zone VMSS." } ] } }, "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." }, "resourceTypeCategories": { "type": "array", "description": "An indication whether a intrested resource type is present in drill resource.", "items": { "$ref": "#/definitions/ResourceTypeCategories" }, "readOnly": true } }, "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" } ] }, "UnifiedResilienceItemBillingInfo": { "type": "object", "description": "Definition of billing information in unified resilience item.", "properties": { "usagePlanArmId": { "type": "string", "format": "arm-id", "description": "Arm id of the usage plan applied to the service group." }, "usagePlanEnrollmentArmId": { "type": "string", "format": "arm-id", "description": "Arm id of the usage plan enrollment that links the usage plan to the service group." }, "usagePlanEnrollmentCreatedOn": { "type": "string", "format": "date-time", "description": "The date and time when the usage plan enrollment was created." }, "usagePlanEnrollmentLastUpdatedOn": { "type": "string", "format": "date-time", "description": "The date and time when the usage plan enrollment was last updated." }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "Details of any errors encountered while resolving the billing information.", "readOnly": true } } }, "UnifiedResilienceItemGoalRequirement": { "type": "object", "description": "Definition of a resilience goal requirement copied from the goal assignment.", "properties": { "required": { "type": "boolean", "description": "Whether the goal is required for the service group." } }, "required": [ "required" ] }, "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." }, "resiliencyPosture": { "$ref": "#/definitions/UnifiedResilienceItemResiliencyPosture", "description": "Resiliency posture computed for the service group." }, "billingInfo": { "$ref": "#/definitions/UnifiedResilienceItemBillingInfo", "description": "Usage plan and enrollment billing information for the service group." }, "lastModifiedTime": { "type": "string", "format": "date-time", "description": "Last modified time of the unified resilience item." } }, "required": [ "goals", "resiliencyPosture", "lastModifiedTime" ] }, "UnifiedResilienceItemResiliencyPosture": { "type": "object", "description": "Definition of the resiliency posture computed for the unified resilience item.", "properties": { "zonalResiliency": { "$ref": "#/definitions/UnifiedResilienceItemZonalResiliencyPosture", "description": "The zonal resiliency section of the resiliency posture." } }, "required": [ "zonalResiliency" ] }, "UnifiedResilienceItemZonalResiliencyPosture": { "type": "object", "description": "Definition of the zonal resiliency posture computed for the unified resilience item.", "properties": { "enabledResourceCount": { "type": "integer", "format": "int64", "description": "Count of resources that have zonal resiliency enabled." }, "notEnabledResourceCount": { "type": "integer", "format": "int64", "description": "Count of resources that do not have zonal resiliency enabled." }, "notEvaluatedResourceCount": { "type": "integer", "format": "int64", "description": "Count of resources that have not been evaluated for zonal resiliency." }, "userConfirmationNeededCount": { "type": "integer", "format": "int64", "description": "Count of resources that require user confirmation for zonal resiliency." }, "evaluationDateTime": { "type": "string", "format": "date-time", "description": "The date and time when the zonal resiliency posture was last evaluated." } } }, "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": [] } } }, "UsagePlan": { "type": "object", "description": "A usage plan resource for Resiliency feature billing.", "properties": { "properties": { "$ref": "#/definitions/UsagePlanProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "UsagePlanListResult": { "type": "object", "description": "The response of a UsagePlan list operation.", "properties": { "value": { "type": "array", "description": "The UsagePlan items on this page", "items": { "$ref": "#/definitions/UsagePlan" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "UsagePlanProperties": { "type": "object", "description": "Definition of usage plan properties.", "properties": { "planType": { "$ref": "#/definitions/UsagePlanType", "description": "The type of the usage plan." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the usage plan.", "readOnly": true }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "Details of any errors encountered during Usage Plan create or update.", "readOnly": true } } }, "UsagePlanTagsUpdate": { "type": "object", "description": "The type used for updating tags in UsagePlan resources.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "UsagePlanType": { "type": "string", "description": "The type of usage plan.", "enum": [ "Standard" ], "x-ms-enum": { "name": "UsagePlanType", "modelAsString": true, "values": [ { "name": "Standard", "value": "Standard", "description": "Standard usage plan with comprehensive functionality and usage based charges." } ] } }, "UserConfirmationItem": { "type": "object", "description": "Represents a user confirmation for a high availability solution.", "properties": { "solutionDisplayName": { "$ref": "#/definitions/SolutionDisplayName", "description": "The solution display name of the high availability solution." }, "confirmationStatus": { "$ref": "#/definitions/ConfirmationStatus", "description": "The confirmation status of the high availability solution." }, "reasonForRequestingConfirmation": { "$ref": "#/definitions/ReasonForRequestingConfirmation", "description": "The reason for requesting user confirmation for the high availability solution." } }, "required": [ "solutionDisplayName", "confirmationStatus" ] }, "UserConsent": { "type": "string", "description": "User consent for performing recovery action.", "enum": [ "Unspecified", "Allowed" ], "x-ms-enum": { "name": "UserConsent", "modelAsString": true, "values": [ { "name": "Unspecified", "value": "Unspecified", "description": "User consent is not specified for the operation." }, { "name": "Allowed", "value": "Allowed", "description": "Action is allowed with user consent." } ] } }, "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." } ] } }, "ValidateForExecutionProperties": { "type": "object", "description": "Additional properties for Failover.", "properties": { "operationName": { "$ref": "#/definitions/DrillRunTasks", "description": "Operation name for which the validation is being done. This is needed to determine the set of validations to be done for the operation." }, "sourceLocations": { "type": "array", "description": "Physiscal Source locations from where resources to be failed-over or faulted.", "items": { "type": "string" } } } }, "ValidateForExecutionRequest": { "type": "object", "description": "Request body of the Validate For Execute Action of Drill.", "properties": { "validateForExecutionProperties": { "$ref": "#/definitions/ValidateForExecutionProperties", "description": "Additional properties for Validate for execute." } } }, "ValidateForExecutionResponse": { "type": "object", "description": "ValidateForExecution post action response.", "properties": { "drillResourceQualifications": { "type": "array", "description": "Qualification details of resources for the operation.", "items": { "$ref": "#/definitions/DrillResourceQualification" }, "readOnly": true, "x-ms-identifiers": [] } }, "required": [ "drillResourceQualifications" ] }, "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" }, "ZonalDrillResourceProperties": { "type": "object", "description": "Properties of a resource in a zonal Resiliency Drill.", "properties": { "activePhysicalZones": { "type": "array", "description": "Active Resource location and physical zones of Azure Resource.", "items": { "type": "string" }, "readOnly": true }, "recoveryPhysicalZones": { "type": "array", "description": "Recovery Resource location and physical zones of HA Azure Resource.", "items": { "type": "string" }, "readOnly": true }, "haStatus": { "$ref": "#/definitions/HAStatus", "description": "HA status of the Drill resource", "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" } ] } } }, "allOf": [ { "$ref": "#/definitions/DrillResourceProperties" } ], "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" } } }