{ "swagger": "2.0", "info": { "title": "SiteRecoveryManagementClient", "version": "2026-11-01", "description": "Open API for RecoveryServicesSiteRecovery", "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": "ReplicationAlertSettings" }, { "name": "ReplicationEligibilityResults" }, { "name": "ReplicationEvents" }, { "name": "ReplicationFabrics" }, { "name": "ReplicationLogicalNetworks" }, { "name": "ReplicationNetworks" }, { "name": "ReplicationNetworkMappings" }, { "name": "ReplicationProtectionContainers" }, { "name": "ReplicationMigrationItems" }, { "name": "MigrationRecoveryPoints" }, { "name": "ReplicationProtectableItems" }, { "name": "ReplicationProtectedItems" }, { "name": "TargetComputeSizes" }, { "name": "RecoveryPoints" }, { "name": "ReplicationProtectionClusters" }, { "name": "ClusterRecoveryPoint" }, { "name": "ClusterRecoveryPoints" }, { "name": "ReplicationProtectionContainerMappings" }, { "name": "ReplicationRecoveryServicesProviders" }, { "name": "ReplicationStorageClassifications" }, { "name": "ReplicationStorageClassificationMappings" }, { "name": "ReplicationvCenters" }, { "name": "ReplicationJobs" }, { "name": "ReplicationPolicies" }, { "name": "ReplicationProtectionIntents" }, { "name": "ReplicationRecoveryPlans" }, { "name": "ReplicationVaultSetting" }, { "name": "Operations" }, { "name": "ReplicationAppliances" }, { "name": "SupportedOperatingSystems" }, { "name": "ReplicationVaultHealth" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults": { "get": { "operationId": "ReplicationEligibilityResults_List", "tags": [ "ReplicationEligibilityResults" ], "summary": "Gets the validation errors in case the VM is unsuitable for protection.", "description": "Validates whether a given VM can be protected or not in which case returns list of errors.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ReplicationEligibilityResultsParentParam.virtualMachineName" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationEligibilityResultsCollection" } } }, "x-ms-examples": { "Gets the validation errors in case the VM is unsuitable for protection.": { "$ref": "./examples/ReplicationEligibilityResults_List.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults/default": { "get": { "operationId": "ReplicationEligibilityResults_Get", "tags": [ "ReplicationEligibilityResults" ], "summary": "Gets the validation errors in case the VM is unsuitable for protection.", "description": "Validates whether a given VM can be protected or not in which case returns list of errors.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ReplicationEligibilityResultsParentParam.virtualMachineName" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationEligibilityResults" } } }, "x-ms-examples": { "Gets the validation errors in case the VM is unsuitable for protection.": { "$ref": "./examples/ReplicationEligibilityResults_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "summary": "Returns the list of available operations.", "description": "Operation to return the list of available operations.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/OperationsDiscoveryCollection" } } }, "x-ms-examples": { "Returns the list of available operations.": { "$ref": "./examples/Operations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings": { "get": { "operationId": "ReplicationAlertSettings_List", "tags": [ "ReplicationAlertSettings" ], "summary": "Gets the list of configured email notification(alert) configurations.", "description": "Gets the list of email notification(alert) configurations for the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AlertCollection" } } }, "x-ms-examples": { "Gets the list of configured email notification(alert) configurations.": { "$ref": "./examples/ReplicationAlertSettings_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings/{alertSettingName}": { "get": { "operationId": "ReplicationAlertSettings_Get", "tags": [ "ReplicationAlertSettings" ], "summary": "Gets an email notification(alert) configuration.", "description": "Gets the details of the specified email notification(alert) configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "alertSettingName", "in": "path", "description": "The name of the email notification configuration.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Alert" } } }, "x-ms-examples": { "Gets an email notification(alert) configuration.": { "$ref": "./examples/ReplicationAlertSettings_Get.json" } } }, "put": { "operationId": "ReplicationAlertSettings_Create", "tags": [ "ReplicationAlertSettings" ], "summary": "Configures email notifications for this vault.", "description": "Create or update an email notification(alert) configuration.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "alertSettingName", "in": "path", "description": "The name of the email notification configuration.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "The input to configure the email notification(alert).", "required": true, "schema": { "$ref": "#/definitions/ConfigureAlertRequest" } } ], "responses": { "200": { "description": "Resource 'Alert' update operation succeeded", "schema": { "$ref": "#/definitions/Alert" } } }, "x-ms-examples": { "Configures email notifications for this vault.": { "$ref": "./examples/ReplicationAlertSettings_Create.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAppliances": { "get": { "operationId": "ReplicationAppliances_List", "tags": [ "ReplicationAppliances" ], "summary": "Gets the list of appliances.", "description": "Gets the list of Azure Site Recovery appliances for the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "OData filter options.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ApplianceCollection" } } }, "x-ms-examples": { "Gets the list of appliances.": { "$ref": "./examples/ReplicationAppliances_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents": { "get": { "operationId": "ReplicationEvents_List", "tags": [ "ReplicationEvents" ], "summary": "Gets the list of Azure Site Recovery events.", "description": "Gets the list of Azure Site Recovery events for the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "OData filter options.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EventCollection" } } }, "x-ms-examples": { "Gets the list of Azure Site Recovery events.": { "$ref": "./examples/ReplicationEvents_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents/{eventName}": { "get": { "operationId": "ReplicationEvents_Get", "tags": [ "ReplicationEvents" ], "summary": "Get the details of an Azure Site recovery event.", "description": "The operation to get the details of an Azure Site recovery event.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "eventName", "in": "path", "description": "The name of the Azure Site Recovery event.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Event" } } }, "x-ms-examples": { "Get the details of an Azure Site recovery event.": { "$ref": "./examples/ReplicationEvents_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics": { "get": { "operationId": "ReplicationFabrics_List", "tags": [ "ReplicationFabrics" ], "summary": "Gets the list of ASR fabrics.", "description": "Gets a list of the Azure Site Recovery fabrics in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/FabricCollection" } } }, "x-ms-examples": { "Gets the list of ASR fabrics.": { "$ref": "./examples/ReplicationFabrics_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}": { "get": { "operationId": "ReplicationFabrics_Get", "tags": [ "ReplicationFabrics" ], "summary": "Gets the details of an ASR fabric.", "description": "Gets the details of an Azure Site Recovery fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "OData filter options.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Fabric" } } }, "x-ms-examples": { "Gets the details of an ASR fabric.": { "$ref": "./examples/ReplicationFabrics_Get.json" } } }, "put": { "operationId": "ReplicationFabrics_Create", "tags": [ "ReplicationFabrics" ], "summary": "Creates an Azure Site Recovery fabric.", "description": "The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Fabric creation input.", "required": true, "schema": { "$ref": "#/definitions/FabricCreationInput" } } ], "responses": { "200": { "description": "Resource 'Fabric' update operation succeeded", "schema": { "$ref": "#/definitions/Fabric" } }, "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." } } } }, "x-ms-examples": { "Creates an Azure Site Recovery fabric.": { "$ref": "./examples/ReplicationFabrics_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Fabric" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationFabrics_Purge", "tags": [ "ReplicationFabrics" ], "summary": "Purges the site.", "description": "The operation to purge(force delete) an Azure Site Recovery fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" } ], "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." } }, "x-ms-examples": { "Purges the site.": { "$ref": "./examples/ReplicationFabrics_Purge.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/checkConsistency": { "post": { "operationId": "ReplicationFabrics_CheckConsistency", "tags": [ "ReplicationFabrics" ], "summary": "Checks the consistency of the ASR fabric.", "description": "The operation to perform a consistency check on the fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Fabric" } }, "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." } } } }, "x-ms-examples": { "Checks the consistency of the ASR fabric.": { "$ref": "./examples/ReplicationFabrics_CheckConsistency.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Fabric" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/migratetoaad": { "post": { "operationId": "ReplicationFabrics_MigrateToAad", "tags": [ "ReplicationFabrics" ], "summary": "Migrates the site to AAD.", "description": "The operation to migrate an Azure Site Recovery fabric to AAD.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." } }, "x-ms-examples": { "Migrates the site to AAD.": { "$ref": "./examples/ReplicationFabrics_MigrateToAad.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/reassociateGateway": { "post": { "operationId": "ReplicationFabrics_ReassociateGateway", "tags": [ "ReplicationFabrics" ], "summary": "Perform failover of the process server.", "description": "The operation to move replications from a process server to another process server.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "failoverProcessServerRequest", "in": "body", "description": "The input to the failover process server operation.", "required": true, "schema": { "$ref": "#/definitions/FailoverProcessServerRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Fabric" } }, "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." } } } }, "x-ms-examples": { "Perform failover of the process server.": { "$ref": "./examples/ReplicationFabrics_ReassociateGateway.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Fabric" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/remove": { "post": { "operationId": "ReplicationFabrics_Delete", "tags": [ "ReplicationFabrics" ], "summary": "Deletes the site.", "description": "The operation to delete or remove an Azure Site Recovery fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." } }, "x-ms-examples": { "Deletes the site.": { "$ref": "./examples/ReplicationFabrics_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/removeInfra": { "post": { "operationId": "ReplicationFabrics_RemoveInfra", "tags": [ "ReplicationFabrics" ], "summary": "Removes the appliance's infrastructure under the fabric.", "description": "Removes the appliance's infrastructure under the fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Removes the appliance's infrastructure under the fabric.": { "$ref": "./examples/ReplicationInfrastructure_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/renewCertificate": { "post": { "operationId": "ReplicationFabrics_RenewCertificate", "tags": [ "ReplicationFabrics" ], "summary": "Renews certificate for the fabric.", "description": "Renews the connection certificate for the ASR replication fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "renewCertificate", "in": "body", "description": "Renew certificate input.", "required": true, "schema": { "$ref": "#/definitions/RenewCertificateInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Fabric" } }, "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." } } } }, "x-ms-examples": { "Renews certificate for the fabric.": { "$ref": "./examples/ReplicationFabrics_RenewCertificate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Fabric" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks": { "get": { "operationId": "ReplicationLogicalNetworks_ListByReplicationFabrics", "tags": [ "ReplicationLogicalNetworks" ], "summary": "Gets the list of logical networks under a fabric.", "description": "Lists all the logical networks of the Azure Site Recovery fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogicalNetworkCollection" } } }, "x-ms-examples": { "Gets the list of logical networks under a fabric.": { "$ref": "./examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks/{logicalNetworkName}": { "get": { "operationId": "ReplicationLogicalNetworks_Get", "tags": [ "ReplicationLogicalNetworks" ], "summary": "Gets a logical network with specified server id and logical network name.", "description": "Gets the details of a logical network.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "logicalNetworkName", "in": "path", "description": "Logical network name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LogicalNetwork" } } }, "x-ms-examples": { "Gets a logical network with specified server id and logical network name.": { "$ref": "./examples/ReplicationLogicalNetworks_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks": { "get": { "operationId": "ReplicationNetworks_ListByReplicationFabrics", "tags": [ "ReplicationNetworks" ], "summary": "Gets the list of networks under a fabric.", "description": "Lists the networks available for a fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkCollection" } } }, "x-ms-examples": { "Gets the list of networks under a fabric.": { "$ref": "./examples/ReplicationNetworks_ListByReplicationFabrics.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}": { "get": { "operationId": "ReplicationNetworks_Get", "tags": [ "ReplicationNetworks" ], "summary": "Gets a network with specified server id and network name.", "description": "Gets the details of a network.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "networkName", "in": "path", "description": "Primary network name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Network" } } }, "x-ms-examples": { "Gets a network with specified server id and network name.": { "$ref": "./examples/ReplicationNetworks_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings": { "get": { "operationId": "ReplicationNetworkMappings_ListByReplicationNetworks", "tags": [ "ReplicationNetworkMappings" ], "summary": "Gets all the network mappings under a network.", "description": "Lists all ASR network mappings for the specified network.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "networkName", "in": "path", "description": "Primary network name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkMappingCollection" } } }, "x-ms-examples": { "Gets all the network mappings under a network.": { "$ref": "./examples/ReplicationNetworkMappings_ListByReplicationNetworks.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName}": { "get": { "operationId": "ReplicationNetworkMappings_Get", "tags": [ "ReplicationNetworkMappings" ], "summary": "Gets network mapping by name.", "description": "Gets the details of an ASR network mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "networkName", "in": "path", "description": "Primary network name.", "required": true, "type": "string" }, { "name": "networkMappingName", "in": "path", "description": "Network mapping name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkMapping" } } }, "x-ms-examples": { "Gets network mapping by name.": { "$ref": "./examples/ReplicationNetworkMappings_Get.json" } } }, "put": { "operationId": "ReplicationNetworkMappings_Create", "tags": [ "ReplicationNetworkMappings" ], "summary": "Creates network mapping.", "description": "The operation to create an ASR network mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "networkName", "in": "path", "description": "Primary network name.", "required": true, "type": "string" }, { "name": "networkMappingName", "in": "path", "description": "Network mapping name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Create network mapping input.", "required": true, "schema": { "$ref": "#/definitions/CreateNetworkMappingInput" } } ], "responses": { "200": { "description": "Resource 'NetworkMapping' update operation succeeded", "schema": { "$ref": "#/definitions/NetworkMapping" } }, "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." } } } }, "x-ms-examples": { "Creates network mapping.": { "$ref": "./examples/ReplicationNetworkMappings_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/NetworkMapping" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ReplicationNetworkMappings_Update", "tags": [ "ReplicationNetworkMappings" ], "summary": "Updates network mapping.", "description": "The operation to update an ASR network mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "networkName", "in": "path", "description": "Primary network name.", "required": true, "type": "string" }, { "name": "networkMappingName", "in": "path", "description": "Network mapping name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Update network mapping input.", "required": true, "schema": { "$ref": "#/definitions/UpdateNetworkMappingInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkMapping" } }, "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." } } } }, "x-ms-examples": { "Updates network mapping.": { "$ref": "./examples/ReplicationNetworkMappings_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/NetworkMapping" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationNetworkMappings_Delete", "tags": [ "ReplicationNetworkMappings" ], "summary": "Delete network mapping.", "description": "The operation to delete a network mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "networkName", "in": "path", "description": "Primary network name.", "required": true, "type": "string" }, { "name": "networkMappingName", "in": "path", "description": "Network mapping name.", "required": true, "type": "string" } ], "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." } }, "x-ms-examples": { "Delete network mapping.": { "$ref": "./examples/ReplicationNetworkMappings_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers": { "get": { "operationId": "ReplicationProtectionContainers_ListByReplicationFabrics", "tags": [ "ReplicationProtectionContainers" ], "summary": "Gets the list of protection container for a fabric.", "description": "Lists the protection containers in the specified fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProtectionContainerCollection" } } }, "x-ms-examples": { "Gets the list of protection container for a fabric.": { "$ref": "./examples/ReplicationProtectionContainers_ListByReplicationFabrics.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}": { "get": { "operationId": "ReplicationProtectionContainers_Get", "tags": [ "ReplicationProtectionContainers" ], "summary": "Gets the protection container details.", "description": "Gets the details of a protection container.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProtectionContainer" } } }, "x-ms-examples": { "Gets the protection container details.": { "$ref": "./examples/ReplicationProtectionContainers_Get.json" } } }, "put": { "operationId": "ReplicationProtectionContainers_Create", "tags": [ "ReplicationProtectionContainers" ], "summary": "Create a protection container.", "description": "Operation to create a protection container.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "creationInput", "in": "body", "description": "Creation input.", "required": true, "schema": { "$ref": "#/definitions/CreateProtectionContainerInput" } } ], "responses": { "200": { "description": "Resource 'ProtectionContainer' update operation succeeded", "schema": { "$ref": "#/definitions/ProtectionContainer" } }, "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." } } } }, "x-ms-examples": { "Create a protection container.": { "$ref": "./examples/ReplicationProtectionContainers_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ProtectionContainer" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/discoverProtectableItem": { "post": { "operationId": "ReplicationProtectionContainers_DiscoverProtectableItem", "tags": [ "ReplicationProtectionContainers" ], "summary": "Adds a protectable item to the replication protection container.", "description": "The operation to a add a protectable item to a protection container(Add physical server).", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "discoverProtectableItemRequest", "in": "body", "description": "The request object to add a protectable item.", "required": true, "schema": { "$ref": "#/definitions/DiscoverProtectableItemRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProtectionContainer" } }, "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." } } } }, "x-ms-examples": { "Adds a protectable item to the replication protection container.": { "$ref": "./examples/ReplicationProtectionContainers_DiscoverProtectableItem.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ProtectionContainer" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/remove": { "post": { "operationId": "ReplicationProtectionContainers_Delete", "tags": [ "ReplicationProtectionContainers" ], "summary": "Removes a protection container.", "description": "Operation to remove a protection container.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." } }, "x-ms-examples": { "Removes a protection container.": { "$ref": "./examples/ReplicationProtectionContainers_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems": { "get": { "operationId": "ReplicationMigrationItems_ListByReplicationProtectionContainers", "tags": [ "ReplicationMigrationItems" ], "summary": "Gets the list of migration items in the protection container.", "description": "Gets the list of ASR migration items in the protection container.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "skipToken", "in": "query", "description": "The pagination token.", "required": false, "type": "string" }, { "name": "takeToken", "in": "query", "description": "The page size.", "required": false, "type": "string" }, { "name": "$filter", "in": "query", "description": "OData filter options.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationItemCollection" } } }, "x-ms-examples": { "Gets the list of migration items in the protection container.": { "$ref": "./examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}": { "get": { "operationId": "ReplicationMigrationItems_Get", "tags": [ "ReplicationMigrationItems" ], "summary": "Gets the details of a migration item.", "description": "Gets the details of a migration item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationItem" } } }, "x-ms-examples": { "Gets the details of a migration item.": { "$ref": "./examples/ReplicationMigrationItems_Get.json" } } }, "put": { "operationId": "ReplicationMigrationItems_Create", "tags": [ "ReplicationMigrationItems" ], "summary": "Enables migration.", "description": "The operation to create an ASR migration item (enable migration).", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Enable migration input.", "required": true, "schema": { "$ref": "#/definitions/EnableMigrationInput" } } ], "responses": { "200": { "description": "Resource 'MigrationItem' update operation succeeded", "schema": { "$ref": "#/definitions/MigrationItem" } }, "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." } } } }, "x-ms-examples": { "Enables migration.": { "$ref": "./examples/ReplicationMigrationItems_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrationItem" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ReplicationMigrationItems_Update", "tags": [ "ReplicationMigrationItems" ], "summary": "Updates migration item.", "description": "The operation to update the recovery settings of an ASR migration item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Update migration item input.", "required": true, "schema": { "$ref": "#/definitions/UpdateMigrationItemInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationItem" } }, "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." } } } }, "x-ms-examples": { "Updates migration item.": { "$ref": "./examples/ReplicationMigrationItems_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrationItem" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationMigrationItems_Delete", "tags": [ "ReplicationMigrationItems" ], "summary": "Delete the migration item.", "description": "The operation to delete an ASR migration item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" }, { "name": "deleteOption", "in": "query", "description": "The delete option.", "required": false, "type": "string" } ], "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." } }, "x-ms-examples": { "Delete the migration item.": { "$ref": "./examples/ReplicationMigrationItems_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrate": { "post": { "operationId": "ReplicationMigrationItems_Migrate", "tags": [ "ReplicationMigrationItems" ], "summary": "Migrate item.", "description": "The operation to initiate migration of the item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" }, { "name": "migrateInput", "in": "body", "description": "Migrate input.", "required": true, "schema": { "$ref": "#/definitions/MigrateInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationItem" } }, "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." } } } }, "x-ms-examples": { "Migrate item.": { "$ref": "./examples/ReplicationMigrationItems_Migrate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrationItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints": { "get": { "operationId": "MigrationRecoveryPoints_ListByReplicationMigrationItems", "tags": [ "MigrationRecoveryPoints" ], "summary": "Gets the recovery points for a migration item.", "description": "Gets the recovery points for a migration item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationRecoveryPointCollection" } } }, "x-ms-examples": { "Gets the recovery points for a migration item.": { "$ref": "./examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints/{migrationRecoveryPointName}": { "get": { "operationId": "MigrationRecoveryPoints_Get", "tags": [ "MigrationRecoveryPoints" ], "summary": "Gets a recovery point for a migration item.", "description": "Gets a recovery point for a migration item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" }, { "name": "migrationRecoveryPointName", "in": "path", "description": "The migration recovery point name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationRecoveryPoint" } } }, "x-ms-examples": { "Gets a recovery point for a migration item.": { "$ref": "./examples/MigrationRecoveryPoints_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/pauseReplication": { "post": { "operationId": "ReplicationMigrationItems_PauseReplication", "tags": [ "ReplicationMigrationItems" ], "summary": "Pause replication.", "description": "The operation to initiate pause replication of the item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" }, { "name": "pauseReplicationInput", "in": "body", "description": "Pause replication input.", "required": true, "schema": { "$ref": "#/definitions/PauseReplicationInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationItem" } }, "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." } } } }, "x-ms-examples": { "Pause replication.": { "$ref": "./examples/ReplicationMigrationItems_PauseReplication.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrationItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resumeReplication": { "post": { "operationId": "ReplicationMigrationItems_ResumeReplication", "tags": [ "ReplicationMigrationItems" ], "summary": "Resume replication.", "description": "The operation to initiate resume replication of the item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" }, { "name": "resumeReplicationInput", "in": "body", "description": "Resume replication input.", "required": true, "schema": { "$ref": "#/definitions/ResumeReplicationInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationItem" } }, "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." } } } }, "x-ms-examples": { "Resume replication.": { "$ref": "./examples/ReplicationMigrationItems_ResumeReplication.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrationItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resync": { "post": { "operationId": "ReplicationMigrationItems_Resync", "tags": [ "ReplicationMigrationItems" ], "summary": "Resynchronizes replication.", "description": "The operation to resynchronize replication of an ASR migration item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Resync input.", "required": true, "schema": { "$ref": "#/definitions/ResyncInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationItem" } }, "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." } } } }, "x-ms-examples": { "Resynchronizes replication.": { "$ref": "./examples/ReplicationMigrationItems_Resync.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrationItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrate": { "post": { "operationId": "ReplicationMigrationItems_TestMigrate", "tags": [ "ReplicationMigrationItems" ], "summary": "Test migrate item.", "description": "The operation to initiate test migration of the item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" }, { "name": "testMigrateInput", "in": "body", "description": "Test migrate input.", "required": true, "schema": { "$ref": "#/definitions/TestMigrateInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationItem" } }, "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." } } } }, "x-ms-examples": { "Test migrate item.": { "$ref": "./examples/ReplicationMigrationItems_TestMigrate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrationItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrateCleanup": { "post": { "operationId": "ReplicationMigrationItems_TestMigrateCleanup", "tags": [ "ReplicationMigrationItems" ], "summary": "Test migrate cleanup.", "description": "The operation to initiate test migrate cleanup.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "migrationItemName", "in": "path", "description": "Migration item name.", "required": true, "type": "string" }, { "name": "testMigrateCleanupInput", "in": "body", "description": "Test migrate cleanup input.", "required": true, "schema": { "$ref": "#/definitions/TestMigrateCleanupInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MigrationItem" } }, "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." } } } }, "x-ms-examples": { "Test migrate cleanup.": { "$ref": "./examples/ReplicationMigrationItems_TestMigrateCleanup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MigrationItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems": { "get": { "operationId": "ReplicationProtectableItems_ListByReplicationProtectionContainers", "tags": [ "ReplicationProtectableItems" ], "summary": "Gets the list of protectable items.", "description": "Lists the protectable items in a protection container.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "OData filter options.", "required": false, "type": "string" }, { "name": "$take", "in": "query", "description": "take OData query parameter.", "required": false, "type": "string" }, { "name": "$skipToken", "in": "query", "description": "skipToken OData query parameter.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProtectableItemCollection" } } }, "x-ms-examples": { "Gets the list of protectable items.": { "$ref": "./examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems/{protectableItemName}": { "get": { "operationId": "ReplicationProtectableItems_Get", "tags": [ "ReplicationProtectableItems" ], "summary": "Gets the details of a protectable item.", "description": "The operation to get the details of a protectable item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "protectableItemName", "in": "path", "description": "Protectable item name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProtectableItem" } } }, "x-ms-examples": { "Gets the details of a protectable item.": { "$ref": "./examples/ReplicationProtectableItems_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems": { "get": { "operationId": "ReplicationProtectedItems_ListByReplicationProtectionContainers", "tags": [ "ReplicationProtectedItems" ], "summary": "Gets the list of Replication protected items.", "description": "Gets the list of ASR replication protected items in the protection container.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItemCollection" } } }, "x-ms-examples": { "Gets the list of Replication protected items.": { "$ref": "./examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}": { "get": { "operationId": "ReplicationProtectedItems_Get", "tags": [ "ReplicationProtectedItems" ], "summary": "Gets the details of a Replication protected item.", "description": "Gets the details of an ASR replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } } }, "x-ms-examples": { "Gets the details of a Replication protected item.": { "$ref": "./examples/ReplicationProtectedItems_Get.json" }, "Gets the details of an A2A confidential VM with CMK disk encryption.": { "$ref": "./examples/ReplicationProtectedItems_Get_A2ACvm.json" } } }, "put": { "operationId": "ReplicationProtectedItems_Create", "tags": [ "ReplicationProtectedItems" ], "summary": "Enables protection.", "description": "The operation to create an ASR replication protected item (Enable replication).", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Enable Protection Input.", "required": true, "schema": { "$ref": "#/definitions/EnableProtectionInput" } } ], "responses": { "200": { "description": "Resource 'ReplicationProtectedItem' update operation succeeded", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Enables protection for an A2A confidential VM with CMK disk encryption.": { "$ref": "./examples/ReplicationProtectedItems_Create_A2ACvm.json" }, "Enables protection for an InMage RCM VM in an extended location.": { "$ref": "./examples/ReplicationProtectedItems_Create_InMageRcmEdgeZone.json" }, "Enables protection.": { "$ref": "./examples/ReplicationProtectedItems_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ReplicationProtectedItems_Update", "tags": [ "ReplicationProtectedItems" ], "summary": "Updates the replication protected item settings.", "description": "The operation to update the recovery settings of an ASR replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "updateProtectionInput", "in": "body", "description": "Update protection input.", "required": true, "schema": { "$ref": "#/definitions/UpdateReplicationProtectedItemInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Updates the recovery ip-configs of a dual-stack (IPv4 and IPv6) A2A protected item.": { "$ref": "./examples/ReplicationProtectedItems_Update_A2ADualStack.json" }, "Updates the replication protected Item settings.": { "$ref": "./examples/ReplicationProtectedItems_Update.json" }, "Updates the target confidential disk encryption set for an A2A confidential VM.": { "$ref": "./examples/ReplicationProtectedItems_Update_A2ACvm.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationProtectedItems_Purge", "tags": [ "ReplicationProtectedItems" ], "summary": "Purges protection.", "description": "The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" } ], "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." } }, "x-ms-examples": { "Purges protection.": { "$ref": "./examples/ReplicationProtectedItems_Purge.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks": { "post": { "operationId": "ReplicationProtectedItems_AddDisks", "tags": [ "ReplicationProtectedItems" ], "summary": "Add disk(s) for protection.", "description": "Operation to add disks(s) to the replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "addDisksInput", "in": "body", "description": "Add disks input.", "required": true, "schema": { "$ref": "#/definitions/AddDisksInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Adds a confidential data disk to an A2A protected confidential VM.": { "$ref": "./examples/ReplicationProtectedItems_AddDisks.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint": { "post": { "operationId": "ReplicationProtectedItems_ApplyRecoveryPoint", "tags": [ "ReplicationProtectedItems" ], "summary": "Change or apply recovery point.", "description": "The operation to change the recovery point of a failed over replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "applyRecoveryPointInput", "in": "body", "description": "The ApplyRecoveryPointInput.", "required": true, "schema": { "$ref": "#/definitions/ApplyRecoveryPointInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Change or apply recovery point.": { "$ref": "./examples/ReplicationProtectedItems_ApplyRecoveryPoint.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel": { "post": { "operationId": "ReplicationProtectedItems_FailoverCancel", "tags": [ "ReplicationProtectedItems" ], "summary": "Execute cancel failover.", "description": "Operation to cancel the failover of the replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Execute cancel failover.": { "$ref": "./examples/ReplicationProtectedItems_FailoverCancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit": { "post": { "operationId": "ReplicationProtectedItems_FailoverCommit", "tags": [ "ReplicationProtectedItems" ], "summary": "Execute commit failover.", "description": "Operation to commit the failover of the replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Execute commit failover.": { "$ref": "./examples/ReplicationProtectedItems_FailoverCommit.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover": { "post": { "operationId": "ReplicationProtectedItems_PlannedFailover", "tags": [ "ReplicationProtectedItems" ], "summary": "Execute planned failover.", "description": "Operation to initiate a planned failover of the replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "failoverInput", "in": "body", "description": "Planned failover input.", "required": true, "schema": { "$ref": "#/definitions/PlannedFailoverInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Execute planned failover.": { "$ref": "./examples/ReplicationProtectedItems_PlannedFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect": { "post": { "operationId": "ReplicationProtectedItems_Reprotect", "tags": [ "ReplicationProtectedItems" ], "summary": "Execute Reverse Replication\\Reprotect.", "description": "Operation to reprotect or reverse replicate a failed over replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "reprotectInput", "in": "body", "description": "Reverse replication input.", "required": true, "schema": { "$ref": "#/definitions/ReverseReplicationInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Execute Reverse Replication\\Reprotect.": { "$ref": "./examples/ReplicationProtectedItems_Reprotect.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints": { "get": { "operationId": "RecoveryPoints_ListByReplicationProtectedItems", "tags": [ "RecoveryPoints" ], "summary": "Gets the list of recovery points for a replication protected item.", "description": "Lists the available recovery points for a replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPointCollection" } } }, "x-ms-examples": { "Gets the list of recovery points for a replication protected item.": { "$ref": "./examples/RecoveryPoints_ListByReplicationProtectedItems.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName}": { "get": { "operationId": "RecoveryPoints_Get", "tags": [ "RecoveryPoints" ], "summary": "Gets a recovery point.", "description": "Get the details of specified recovery point.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "recoveryPointName", "in": "path", "description": "The recovery point name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPoint" } } }, "x-ms-examples": { "Gets a recovery point.": { "$ref": "./examples/RecoveryPoints_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reinstallMobilityService": { "post": { "operationId": "ReplicationProtectedItems_ReinstallMobilityService", "tags": [ "ReplicationProtectedItems" ], "summary": "Reinstall the mobility service on a protected item.", "description": "The operation to reinstall the installed mobility service software on a replication protected item to the latest available version.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": ".*" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "The name of the protected item on which the agent is to be updated.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "updateMobilityServiceRequest", "in": "body", "description": "Request to update the mobility service on the protected item.", "required": true, "schema": { "$ref": "#/definitions/ReinstallMobilityServiceRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Reinstall the mobility service on a protected item.": { "$ref": "./examples/ReplicationProtectedItems_ReinstallMobilityService.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove": { "post": { "operationId": "ReplicationProtectedItems_Delete", "tags": [ "ReplicationProtectedItems" ], "summary": "Disables protection.", "description": "The operation to disable replication on a replication protected item. This will also remove the item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "disableProtectionInput", "in": "body", "description": "Disable protection input.", "required": true, "schema": { "$ref": "#/definitions/DisableProtectionInput" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." } }, "x-ms-examples": { "Disables protection.": { "$ref": "./examples/ReplicationProtectedItems_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks": { "post": { "operationId": "ReplicationProtectedItems_RemoveDisks", "tags": [ "ReplicationProtectedItems" ], "summary": "Removes disk(s).", "description": "Operation to remove disk(s) from the replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "removeDisksInput", "in": "body", "description": "Remove disks input.", "required": true, "schema": { "$ref": "#/definitions/RemoveDisksInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Removes disk(s).": { "$ref": "./examples/ReplicationProtectedItems_RemoveDisks.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication": { "post": { "operationId": "ReplicationProtectedItems_RepairReplication", "tags": [ "ReplicationProtectedItems" ], "summary": "Resynchronize or repair replication.", "description": "The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Resynchronize or repair replication.": { "$ref": "./examples/ReplicationProtectedItems_RepairReplication.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors": { "post": { "operationId": "ReplicationProtectedItems_ResolveHealthErrors", "tags": [ "ReplicationProtectedItems" ], "summary": "Resolve health errors.", "description": "Operation to resolve health issues of the replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "resolveHealthInput", "in": "body", "description": "Health issue input object.", "required": true, "schema": { "$ref": "#/definitions/ResolveHealthInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Resolve health errors.": { "$ref": "./examples/ReplicationProtectedItems_ResolveHealthErrors.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/switchProvider": { "post": { "operationId": "ReplicationProtectedItems_SwitchProvider", "tags": [ "ReplicationProtectedItems" ], "summary": "Execute switch provider.", "description": "Operation to initiate a switch provider of the replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "switchProviderInput", "in": "body", "description": "Switch provider input.", "required": true, "schema": { "$ref": "#/definitions/SwitchProviderInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "202": { "description": "Resource operation accepted.", "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." } } } }, "x-ms-examples": { "Execute switch provider.": { "$ref": "./examples/ReplicationProtectedItems_SwitchProvider.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes": { "get": { "operationId": "TargetComputeSizes_ListByReplicationProtectedItems", "tags": [ "TargetComputeSizes" ], "summary": "Gets the list of target compute sizes for the replication protected item.", "description": "Lists the available target compute sizes for a replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TargetComputeSizeCollection" } } }, "x-ms-examples": { "Gets the list of target compute sizes for the replication protected item.": { "$ref": "./examples/TargetComputeSizes_ListByReplicationProtectedItems.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover": { "post": { "operationId": "ReplicationProtectedItems_TestFailover", "tags": [ "ReplicationProtectedItems" ], "summary": "Execute test failover.", "description": "Operation to perform a test failover of the replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "testfailoverInput", "in": "body", "description": "Test failover input.", "required": true, "schema": { "$ref": "#/definitions/TestFailoverInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Execute test failover.": { "$ref": "./examples/ReplicationProtectedItems_TestFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup": { "post": { "operationId": "ReplicationProtectedItems_TestFailoverCleanup", "tags": [ "ReplicationProtectedItems" ], "summary": "Execute test failover cleanup.", "description": "Operation to clean up the test failover of a replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "cleanupInput", "in": "body", "description": "Test failover cleanup input.", "required": true, "schema": { "$ref": "#/definitions/TestFailoverCleanupInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Execute test failover cleanup.": { "$ref": "./examples/ReplicationProtectedItems_TestFailoverCleanup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover": { "post": { "operationId": "ReplicationProtectedItems_UnplannedFailover", "tags": [ "ReplicationProtectedItems" ], "summary": "Execute unplanned failover.", "description": "Operation to initiate a failover of the replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "failoverInput", "in": "body", "description": "Failover input.", "required": true, "schema": { "$ref": "#/definitions/UnplannedFailoverInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Execute unplanned failover.": { "$ref": "./examples/ReplicationProtectedItems_UnplannedFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateAppliance": { "post": { "operationId": "ReplicationProtectedItems_UpdateAppliance", "tags": [ "ReplicationProtectedItems" ], "summary": "Updates appliance for replication protected Item.", "description": "The operation to update appliance of an ASR replication protected item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "applianceUpdateInput", "in": "body", "description": "Appliance update protection input.", "required": true, "schema": { "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Updates appliance for replication protected Item.": { "$ref": "./examples/ReplicationProtectedItems_UpdateAppliance.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateMobilityService": { "post": { "operationId": "ReplicationProtectedItems_UpdateMobilityService", "tags": [ "ReplicationProtectedItems" ], "summary": "Update the mobility service on a protected item.", "description": "The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", "description": "Replication protected item name.", "required": true, "type": "string" }, { "name": "updateMobilityServiceRequest", "in": "body", "description": "Request to update the mobility service on the protected item.", "required": true, "schema": { "$ref": "#/definitions/UpdateMobilityServiceRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "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." } } } }, "x-ms-examples": { "Update the mobility service on a protected item.": { "$ref": "./examples/ReplicationProtectedItems_UpdateMobilityService.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectedItem" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters": { "get": { "operationId": "ReplicationProtectionClusters_ListByReplicationProtectionContainers", "tags": [ "ReplicationProtectionClusters" ], "summary": "Gets the list of Replication protection clusters in fabric, container.", "description": "Gets the list of ASR replication protected clusters in the protection container.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionClusterCollection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the list of Replication protection clusters in fabric, container.": { "$ref": "./examples/ReplicationProtectionClusters_ListByReplicationProtectionContainers.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}": { "get": { "operationId": "ReplicationProtectionClusters_Get", "tags": [ "ReplicationProtectionClusters" ], "summary": "Gets the details of a Replication protection cluster.", "description": "Gets the details of an ASR replication protection cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionCluster" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the details of a Replication protection cluster.": { "$ref": "./examples/ReplicationProtectionClusters_Get.json" } } }, "put": { "operationId": "ReplicationProtectionClusters_Create", "tags": [ "ReplicationProtectionClusters" ], "summary": "Create Replication protection Cluster.", "description": "The operation to create an ASR replication protection cluster item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionCluster", "in": "body", "description": "Create replication protection cluster Input.", "required": true, "schema": { "$ref": "#/definitions/ReplicationProtectionCluster" } } ], "responses": { "200": { "description": "Resource 'ReplicationProtectionCluster' update operation succeeded", "schema": { "$ref": "#/definitions/ReplicationProtectionCluster" } }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create Replication protection Cluster.": { "$ref": "./examples/ReplicationProtectionClusters_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectionCluster" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationProtectionClusters_Purge", "tags": [ "ReplicationProtectionClusters" ], "summary": "Purge the replication protection cluster.", "description": "The operation to purge the replication protection cluster. This operation will force delete the replication protection cluster. Use the remove operation on replication protection cluster to perform a clean disable replication protection cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" } ], "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Purge the replication protection cluster.": { "$ref": "./examples/ReplicationProtectionClusters_Purge.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/applyRecoveryPoint": { "post": { "operationId": "ReplicationProtectionClusters_ApplyRecoveryPoint", "tags": [ "ReplicationProtectionClusters" ], "summary": "Execute the change recovery point operation for cluster.", "description": "Operation to apply a new cluster recovery point on the Protection cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "applyClusterRecoveryPointInput", "in": "body", "description": "Apply recovery point input.", "required": true, "schema": { "$ref": "#/definitions/ApplyClusterRecoveryPointInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionCluster" } }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Execute the change recovery point operation for cluster.": { "$ref": "./examples/ReplicationProtectionClusters_ApplyRecoveryPoint.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectionCluster" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/failoverCommit": { "post": { "operationId": "ReplicationProtectionClusters_FailoverCommit", "tags": [ "ReplicationProtectionClusters" ], "summary": "Execute commit failover for cluster.", "description": "Operation to initiate commit failover of the replication protection cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionCluster" } }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Execute commit failover for cluster.": { "$ref": "./examples/ReplicationProtectionClusters_FailoverCommit.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectionCluster" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/operationResults/{jobId}": { "get": { "operationId": "ReplicationProtectionClusters_GetOperationResults", "tags": [ "ReplicationProtectionClusters" ], "summary": "Tracks the Replication protection cluster async operation.", "description": "Track the results of an asynchronous operation on the replication protection cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "jobId", "in": "path", "description": "job id to track.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionCluster" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Tracks the Replication protection cluster async operation.": { "$ref": "./examples/ReplicationProtectionClusters_GetOperationResults.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/recoveryPoints": { "get": { "operationId": "ClusterRecoveryPoints_ListByReplicationProtectionCluster", "tags": [ "ClusterRecoveryPoints" ], "summary": "Gets the list of cluster recovery points.", "description": "The list of cluster recovery points.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ClusterRecoveryPointCollection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the list of cluster recovery points.": { "$ref": "./examples/ClusterRecoveryPoints_ListByReplicationProtectionCluster.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/recoveryPoints/{recoveryPointName}": { "get": { "operationId": "ClusterRecoveryPoint_Get", "tags": [ "ClusterRecoveryPoint" ], "summary": "Gets a recovery point.", "description": "Get the details of specified recovery point.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "recoveryPointName", "in": "path", "description": "The recovery point name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ClusterRecoveryPoint" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets a recovery point.": { "$ref": "./examples/ClusterRecoveryPoint_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/repairReplication": { "post": { "operationId": "ReplicationProtectionClusters_RepairReplication", "tags": [ "ReplicationProtectionClusters" ], "summary": "Resynchronize or repair replication of protection cluster.", "description": "The operation to repair replication protection cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionCluster" } }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Resynchronize or repair replication of protection cluster.": { "$ref": "./examples/ReplicationProtectionClusters_RepairReplication.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectionCluster" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/testFailover": { "post": { "operationId": "ReplicationProtectionClusters_TestFailover", "tags": [ "ReplicationProtectionClusters" ], "summary": "Execute test failover for cluster.", "description": "Operation to initiate a failover of the replication protection cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "failoverInput", "in": "body", "description": "Cluster test failover input body.", "required": true, "schema": { "$ref": "#/definitions/ClusterTestFailoverInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionCluster" } }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Execute test failover for cluster.": { "$ref": "./examples/ReplicationProtectionClusters_TestFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectionCluster" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/testFailoverCleanup": { "post": { "operationId": "ReplicationProtectionClusters_TestFailoverCleanup", "tags": [ "ReplicationProtectionClusters" ], "summary": "Execute test failover cleanup for cluster.", "description": "Operation to clean up the test failover of a replication protected cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "cleanupInput", "in": "body", "description": "Test failover cleanup input.", "required": true, "schema": { "$ref": "#/definitions/ClusterTestFailoverCleanupInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionCluster" } }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Execute test failover cleanup for cluster.": { "$ref": "./examples/ReplicationProtectionClusters_TestFailoverCleanup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectionCluster" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/unplannedFailover": { "post": { "operationId": "ReplicationProtectionClusters_UnplannedFailover", "tags": [ "ReplicationProtectionClusters" ], "summary": "Execute unplanned cluster failover.", "description": "Operation to initiate a failover of the replication protection cluster.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "replicationProtectionClusterName", "in": "path", "description": "Replication protection cluster name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "failoverInput", "in": "body", "description": "Failover input.", "required": true, "schema": { "$ref": "#/definitions/ClusterUnplannedFailoverInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionCluster" } }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Execute unplanned cluster failover.": { "$ref": "./examples/ReplicationProtectionClusters_UnplannedFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ReplicationProtectionCluster" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings": { "get": { "operationId": "ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers", "tags": [ "ReplicationProtectionContainerMappings" ], "summary": "Gets the list of protection container mappings for a protection container.", "description": "Lists the protection container mappings for a protection container.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProtectionContainerMappingCollection" } } }, "x-ms-examples": { "Gets the list of protection container mappings for a protection container.": { "$ref": "./examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}": { "get": { "operationId": "ReplicationProtectionContainerMappings_Get", "tags": [ "ReplicationProtectionContainerMappings" ], "summary": "Gets a protection container mapping.", "description": "Gets the details of a protection container mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "mappingName", "in": "path", "description": "Protection Container mapping name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProtectionContainerMapping" } } }, "x-ms-examples": { "Gets a protection container mapping.": { "$ref": "./examples/ReplicationProtectionContainerMappings_Get.json" } } }, "put": { "operationId": "ReplicationProtectionContainerMappings_Create", "tags": [ "ReplicationProtectionContainerMappings" ], "summary": "Create protection container mapping.", "description": "The operation to create a protection container mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "mappingName", "in": "path", "description": "Protection Container mapping name.", "required": true, "type": "string" }, { "name": "creationInput", "in": "body", "description": "Mapping creation input.", "required": true, "schema": { "$ref": "#/definitions/CreateProtectionContainerMappingInput" } } ], "responses": { "200": { "description": "Resource 'ProtectionContainerMapping' update operation succeeded", "schema": { "$ref": "#/definitions/ProtectionContainerMapping" } }, "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." } } } }, "x-ms-examples": { "Create protection container mapping.": { "$ref": "./examples/ReplicationProtectionContainerMappings_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ProtectionContainerMapping" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ReplicationProtectionContainerMappings_Update", "tags": [ "ReplicationProtectionContainerMappings" ], "summary": "Update protection container mapping.", "description": "The operation to update protection container mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "mappingName", "in": "path", "description": "Protection Container mapping name.", "required": true, "type": "string" }, { "name": "updateInput", "in": "body", "description": "Mapping update input.", "required": true, "schema": { "$ref": "#/definitions/UpdateProtectionContainerMappingInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProtectionContainerMapping" } }, "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." } } } }, "x-ms-examples": { "Update protection container mapping.": { "$ref": "./examples/ReplicationProtectionContainerMappings_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ProtectionContainerMapping" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationProtectionContainerMappings_Purge", "tags": [ "ReplicationProtectionContainerMappings" ], "summary": "Purge protection container mapping.", "description": "The operation to purge(force delete) a protection container mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "mappingName", "in": "path", "description": "Protection Container mapping name.", "required": true, "type": "string" } ], "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." } }, "x-ms-examples": { "Purge protection container mapping.": { "$ref": "./examples/ReplicationProtectionContainerMappings_Purge.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove": { "post": { "operationId": "ReplicationProtectionContainerMappings_Delete", "tags": [ "ReplicationProtectionContainerMappings" ], "summary": "Remove protection container mapping.", "description": "The operation to delete or remove a protection container mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "mappingName", "in": "path", "description": "Protection Container mapping name.", "required": true, "type": "string" }, { "name": "removalInput", "in": "body", "description": "Removal input.", "required": true, "schema": { "$ref": "#/definitions/RemoveProtectionContainerMappingInput" } } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." } }, "x-ms-examples": { "Remove protection container mapping.": { "$ref": "./examples/ReplicationProtectionContainerMappings_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchClusterProtection": { "post": { "operationId": "ReplicationProtectionContainers_SwitchClusterProtection", "tags": [ "ReplicationProtectionContainers" ], "summary": "Switches protection from one container to another.", "description": "Operation to switch protection from one container to another.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "switchInput", "in": "body", "description": "Switch protection input.", "required": true, "schema": { "$ref": "#/definitions/SwitchClusterProtectionInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProtectionContainer" } }, "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/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Switches protection from one container to another or one replication provider to another.": { "$ref": "./examples/ReplicationProtectionContainers_SwitchClusterProtection.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ProtectionContainer" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchprotection": { "post": { "operationId": "ReplicationProtectionContainers_SwitchProtection", "tags": [ "ReplicationProtectionContainers" ], "summary": "Switches protection from one container to another or one replication provider to another.", "description": "Operation to switch protection from one container to another or one replication provider to another.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", "description": "Protection container name.", "required": true, "type": "string" }, { "name": "switchInput", "in": "body", "description": "Switch protection input.", "required": true, "schema": { "$ref": "#/definitions/SwitchProtectionInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ProtectionContainer" } }, "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." } } } }, "x-ms-examples": { "Switches protection from one container to another or one replication provider to another.": { "$ref": "./examples/ReplicationProtectionContainers_SwitchProtection.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ProtectionContainer" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders": { "get": { "operationId": "ReplicationRecoveryServicesProviders_ListByReplicationFabrics", "tags": [ "ReplicationRecoveryServicesProviders" ], "summary": "Gets the list of registered recovery services providers for the fabric.", "description": "Lists the registered recovery services providers for the specified fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryServicesProviderCollection" } } }, "x-ms-examples": { "Gets the list of registered recovery services providers for the fabric.": { "$ref": "./examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}": { "get": { "operationId": "ReplicationRecoveryServicesProviders_Get", "tags": [ "ReplicationRecoveryServicesProviders" ], "summary": "Gets the details of a recovery services provider.", "description": "Gets the details of registered recovery services provider.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "providerName", "in": "path", "description": "Recovery services provider name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryServicesProvider" } } }, "x-ms-examples": { "Gets the details of a recovery services provider.": { "$ref": "./examples/ReplicationRecoveryServicesProviders_Get.json" } } }, "put": { "operationId": "ReplicationRecoveryServicesProviders_Create", "tags": [ "ReplicationRecoveryServicesProviders" ], "summary": "Adds a recovery services provider.", "description": "The operation to add a recovery services provider.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "providerName", "in": "path", "description": "Recovery services provider name.", "required": true, "type": "string" }, { "name": "addProviderInput", "in": "body", "description": "Add provider input.", "required": true, "schema": { "$ref": "#/definitions/AddRecoveryServicesProviderInput" } } ], "responses": { "200": { "description": "Resource 'RecoveryServicesProvider' update operation succeeded", "schema": { "$ref": "#/definitions/RecoveryServicesProvider" } }, "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." } } } }, "x-ms-examples": { "Adds a recovery services provider.": { "$ref": "./examples/ReplicationRecoveryServicesProviders_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryServicesProvider" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationRecoveryServicesProviders_Purge", "tags": [ "ReplicationRecoveryServicesProviders" ], "summary": "Purges recovery service provider from fabric.", "description": "The operation to purge(force delete) a recovery services provider from the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "providerName", "in": "path", "description": "Recovery services provider name.", "required": true, "type": "string" } ], "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." } }, "x-ms-examples": { "Purges recovery service provider from fabric.": { "$ref": "./examples/ReplicationRecoveryServicesProviders_Purge.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/refreshProvider": { "post": { "operationId": "ReplicationRecoveryServicesProviders_RefreshProvider", "tags": [ "ReplicationRecoveryServicesProviders" ], "summary": "Refresh details from the recovery services provider.", "description": "The operation to refresh the information from the recovery services provider.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "providerName", "in": "path", "description": "Recovery services provider name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryServicesProvider" } }, "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." } } } }, "x-ms-examples": { "Refresh details from the recovery services provider.": { "$ref": "./examples/ReplicationRecoveryServicesProviders_RefreshProvider.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryServicesProvider" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/remove": { "post": { "operationId": "ReplicationRecoveryServicesProviders_Delete", "tags": [ "ReplicationRecoveryServicesProviders" ], "summary": "Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object \"deleteRspInput\" is used (if the object is empty we assume that it is old client and continue the old behavior).", "description": "The operation to removes/delete(unregister) a recovery services provider from the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "providerName", "in": "path", "description": "Recovery services provider name.", "required": true, "type": "string" } ], "responses": { "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "There is no content to send for this request, but the headers may be useful." } }, "x-ms-examples": { "Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object \"deleteRspInput\" is used (if the object is empty we assume that it is old client and continue the old behavior).": { "$ref": "./examples/ReplicationRecoveryServicesProviders_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications": { "get": { "operationId": "ReplicationStorageClassifications_ListByReplicationFabrics", "tags": [ "ReplicationStorageClassifications" ], "summary": "Gets the list of storage classification objects under a fabric.", "description": "Lists the storage classifications available in the specified fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/StorageClassificationCollection" } } }, "x-ms-examples": { "Gets the list of storage classification objects under a fabric.": { "$ref": "./examples/ReplicationStorageClassifications_ListByReplicationFabrics.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}": { "get": { "operationId": "ReplicationStorageClassifications_Get", "tags": [ "ReplicationStorageClassifications" ], "summary": "Gets the details of a storage classification.", "description": "Gets the details of the specified storage classification.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "storageClassificationName", "in": "path", "description": "Storage classification name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/StorageClassification" } } }, "x-ms-examples": { "Gets the details of a storage classification.": { "$ref": "./examples/ReplicationStorageClassifications_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings": { "get": { "operationId": "ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications", "tags": [ "ReplicationStorageClassificationMappings" ], "summary": "Gets the list of storage classification mappings objects under a storage.", "description": "Lists the storage classification mappings for the fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "storageClassificationName", "in": "path", "description": "Storage classification name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/StorageClassificationMappingCollection" } } }, "x-ms-examples": { "Gets the list of storage classification mappings objects under a storage.": { "$ref": "./examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings/{storageClassificationMappingName}": { "get": { "operationId": "ReplicationStorageClassificationMappings_Get", "tags": [ "ReplicationStorageClassificationMappings" ], "summary": "Gets the details of a storage classification mapping.", "description": "Gets the details of the specified storage classification mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "storageClassificationName", "in": "path", "description": "Storage classification name.", "required": true, "type": "string" }, { "name": "storageClassificationMappingName", "in": "path", "description": "Storage classification mapping name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/StorageClassificationMapping" } } }, "x-ms-examples": { "Gets the details of a storage classification mapping.": { "$ref": "./examples/ReplicationStorageClassificationMappings_Get.json" } } }, "put": { "operationId": "ReplicationStorageClassificationMappings_Create", "tags": [ "ReplicationStorageClassificationMappings" ], "summary": "Create storage classification mapping.", "description": "The operation to create a storage classification mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "storageClassificationName", "in": "path", "description": "Storage classification name.", "required": true, "type": "string" }, { "name": "storageClassificationMappingName", "in": "path", "description": "Storage classification mapping name.", "required": true, "type": "string" }, { "name": "pairingInput", "in": "body", "description": "Pairing input.", "required": true, "schema": { "$ref": "#/definitions/StorageClassificationMappingInput" } } ], "responses": { "200": { "description": "Resource 'StorageClassificationMapping' update operation succeeded", "schema": { "$ref": "#/definitions/StorageClassificationMapping" } }, "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." } } } }, "x-ms-examples": { "Create storage classification mapping.": { "$ref": "./examples/ReplicationStorageClassificationMappings_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/StorageClassificationMapping" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationStorageClassificationMappings_Delete", "tags": [ "ReplicationStorageClassificationMappings" ], "summary": "Delete a storage classification mapping.", "description": "The operation to delete a storage classification mapping.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "storageClassificationName", "in": "path", "description": "Storage classification name.", "required": true, "type": "string" }, { "name": "storageClassificationMappingName", "in": "path", "description": "Storage classification mapping name.", "required": true, "type": "string" } ], "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." } }, "x-ms-examples": { "Delete a storage classification mapping.": { "$ref": "./examples/ReplicationStorageClassificationMappings_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters": { "get": { "operationId": "ReplicationvCenters_ListByReplicationFabrics", "tags": [ "ReplicationvCenters" ], "summary": "Gets the list of vCenter registered under a fabric.", "description": "Lists the vCenter servers registered in a fabric.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VCenterCollection" } } }, "x-ms-examples": { "Gets the list of vCenter registered under a fabric.": { "$ref": "./examples/ReplicationvCenters_ListByReplicationFabrics.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName}": { "get": { "operationId": "ReplicationvCenters_Get", "tags": [ "ReplicationvCenters" ], "summary": "Gets the details of a vCenter.", "description": "Gets the details of a registered vCenter server(Add vCenter server).", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "vcenterName", "in": "path", "description": "vcenter name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VCenter" } } }, "x-ms-examples": { "Gets the details of a vCenter.": { "$ref": "./examples/ReplicationvCenters_Get.json" } } }, "put": { "operationId": "ReplicationvCenters_Create", "tags": [ "ReplicationvCenters" ], "summary": "Add vCenter.", "description": "The operation to create a vCenter object..", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "vcenterName", "in": "path", "description": "vcenter name.", "required": true, "type": "string" }, { "name": "addVCenterRequest", "in": "body", "description": "The input to the add vCenter operation.", "required": true, "schema": { "$ref": "#/definitions/AddVCenterRequest" } } ], "responses": { "200": { "description": "Resource 'VCenter' update operation succeeded", "schema": { "$ref": "#/definitions/VCenter" } }, "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." } } } }, "x-ms-examples": { "Add vCenter.": { "$ref": "./examples/ReplicationvCenters_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/VCenter" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ReplicationvCenters_Update", "tags": [ "ReplicationvCenters" ], "summary": "Update vCenter operation.", "description": "The operation to update a registered vCenter.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "vcenterName", "in": "path", "description": "vcenter name.", "required": true, "type": "string" }, { "name": "updateVCenterRequest", "in": "body", "description": "The input to the update vCenter operation.", "required": true, "schema": { "$ref": "#/definitions/UpdateVCenterRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VCenter" } }, "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." } } } }, "x-ms-examples": { "Update vCenter operation.": { "$ref": "./examples/ReplicationvCenters_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/VCenter" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationvCenters_Delete", "tags": [ "ReplicationvCenters" ], "summary": "Remove vcenter operation.", "description": "The operation to remove(unregister) a registered vCenter server from the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "fabricName", "in": "path", "description": "Fabric name.", "required": true, "type": "string" }, { "name": "vcenterName", "in": "path", "description": "vcenter name.", "required": true, "type": "string" } ], "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." } }, "x-ms-examples": { "Remove vCenter operation.": { "$ref": "./examples/ReplicationvCenters_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs": { "get": { "operationId": "ReplicationJobs_List", "tags": [ "ReplicationJobs" ], "summary": "Gets the list of jobs.", "description": "Gets the list of Azure Site Recovery Jobs for the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "OData filter options.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobCollection" } } }, "x-ms-examples": { "Gets the list of jobs.": { "$ref": "./examples/ReplicationJobs_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}": { "get": { "operationId": "ReplicationJobs_Get", "tags": [ "ReplicationJobs" ], "summary": "Gets the job details.", "description": "Get the details of an Azure Site Recovery job.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "Job identifier.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Job" } } }, "x-ms-examples": { "Gets the job details.": { "$ref": "./examples/ReplicationJobs_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/cancel": { "post": { "operationId": "ReplicationJobs_Cancel", "tags": [ "ReplicationJobs" ], "summary": "Cancels the specified job.", "description": "The operation to cancel an Azure Site Recovery job.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "Job identifier.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Job" } }, "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." } } } }, "x-ms-examples": { "Cancels the specified job.": { "$ref": "./examples/ReplicationJobs_Cancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Job" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/restart": { "post": { "operationId": "ReplicationJobs_Restart", "tags": [ "ReplicationJobs" ], "summary": "Restarts the specified job.", "description": "The operation to restart an Azure Site Recovery job.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "Job identifier.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Job" } }, "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." } } } }, "x-ms-examples": { "Restarts the specified job.": { "$ref": "./examples/ReplicationJobs_Restart.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Job" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/resume": { "post": { "operationId": "ReplicationJobs_Resume", "tags": [ "ReplicationJobs" ], "summary": "Resumes the specified job.", "description": "The operation to resume an Azure Site Recovery job.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "jobName", "in": "path", "description": "Job identifier.", "required": true, "type": "string" }, { "name": "resumeJobParams", "in": "body", "description": "Resume rob comments.", "required": true, "schema": { "$ref": "#/definitions/ResumeJobParams" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Job" } }, "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." } } } }, "x-ms-examples": { "Resumes the specified job.": { "$ref": "./examples/ReplicationJobs_Resume.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Job" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/export": { "post": { "operationId": "ReplicationJobs_Export", "tags": [ "ReplicationJobs" ], "summary": "Exports the details of the Azure Site Recovery jobs of the vault.", "description": "The operation to export the details of the Azure Site Recovery jobs of the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" }, { "name": "jobQueryParameter", "in": "body", "description": "The request body", "required": true, "schema": { "$ref": "#/definitions/JobQueryParameter" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Job" } }, "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." } } } }, "x-ms-examples": { "Exports the details of the Azure Site Recovery jobs of the vault.": { "$ref": "./examples/ReplicationJobs_Export.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Job" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationMigrationItems": { "get": { "operationId": "ReplicationMigrationItems_List", "tags": [ "ReplicationMigrationItems" ], "summary": "Gets the list of migration items in the vault.", "description": "Gets the list of migration items in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" }, { "name": "skipToken", "in": "query", "description": "The pagination token.", "required": false, "type": "string" }, { "name": "takeToken", "in": "query", "description": "The page size.", "required": false, "type": "string" }, { "name": "$filter", "in": "query", "description": "OData filter options.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/MigrationItemCollection" } } }, "x-ms-examples": { "Gets the list of migration items in the vault.": { "$ref": "./examples/ReplicationMigrationItems_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworkMappings": { "get": { "operationId": "ReplicationNetworkMappings_List", "tags": [ "ReplicationNetworkMappings" ], "summary": "Gets all the network mappings under a vault.", "description": "Lists all ASR network mappings in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/NetworkMappingCollection" } } }, "x-ms-examples": { "Gets all the network mappings under a vault.": { "$ref": "./examples/ReplicationNetworkMappings_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworks": { "get": { "operationId": "ReplicationNetworks_List", "tags": [ "ReplicationNetworks" ], "summary": "Gets the list of networks. View-only API.", "description": "Lists the networks available in a vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/NetworkCollection" } } }, "x-ms-examples": { "Gets the list of networks. View-only API.": { "$ref": "./examples/ReplicationNetworks_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies": { "get": { "operationId": "ReplicationPolicies_List", "tags": [ "ReplicationPolicies" ], "summary": "Gets the list of replication policies.", "description": "Lists the replication policies for a vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PolicyCollection" } } }, "x-ms-examples": { "Gets the list of replication policies.": { "$ref": "./examples/ReplicationPolicies_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies/{policyName}": { "get": { "operationId": "ReplicationPolicies_Get", "tags": [ "ReplicationPolicies" ], "summary": "Gets the requested policy.", "description": "Gets the details of a replication policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "policyName", "in": "path", "description": "Replication policy name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Policy" } } }, "x-ms-examples": { "Gets the requested policy.": { "$ref": "./examples/ReplicationPolicies_Get.json" } } }, "put": { "operationId": "ReplicationPolicies_Create", "tags": [ "ReplicationPolicies" ], "summary": "Creates the policy.", "description": "The operation to create a replication policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "policyName", "in": "path", "description": "Replication policy name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Create policy input.", "required": true, "schema": { "$ref": "#/definitions/CreatePolicyInput" } } ], "responses": { "200": { "description": "Resource 'Policy' update operation succeeded", "schema": { "$ref": "#/definitions/Policy" } }, "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." } } } }, "x-ms-examples": { "Creates the policy.": { "$ref": "./examples/ReplicationPolicies_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Policy" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ReplicationPolicies_Update", "tags": [ "ReplicationPolicies" ], "summary": "Updates the policy.", "description": "The operation to update a replication policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "policyName", "in": "path", "description": "Replication policy name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Update Policy Input.", "required": true, "schema": { "$ref": "#/definitions/UpdatePolicyInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Policy" } }, "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." } } } }, "x-ms-examples": { "Updates the policy.": { "$ref": "./examples/ReplicationPolicies_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Policy" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationPolicies_Delete", "tags": [ "ReplicationPolicies" ], "summary": "Delete the policy.", "description": "The operation to delete a replication policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "policyName", "in": "path", "description": "Replication policy name.", "required": true, "type": "string" } ], "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." } }, "x-ms-examples": { "Delete the policy.": { "$ref": "./examples/ReplicationPolicies_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems": { "get": { "operationId": "ReplicationProtectedItems_List", "tags": [ "ReplicationProtectedItems" ], "summary": "Gets the list of replication protected items.", "description": "Gets the list of ASR replication protected items in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" }, { "name": "skipToken", "in": "query", "description": "The pagination token. Possible values: \"FabricId\" or \"FabricId_CloudId\" or null.", "required": false, "type": "string" }, { "name": "$filter", "in": "query", "description": "OData filter options.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ReplicationProtectedItemCollection" } } }, "x-ms-examples": { "Gets the list of replication protected items.": { "$ref": "./examples/ReplicationProtectedItems_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionClusters": { "get": { "operationId": "ReplicationProtectionClusters_List", "tags": [ "ReplicationProtectionClusters" ], "summary": "Gets the list of Replication protection clusters in vault.", "description": "Gets the list of ASR replication protected clusters in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9]$" }, { "name": "skipToken", "in": "query", "description": "The pagination token. Possible values: \"FabricId\" or \"FabricId_CloudId\" or null.", "required": false, "type": "string" }, { "name": "$filter", "in": "query", "description": "OData filter options.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ReplicationProtectionClusterCollection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the list of Replication protection clusters in vault.": { "$ref": "./examples/ReplicationProtectionClusters_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainerMappings": { "get": { "operationId": "ReplicationProtectionContainerMappings_List", "tags": [ "ReplicationProtectionContainerMappings" ], "summary": "Gets the list of all protection container mappings in a vault.", "description": "Lists the protection container mappings in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ProtectionContainerMappingCollection" } } }, "x-ms-examples": { "Gets the list of all protection container mappings in a vault.": { "$ref": "./examples/ReplicationProtectionContainerMappings_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainers": { "get": { "operationId": "ReplicationProtectionContainers_List", "tags": [ "ReplicationProtectionContainers" ], "summary": "Gets the list of all protection containers in a vault.", "description": "Lists the protection containers in a vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ProtectionContainerCollection" } } }, "x-ms-examples": { "Gets the list of all protection containers in a vault.": { "$ref": "./examples/ReplicationProtectionContainers_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents": { "get": { "operationId": "ReplicationProtectionIntents_List", "tags": [ "ReplicationProtectionIntents" ], "summary": "Gets the list of replication protection intent objects.", "description": "Gets the list of ASR replication protection intent objects in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "skipToken", "in": "query", "description": "The pagination token.", "required": false, "type": "string" }, { "name": "takeToken", "in": "query", "description": "The page size.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionIntentCollection" } } }, "x-ms-examples": { "Gets the list of replication protection intent objects.": { "$ref": "./examples/ReplicationProtectionIntents_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents/{intentObjectName}": { "get": { "operationId": "ReplicationProtectionIntents_Get", "tags": [ "ReplicationProtectionIntents" ], "summary": "Gets the details of a Replication protection intent item.", "description": "Gets the details of an ASR replication protection intent.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "intentObjectName", "in": "path", "description": "Replication protection intent name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ReplicationProtectionIntent" } } }, "x-ms-examples": { "Gets the details of a Replication protection intent item.": { "$ref": "./examples/ReplicationProtectionIntents_Get.json" } } }, "put": { "operationId": "ReplicationProtectionIntents_Create", "tags": [ "ReplicationProtectionIntents" ], "summary": "Create protection intent Resource.", "description": "The operation to create an ASR replication protection intent item.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "intentObjectName", "in": "path", "description": "Replication protection intent name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Create Protection Intent Input.", "required": true, "schema": { "$ref": "#/definitions/CreateProtectionIntentInput" } } ], "responses": { "200": { "description": "Resource 'ReplicationProtectionIntent' update operation succeeded", "schema": { "$ref": "#/definitions/ReplicationProtectionIntent" } } }, "x-ms-examples": { "Create protection intent Resource.": { "$ref": "./examples/ReplicationProtectionIntents_Create.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans": { "get": { "operationId": "ReplicationRecoveryPlans_List", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Gets the list of recovery plans.", "description": "Lists the recovery plans in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlanCollection" } } }, "x-ms-examples": { "Gets the list of recovery plans.": { "$ref": "./examples/ReplicationRecoveryPlans_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}": { "get": { "operationId": "ReplicationRecoveryPlans_Get", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Gets the requested recovery plan.", "description": "Gets the details of the recovery plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlan" } } }, "x-ms-examples": { "Gets the requested recovery plan.": { "$ref": "./examples/ReplicationRecoveryPlans_Get.json" } } }, "put": { "operationId": "ReplicationRecoveryPlans_Create", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Creates a recovery plan with the given details.", "description": "The operation to create a recovery plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Recovery Plan creation input.", "required": true, "schema": { "$ref": "#/definitions/CreateRecoveryPlanInput" } } ], "responses": { "200": { "description": "Resource 'RecoveryPlan' update operation succeeded", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "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." } } } }, "x-ms-examples": { "Creates a recovery plan with the given details.": { "$ref": "./examples/ReplicationRecoveryPlans_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryPlan" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ReplicationRecoveryPlans_Update", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Updates the given recovery plan.", "description": "The operation to update a recovery plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Update recovery plan input.", "required": true, "schema": { "$ref": "#/definitions/UpdateRecoveryPlanInput" } } ], "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." } } } }, "x-ms-examples": { "Updates the given recovery plan.": { "$ref": "./examples/ReplicationRecoveryPlans_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryPlan" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ReplicationRecoveryPlans_Delete", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Deletes the specified recovery plan.", "description": "Delete a recovery plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" } ], "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." } }, "x-ms-examples": { "Deletes the specified recovery plan.": { "$ref": "./examples/ReplicationRecoveryPlans_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCancel": { "post": { "operationId": "ReplicationRecoveryPlans_FailoverCancel", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Execute cancel failover of the recovery plan.", "description": "The operation to cancel the failover of a recovery plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "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." } } } }, "x-ms-examples": { "Execute cancel failover of the recovery plan.": { "$ref": "./examples/ReplicationRecoveryPlans_FailoverCancel.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryPlan" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCommit": { "post": { "operationId": "ReplicationRecoveryPlans_FailoverCommit", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Execute commit failover of the recovery plan.", "description": "The operation to commit the failover of a recovery plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "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." } } } }, "x-ms-examples": { "Execute commit failover of the recovery plan.": { "$ref": "./examples/ReplicationRecoveryPlans_FailoverCommit.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryPlan" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/plannedFailover": { "post": { "operationId": "ReplicationRecoveryPlans_PlannedFailover", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Execute planned failover of the recovery plan.", "description": "The operation to start the planned failover of a recovery plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Failover input.", "required": true, "schema": { "$ref": "#/definitions/RecoveryPlanPlannedFailoverInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "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." } } } }, "x-ms-examples": { "Execute planned failover of the recovery plan.": { "$ref": "./examples/ReplicationRecoveryPlans_PlannedFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryPlan" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/reProtect": { "post": { "operationId": "ReplicationRecoveryPlans_Reprotect", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Execute reprotect of the recovery plan.", "description": "The operation to reprotect(reverse replicate) a recovery plan. This api is for deprecated scenarios and no longer works.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "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." } } } }, "x-ms-examples": { "Execute reprotect of the recovery plan.": { "$ref": "./examples/ReplicationRecoveryPlans_Reprotect.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryPlan" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailover": { "post": { "operationId": "ReplicationRecoveryPlans_TestFailover", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Execute test failover of the recovery plan.", "description": "The operation to start the test failover of a recovery plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Recovery plan test failover input.", "required": true, "schema": { "$ref": "#/definitions/RecoveryPlanTestFailoverInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "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." } } } }, "x-ms-examples": { "Execute test failover of the recovery plan.": { "$ref": "./examples/ReplicationRecoveryPlans_TestFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryPlan" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailoverCleanup": { "post": { "operationId": "ReplicationRecoveryPlans_TestFailoverCleanup", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Execute test failover cleanup of the recovery plan.", "description": "The operation to cleanup test failover of a recovery plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Recovery plan test failover cleanup input.", "required": true, "schema": { "$ref": "#/definitions/RecoveryPlanTestFailoverCleanupInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "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." } } } }, "x-ms-examples": { "Execute test failover cleanup of the recovery plan.": { "$ref": "./examples/ReplicationRecoveryPlans_TestFailoverCleanup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryPlan" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/unplannedFailover": { "post": { "operationId": "ReplicationRecoveryPlans_UnplannedFailover", "tags": [ "ReplicationRecoveryPlans" ], "summary": "Execute unplanned failover of the recovery plan.", "description": "The operation to start the unplanned failover of a recovery plan.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "recoveryPlanName", "in": "path", "description": "Name of the recovery plan.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Recovery plan unplanned failover input.", "required": true, "schema": { "$ref": "#/definitions/RecoveryPlanUnplannedFailoverInput" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecoveryPlan" } }, "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." } } } }, "x-ms-examples": { "Execute unplanned failover of the recovery plan.": { "$ref": "./examples/ReplicationRecoveryPlans_UnplannedFailover.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/RecoveryPlan" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryServicesProviders": { "get": { "operationId": "ReplicationRecoveryServicesProviders_List", "tags": [ "ReplicationRecoveryServicesProviders" ], "summary": "Gets the list of registered recovery services providers in the vault. This is a view only api.", "description": "Lists the registered recovery services providers in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/RecoveryServicesProviderCollection" } } }, "x-ms-examples": { "Gets the list of registered recovery services providers in the vault. This is a view only api.": { "$ref": "./examples/ReplicationRecoveryServicesProviders_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassificationMappings": { "get": { "operationId": "ReplicationStorageClassificationMappings_List", "tags": [ "ReplicationStorageClassificationMappings" ], "summary": "Gets the list of storage classification mappings objects under a vault.", "description": "Lists the storage classification mappings in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StorageClassificationMappingCollection" } } }, "x-ms-examples": { "Gets the list of storage classification mappings objects under a vault.": { "$ref": "./examples/ReplicationStorageClassificationMappings_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassifications": { "get": { "operationId": "ReplicationStorageClassifications_List", "tags": [ "ReplicationStorageClassifications" ], "summary": "Gets the list of storage classification objects under a vault.", "description": "Lists the storage classifications in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/StorageClassificationCollection" } } }, "x-ms-examples": { "Gets the list of storage classification objects under a vault.": { "$ref": "./examples/ReplicationStorageClassifications_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationSupportedOperatingSystems": { "get": { "operationId": "SupportedOperatingSystems_Get", "tags": [ "SupportedOperatingSystems" ], "summary": "Gets the data of supported operating systems by SRS.", "description": "Gets the data of supported operating systems by SRS.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" }, { "name": "instanceType", "in": "query", "description": "The instance type.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/SupportedOperatingSystems" } } }, "x-ms-examples": { "Gets the data of supported operating systems by SRS.": { "$ref": "./examples/SupportedOperatingSystems_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth": { "get": { "operationId": "ReplicationVaultHealth_Get", "tags": [ "ReplicationVaultHealth" ], "summary": "Gets the health summary for the vault.", "description": "Gets the health details of the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/VaultHealthDetails" } } }, "x-ms-examples": { "Gets the health summary for the vault.": { "$ref": "./examples/ReplicationVaultHealth_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth/default/refresh": { "post": { "operationId": "ReplicationVaultHealth_Refresh", "tags": [ "ReplicationVaultHealth" ], "summary": "Refreshes health summary of the vault.", "description": "Refreshes health summary of the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/VaultHealthDetails" } }, "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." } } } }, "x-ms-examples": { "Refreshes health summary of the vault.": { "$ref": "./examples/ReplicationVaultHealth_Refresh.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/VaultHealthDetails" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings": { "get": { "operationId": "ReplicationVaultSetting_List", "tags": [ "ReplicationVaultSetting" ], "summary": "Gets the list of vault setting.", "description": "Gets the list of vault setting. This includes the Migration Hub connection settings.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VaultSettingCollection" } } }, "x-ms-examples": { "Gets the list of vault setting.": { "$ref": "./examples/ReplicationVaultSetting_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings/{vaultSettingName}": { "get": { "operationId": "ReplicationVaultSetting_Get", "tags": [ "ReplicationVaultSetting" ], "summary": "Gets the vault setting.", "description": "Gets the vault setting. This includes the Migration Hub connection settings.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "vaultSettingName", "in": "path", "description": "Vault setting name.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VaultSetting" } } }, "x-ms-examples": { "Gets the vault setting.": { "$ref": "./examples/ReplicationVaultSetting_Get.json" } } }, "put": { "operationId": "ReplicationVaultSetting_Create", "tags": [ "ReplicationVaultSetting" ], "summary": "Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.", "description": "The operation to configure vault setting.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the Vault", "required": true, "type": "string" }, { "name": "vaultSettingName", "in": "path", "description": "Vault setting name.", "required": true, "type": "string" }, { "name": "input", "in": "body", "description": "Vault setting creation input.", "required": true, "schema": { "$ref": "#/definitions/VaultSettingCreationInput" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/VaultSetting" }, "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." } } } }, "x-ms-examples": { "Updates vault setting with the A2A recovery network configuration auto-sync policy disabled.": { "$ref": "./examples/ReplicationVaultSetting_Create_Disabled.json" }, "Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.": { "$ref": "./examples/ReplicationVaultSetting_Create.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/VaultSetting" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationvCenters": { "get": { "operationId": "ReplicationvCenters_List", "tags": [ "ReplicationvCenters" ], "summary": "Gets the list of vCenter registered under the vault.", "description": "Lists the vCenter servers registered in the vault.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "resourceName", "in": "path", "description": "The name of the recovery services vault.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/VCenterCollection" } } }, "x-ms-examples": { "Gets the list of vCenter registered under the vault.": { "$ref": "./examples/ReplicationvCenters_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "A2AAddDisksInput": { "type": "object", "description": "A2A add disk(s) input.", "properties": { "vmDisks": { "type": "array", "description": "The list of vm disk details.", "items": { "$ref": "#/definitions/A2AVmDiskInputDetails" } }, "vmManagedDisks": { "type": "array", "description": "The list of vm managed disk details.", "items": { "$ref": "#/definitions/A2AVmManagedDiskInputDetails" } } }, "allOf": [ { "$ref": "#/definitions/AddDisksProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AAgentReinstallBlockingErrorDetails": { "type": "object", "description": "A2A source agent reinstall blocking error details.", "properties": { "errorCode": { "type": "string", "description": "error code." }, "errorMessage": { "type": "string", "description": "error message." }, "possibleCauses": { "type": "string", "description": "possible causes." }, "recommendedAction": { "type": "string", "description": "recommended action." }, "errorMessageParameters": { "type": "object", "description": "error message parameters.", "additionalProperties": { "type": "string" } }, "errorTags": { "type": "object", "description": "error tags.", "additionalProperties": { "type": "string" } } } }, "A2AApplyClusterRecoveryPointInput": { "type": "object", "description": "A2A provider specific input for apply cluster recovery point.", "allOf": [ { "$ref": "#/definitions/ApplyClusterRecoveryPointProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AApplyRecoveryPointInput": { "type": "object", "description": "ApplyRecoveryPoint input specific to A2A provider.", "allOf": [ { "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AClusterRecoveryPointDetails": { "type": "object", "description": "A2A provider specific cluster recovery point details.", "properties": { "recoveryPointSyncType": { "$ref": "#/definitions/RecoveryPointSyncType", "description": "A value indicating whether the recovery point is multi VM consistent." }, "nodes": { "type": "array", "description": "The list of nodes representing the cluster.", "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.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems" } ] } } } }, "allOf": [ { "$ref": "#/definitions/ClusterProviderSpecificRecoveryPointDetails" } ], "x-ms-discriminator-value": "A2A" }, "A2AClusterTestFailoverInput": { "type": "object", "description": "A2A provider specific input for test cluster failover.", "properties": { "clusterRecoveryPointId": { "type": "string", "format": "arm-id", "description": "The cluster recovery point id to be passed to failover to a particular recovery point.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters/recoveryPoints" } ] } }, "individualNodeRecoveryPoints": { "type": "array", "description": "The list of individual node recovery points.", "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.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems/recoveryPoints" } ] } } } }, "allOf": [ { "$ref": "#/definitions/ClusterTestFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AClusterUnplannedFailoverInput": { "type": "object", "description": "A2A provider specific input for unplanned cluster failover.", "properties": { "clusterRecoveryPointId": { "type": "string", "description": "The cluster recovery point id to be passed to failover to a particular recovery point." }, "individualNodeRecoveryPoints": { "type": "array", "description": "The list of individual node recovery points.", "items": { "type": "string" } } }, "allOf": [ { "$ref": "#/definitions/ClusterUnplannedFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AClusterVmManagedDiskInputDetails": { "type": "object", "description": "A2A managed disk input details for cluster switch protection.", "properties": { "diskId": { "type": "string", "description": "The disk Id." }, "primaryStagingAzureStorageAccountId": { "type": "string", "description": "The primary staging storage account Arm Id." }, "recoveryResourceGroupId": { "type": "string", "description": "The target resource group Arm Id." }, "recoveryReplicaDiskAccountType": { "type": "string", "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided." }, "recoveryTargetDiskAccountType": { "type": "string", "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided." }, "recoveryDiskEncryptionSetId": { "type": "string", "description": "The recovery disk encryption set Id." }, "diskEncryptionInfo": { "$ref": "#/definitions/DiskEncryptionInfo", "description": "The recovery disk encryption information (for one / single pass flows)." }, "recoveryNetworkAccessPolicy": { "$ref": "#/definitions/DiskNetworkAccessPolicy", "description": "The network access policy for the recovery managed disk." }, "recoveryDiskAccessId": { "type": "string", "description": "The recovery disk access Arm Id." }, "recoveryPublicNetworkAccess": { "$ref": "#/definitions/DiskPublicNetworkAccess", "description": "The public network access setting for the recovery managed disk." } }, "required": [ "diskId", "primaryStagingAzureStorageAccountId", "recoveryResourceGroupId" ] }, "A2AContainerCreationInput": { "type": "object", "description": "A2A cloud creation input.", "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AContainerMappingInput": { "type": "object", "description": "A2A container mapping input.", "properties": { "agentAutoUpdateStatus": { "$ref": "#/definitions/AgentAutoUpdateStatus", "description": "A value indicating whether the auto update is enabled." }, "automationAccountArmId": { "type": "string", "description": "The automation account arm id." }, "automationAccountAuthenticationType": { "type": "string", "description": "A value indicating the type authentication to use for automation Account.", "default": "RunAsAccount", "enum": [ "RunAsAccount", "SystemAssignedIdentity" ], "x-ms-enum": { "name": "AutomationAccountAuthenticationType", "modelAsString": true, "values": [ { "name": "RunAsAccount", "value": "RunAsAccount", "description": "RunAsAccount" }, { "name": "SystemAssignedIdentity", "value": "SystemAssignedIdentity", "description": "SystemAssignedIdentity" } ] } } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" } ], "x-ms-discriminator-value": "A2A" }, "A2ACreateProtectionIntentInput": { "type": "object", "description": "A2A create protection intent input.", "properties": { "fabricObjectId": { "type": "string", "description": "The fabric specific object Id of the virtual machine." }, "primaryLocation": { "type": "string", "description": "The primary location for the virtual machine." }, "recoveryLocation": { "type": "string", "description": "The recovery location for the virtual machine." }, "recoverySubscriptionId": { "type": "string", "description": "The recovery subscription Id of the virtual machine." }, "recoveryAvailabilityType": { "$ref": "#/definitions/A2ARecoveryAvailabilityType", "description": "The recovery availability type of the virtual machine." }, "protectionProfileCustomInput": { "$ref": "#/definitions/ProtectionProfileCustomDetails", "description": "The protection profile custom inputs." }, "recoveryResourceGroupId": { "type": "string", "description": "The recovery resource group Id. Valid for V2 scenarios." }, "primaryStagingStorageAccountCustomInput": { "$ref": "#/definitions/StorageAccountCustomDetails", "description": "The primary staging storage account input." }, "recoveryAvailabilitySetCustomInput": { "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails", "description": "The recovery availability set input." }, "recoveryVirtualNetworkCustomInput": { "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails", "description": "The recovery virtual network input." }, "recoveryProximityPlacementGroupCustomInput": { "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails", "description": "The recovery proximity placement group custom input." }, "autoProtectionOfDataDisk": { "$ref": "#/definitions/AutoProtectionOfDataDisk", "description": "A value indicating whether the auto protection is enabled." }, "vmDisks": { "type": "array", "description": "The list of vm disk inputs.", "items": { "$ref": "#/definitions/A2AProtectionIntentDiskInputDetails" } }, "vmManagedDisks": { "type": "array", "description": "The list of vm managed disk inputs.", "items": { "$ref": "#/definitions/A2AProtectionIntentManagedDiskInputDetails" } }, "multiVmGroupName": { "type": "string", "description": "The multi vm group name." }, "multiVmGroupId": { "type": "string", "description": "The multi vm group id." }, "recoveryBootDiagStorageAccount": { "$ref": "#/definitions/StorageAccountCustomDetails", "description": "The boot diagnostic storage account." }, "diskEncryptionInfo": { "$ref": "#/definitions/DiskEncryptionInfo", "description": "The recovery disk encryption information (for two pass flows)." }, "recoveryAvailabilityZone": { "type": "string", "description": "The recovery availability zone." }, "agentAutoUpdateStatus": { "$ref": "#/definitions/AgentAutoUpdateStatus", "description": "A value indicating whether the auto update is enabled." }, "automationAccountAuthenticationType": { "type": "string", "description": "A value indicating the authentication type for automation account. The default value is \"RunAsAccount\".", "default": "RunAsAccount", "enum": [ "RunAsAccount", "SystemAssignedIdentity" ], "x-ms-enum": { "name": "AutomationAccountAuthenticationType", "modelAsString": true, "values": [ { "name": "RunAsAccount", "value": "RunAsAccount", "description": "RunAsAccount" }, { "name": "SystemAssignedIdentity", "value": "SystemAssignedIdentity", "description": "SystemAssignedIdentity" } ] } }, "automationAccountArmId": { "type": "string", "description": "The automation account arm id." } }, "required": [ "fabricObjectId", "primaryLocation", "recoveryLocation", "recoverySubscriptionId", "recoveryAvailabilityType", "recoveryResourceGroupId" ], "allOf": [ { "$ref": "#/definitions/CreateProtectionIntentProviderSpecificDetails" } ], "x-ms-discriminator-value": "A2A" }, "A2ACrossClusterMigrationApplyRecoveryPointInput": { "type": "object", "description": "ApplyRecoveryPoint input specific to A2ACrossClusterMigration provider.", "allOf": [ { "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" } ], "x-ms-discriminator-value": "A2ACrossClusterMigration" }, "A2ACrossClusterMigrationContainerCreationInput": { "type": "object", "description": "A2ACrossClusterMigration cloud creation input.", "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" } ], "x-ms-discriminator-value": "A2ACrossClusterMigration" }, "A2ACrossClusterMigrationEnableProtectionInput": { "type": "object", "description": "A2A Cross-Cluster Migration enable protection input.", "properties": { "fabricObjectId": { "type": "string", "description": "The fabric specific object Id of the virtual machine." }, "recoveryContainerId": { "type": "string", "description": "The recovery container Id." } }, "allOf": [ { "$ref": "#/definitions/EnableProtectionProviderSpecificInput" } ], "x-ms-discriminator-value": "A2ACrossClusterMigration" }, "A2ACrossClusterMigrationPolicyCreationInput": { "type": "object", "description": "A2A Cross-Cluster Migration Policy creation input.", "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificInput" } ], "x-ms-discriminator-value": "A2ACrossClusterMigration" }, "A2ACrossClusterMigrationReplicationDetails": { "type": "object", "description": "A2A provider specific settings.", "properties": { "fabricObjectId": { "type": "string", "description": "The fabric specific object Id of the virtual machine." }, "primaryFabricLocation": { "type": "string", "description": "Primary fabric location." }, "osType": { "type": "string", "description": "The type of operating system." }, "vmProtectionState": { "type": "string", "description": "The protection state for the vm." }, "vmProtectionStateDescription": { "type": "string", "description": "The protection state description for the vm." }, "lifecycleId": { "type": "string", "description": "An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected item even though other internal Ids/ARM Id might be changing." } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "A2ACrossClusterMigration" }, "A2AEnableProtectionInput": { "type": "object", "description": "A2A enable protection input.", "properties": { "fabricObjectId": { "type": "string", "description": "The fabric specific object Id of the virtual machine." }, "recoveryContainerId": { "type": "string", "description": "The recovery container Id." }, "recoveryResourceGroupId": { "type": "string", "description": "The recovery resource group Id. Valid for V2 scenarios." }, "recoveryCloudServiceId": { "type": "string", "description": "The recovery cloud service Id. Valid for V1 scenarios." }, "recoveryAvailabilitySetId": { "type": "string", "description": "The recovery availability set Id." }, "recoveryProximityPlacementGroupId": { "type": "string", "description": "The recovery proximity placement group Id." }, "vmDisks": { "type": "array", "description": "The list of vm disk details.", "items": { "$ref": "#/definitions/A2AVmDiskInputDetails" } }, "vmManagedDisks": { "type": "array", "description": "The list of vm managed disk details.", "items": { "$ref": "#/definitions/A2AVmManagedDiskInputDetails" } }, "multiVmGroupName": { "type": "string", "description": "The multi vm group name." }, "multiVmGroupId": { "type": "string", "description": "The multi vm group id." }, "protectionClusterId": { "type": "string", "format": "arm-id", "description": "The replication protection cluster Id.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters" } ] } }, "recoveryBootDiagStorageAccountId": { "type": "string", "description": "The boot diagnostic storage account." }, "diskEncryptionInfo": { "$ref": "#/definitions/DiskEncryptionInfo", "description": "The recovery disk encryption information (for two pass flows)." }, "recoveryAvailabilityZone": { "type": "string", "description": "The recovery availability zone." }, "recoveryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The recovery extended location." }, "recoveryAzureNetworkId": { "type": "string", "description": "The recovery Azure virtual network ARM id." }, "recoverySubnetName": { "type": "string", "description": "The recovery subnet name." }, "recoveryVirtualMachineScaleSetId": { "type": "string", "description": "The virtual machine scale set Id." }, "recoveryCapacityReservationGroupId": { "type": "string", "description": "The recovery capacity reservation group Id." }, "platformFaultDomain": { "type": "integer", "format": "int32", "description": "the platform fault domain." }, "autoProtectionOfDataDisk": { "$ref": "#/definitions/AutoProtectionOfDataDisk", "description": "A value indicating whether the auto protection is enabled." }, "recoveryConfidentialDataDiskEncryptionIdentity": { "type": "string", "format": "arm-id", "description": "The Azure resource ID of the confidential data disk encryption user-assigned identity. Applicable to CMK confidential VM data disks.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ManagedIdentity/userAssignedIdentities" } ] } } }, "required": [ "fabricObjectId" ], "allOf": [ { "$ref": "#/definitions/EnableProtectionProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AEventDetails": { "type": "object", "description": "Model class for event details of a A2A event.", "properties": { "protectedItemName": { "type": "string", "description": "The protected item arm name." }, "fabricObjectId": { "type": "string", "description": "The azure vm arm id." }, "fabricName": { "type": "string", "description": "Fabric arm name." }, "fabricLocation": { "type": "string", "description": "The fabric location." }, "remoteFabricName": { "type": "string", "description": "Remote fabric arm name." }, "remoteFabricLocation": { "type": "string", "description": "Remote fabric location." } }, "allOf": [ { "$ref": "#/definitions/EventProviderSpecificDetails" } ], "x-ms-discriminator-value": "A2A" }, "A2AExtendedLocationDetails": { "type": "object", "description": "ExtendedLocation details data.", "properties": { "primaryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The primary ExtendedLocation." }, "recoveryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The recovery ExtendedLocation." } } }, "A2AFabricSpecificLocationDetails": { "type": "object", "description": "ExtendedLocation details data.", "properties": { "initialPrimaryZone": { "type": "string", "description": "The initial source zone info." }, "initialRecoveryZone": { "type": "string", "description": "The initial target zone info." }, "initialPrimaryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The initial primary ExtendedLocation." }, "initialRecoveryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The initial recovery ExtendedLocation." }, "initialPrimaryFabricLocation": { "type": "string", "description": "Initial primary fabric location info." }, "initialRecoveryFabricLocation": { "type": "string", "description": "The initial recovery fabric location info." }, "primaryZone": { "type": "string", "description": "Source zone info." }, "recoveryZone": { "type": "string", "description": "The target zone info." }, "primaryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The primary ExtendedLocation." }, "recoveryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The recovery ExtendedLocation." }, "primaryFabricLocation": { "type": "string", "description": "Primary fabric location info." }, "recoveryFabricLocation": { "type": "string", "description": "The recovery fabric location info." } } }, "A2APolicyCreationInput": { "type": "object", "description": "A2A Policy creation input.", "properties": { "recoveryPointHistory": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency (in minutes)." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency (in minutes)." }, "multiVmSyncStatus": { "$ref": "#/definitions/SetMultiVmSyncStatus", "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'." } }, "required": [ "multiVmSyncStatus" ], "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2APolicyDetails": { "type": "object", "description": "A2A specific policy details.", "properties": { "recoveryPointThresholdInMinutes": { "type": "integer", "format": "int32", "description": "The recovery point threshold in minutes." }, "recoveryPointHistory": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency in minutes." }, "multiVmSyncStatus": { "type": "string", "description": "A value indicating whether multi-VM sync has to be enabled." }, "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency in minutes." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "A2A" }, "A2AProtectedDiskDetails": { "type": "object", "description": "A2A protected disk details.", "properties": { "diskUri": { "type": "string", "description": "The disk uri." }, "recoveryAzureStorageAccountId": { "type": "string", "description": "The recovery disk storage account." }, "primaryDiskAzureStorageAccountId": { "type": "string", "description": "The primary disk storage account." }, "recoveryDiskUri": { "type": "string", "description": "Recovery disk uri." }, "diskName": { "type": "string", "description": "The disk name." }, "diskCapacityInBytes": { "type": "integer", "format": "int64", "description": "The disk capacity in bytes." }, "primaryStagingAzureStorageAccountId": { "type": "string", "description": "The primary staging storage account." }, "diskType": { "type": "string", "description": "The type of disk." }, "resyncRequired": { "type": "boolean", "description": "A value indicating whether resync is required for this disk." }, "monitoringPercentageCompletion": { "type": "integer", "format": "int32", "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property." }, "monitoringJobType": { "type": "string", "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property." }, "dataPendingInStagingStorageAccountInMB": { "type": "number", "format": "double", "description": "The data pending for replication in MB at staging account." }, "dataPendingAtSourceAgentInMB": { "type": "number", "format": "double", "description": "The data pending at source virtual machine in MB." }, "diskState": { "type": "string", "description": "The disk state." }, "allowedDiskLevelOperation": { "type": "array", "description": "The disk level operations list.", "items": { "type": "string" } }, "isDiskEncrypted": { "type": "boolean", "description": "A value indicating whether vm has encrypted os disk or not." }, "secretIdentifier": { "type": "string", "description": "The secret URL / identifier (BEK)." }, "dekKeyVaultArmId": { "type": "string", "description": "The KeyVault resource id for secret (BEK)." }, "isDiskKeyEncrypted": { "type": "boolean", "description": "A value indicating whether disk key got encrypted or not." }, "keyIdentifier": { "type": "string", "description": "The key URL / identifier (KEK)." }, "kekKeyVaultArmId": { "type": "string", "description": "The KeyVault resource id for key (KEK)." }, "failoverDiskName": { "type": "string", "description": "The failover name for the managed disk." }, "tfoDiskName": { "type": "string", "description": "The test failover name for the managed disk." } } }, "A2AProtectedItemDetail": { "type": "object", "description": "A2A specific switch cluster protection input.", "properties": { "vmManagedDisks": { "type": "array", "description": "The list of vm managed disk details.", "items": { "$ref": "#/definitions/A2AClusterVmManagedDiskInputDetails" } }, "recoveryResourceGroupId": { "type": "string", "description": "The recovery resource group Id." }, "recoveryAvailabilitySetId": { "type": "string", "description": "The recovery availability set." }, "recoveryBootDiagStorageAccountId": { "type": "string", "description": "The boot diagnostic storage account." }, "recoveryAvailabilityZone": { "type": "string", "description": "The recovery availability zone." }, "recoveryProximityPlacementGroupId": { "type": "string", "description": "The recovery proximity placement group Id." }, "recoveryVirtualMachineScaleSetId": { "type": "string", "description": "The virtual machine scale set id." }, "recoveryCapacityReservationGroupId": { "type": "string", "description": "The recovery capacity reservation group Id." }, "diskEncryptionInfo": { "$ref": "#/definitions/DiskEncryptionInfo", "description": "The recovery disk encryption information." }, "replicationProtectedItemName": { "type": "string", "description": "The Replication Protected item name." } } }, "A2AProtectedManagedDiskDetails": { "type": "object", "description": "A2A protected managed disk details.", "properties": { "diskId": { "type": "string", "description": "The managed disk Arm id." }, "recoveryResourceGroupId": { "type": "string", "description": "The recovery disk resource group Arm Id." }, "recoveryTargetDiskId": { "type": "string", "description": "Recovery target disk Arm Id." }, "recoveryReplicaDiskId": { "type": "string", "description": "Recovery replica disk Arm Id." }, "recoveryOrignalTargetDiskId": { "type": "string", "description": "Recovery original target disk Arm Id." }, "recoveryReplicaDiskAccountType": { "type": "string", "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided." }, "recoveryTargetDiskAccountType": { "type": "string", "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided." }, "recoveryDiskEncryptionSetId": { "type": "string", "description": "The recovery disk encryption set Id." }, "primaryDiskEncryptionSetId": { "type": "string", "description": "The primary disk encryption set Id." }, "diskName": { "type": "string", "description": "The disk name." }, "diskCapacityInBytes": { "type": "integer", "format": "int64", "description": "The disk capacity in bytes." }, "primaryStagingAzureStorageAccountId": { "type": "string", "description": "The primary staging storage account." }, "diskType": { "type": "string", "description": "The type of disk." }, "resyncRequired": { "type": "boolean", "description": "A value indicating whether resync is required for this disk." }, "monitoringPercentageCompletion": { "type": "integer", "format": "int32", "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property." }, "monitoringJobType": { "type": "string", "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property." }, "dataPendingInStagingStorageAccountInMB": { "type": "number", "format": "double", "description": "The data pending for replication in MB at staging account." }, "dataPendingAtSourceAgentInMB": { "type": "number", "format": "double", "description": "The data pending at source virtual machine in MB." }, "diskState": { "type": "string", "description": "The disk state." }, "allowedDiskLevelOperation": { "type": "array", "description": "The disk level operations list.", "items": { "type": "string" } }, "isDiskEncrypted": { "type": "boolean", "description": "A value indicating whether vm has encrypted os disk or not." }, "secretIdentifier": { "type": "string", "description": "The secret URL / identifier (BEK)." }, "dekKeyVaultArmId": { "type": "string", "description": "The KeyVault resource id for secret (BEK)." }, "isDiskKeyEncrypted": { "type": "boolean", "description": "A value indicating whether disk key got encrypted or not." }, "keyIdentifier": { "type": "string", "description": "The key URL / identifier (KEK)." }, "kekKeyVaultArmId": { "type": "string", "description": "The KeyVault resource id for key (KEK)." }, "failoverDiskName": { "type": "string", "description": "The failover name for the managed disk." }, "tfoDiskName": { "type": "string", "description": "The test failover name for the managed disk." }, "recoveryNetworkAccessPolicy": { "$ref": "#/definitions/DiskNetworkAccessPolicy", "description": "The network access policy for the recovery managed disk." }, "recoveryDiskAccessId": { "type": "string", "description": "The recovery disk access Arm Id." }, "recoveryPublicNetworkAccess": { "$ref": "#/definitions/DiskPublicNetworkAccess", "description": "The public network access setting for the recovery managed disk." }, "confidentialDiskEncryptionInfo": { "$ref": "#/definitions/ConfidentialDiskEncryptionInfo", "description": "The confidential disk encryption info for the managed disk. Applicable to CMK confidential VMs.", "readOnly": true } } }, "A2AProtectionContainerMappingDetails": { "type": "object", "description": "A2A provider specific settings.", "properties": { "agentAutoUpdateStatus": { "$ref": "#/definitions/AgentAutoUpdateStatus", "description": "A value indicating whether the auto update is enabled." }, "automationAccountArmId": { "type": "string", "description": "The automation account arm id." }, "automationAccountAuthenticationType": { "type": "string", "description": "A value indicating the type authentication to use for automation Account.", "default": "RunAsAccount", "enum": [ "RunAsAccount", "SystemAssignedIdentity" ], "x-ms-enum": { "name": "AutomationAccountAuthenticationType", "modelAsString": true, "values": [ { "name": "RunAsAccount", "value": "RunAsAccount", "description": "RunAsAccount" }, { "name": "SystemAssignedIdentity", "value": "SystemAssignedIdentity", "description": "SystemAssignedIdentity" } ] } }, "scheduleName": { "type": "string", "description": "The schedule arm name." }, "jobScheduleName": { "type": "string", "description": "The job schedule arm name." } }, "allOf": [ { "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" } ], "x-ms-discriminator-value": "A2A" }, "A2AProtectionIntentDiskInputDetails": { "type": "object", "description": "Azure VM unmanaged disk input details.", "properties": { "diskUri": { "type": "string", "description": "The disk Uri." }, "recoveryAzureStorageAccountCustomInput": { "$ref": "#/definitions/StorageAccountCustomDetails", "description": "The recovery VHD storage account input." }, "primaryStagingStorageAccountCustomInput": { "$ref": "#/definitions/StorageAccountCustomDetails", "description": "The primary staging storage account input." } }, "required": [ "diskUri" ] }, "A2AProtectionIntentManagedDiskInputDetails": { "type": "object", "description": "Azure VM managed disk input details.", "properties": { "diskId": { "type": "string", "description": "The disk Id." }, "primaryStagingStorageAccountCustomInput": { "$ref": "#/definitions/StorageAccountCustomDetails", "description": "The primary staging storage account input." }, "recoveryResourceGroupCustomInput": { "$ref": "#/definitions/RecoveryResourceGroupCustomDetails", "description": "The recovery resource group input." }, "recoveryReplicaDiskAccountType": { "type": "string", "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided." }, "recoveryTargetDiskAccountType": { "type": "string", "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided." }, "recoveryDiskEncryptionSetId": { "type": "string", "description": "The recovery disk encryption set Id." }, "diskEncryptionInfo": { "$ref": "#/definitions/DiskEncryptionInfo", "description": "The recovery disk encryption information (for one / single pass flows)." } }, "required": [ "diskId" ] }, "A2ARecoveryAvailabilityType": { "type": "string", "description": "The recovery availability type of the virtual machine.", "enum": [ "Single", "AvailabilitySet", "AvailabilityZone" ], "x-ms-enum": { "name": "A2ARecoveryAvailabilityType", "modelAsString": true, "values": [ { "name": "Single", "value": "Single", "description": "Single" }, { "name": "AvailabilitySet", "value": "AvailabilitySet", "description": "AvailabilitySet" }, { "name": "AvailabilityZone", "value": "AvailabilityZone", "description": "AvailabilityZone" } ] } }, "A2ARecoveryPointDetails": { "type": "object", "description": "A2A provider specific recovery point details.", "properties": { "recoveryPointSyncType": { "$ref": "#/definitions/RecoveryPointSyncType", "description": "A value indicating whether the recovery point is multi VM consistent." }, "disks": { "type": "array", "description": "List of disk ids representing a recovery point.", "items": { "type": "string" } } }, "allOf": [ { "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" } ], "x-ms-discriminator-value": "A2A" }, "A2ARemoveDisksInput": { "type": "object", "description": "A2A remove disk(s) input.", "properties": { "vmDisksUris": { "type": "array", "description": "The list of vm disk vhd URIs.", "items": { "type": "string" } }, "vmManagedDisksIds": { "type": "array", "description": "The list of vm managed disk Ids.", "items": { "type": "string" } } }, "allOf": [ { "$ref": "#/definitions/RemoveDisksProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AReplicationDetails": { "type": "object", "description": "A2A provider specific settings.", "properties": { "fabricObjectId": { "type": "string", "description": "The fabric specific object Id of the virtual machine." }, "initialPrimaryZone": { "type": "string", "description": "The initial primary availability zone.", "readOnly": true }, "initialPrimaryFabricLocation": { "type": "string", "description": "The initial primary fabric location.", "readOnly": true }, "initialRecoveryZone": { "type": "string", "description": "The initial recovery availability zone.", "readOnly": true }, "initialPrimaryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The initial primary extended location." }, "initialRecoveryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The initial recovery extended location." }, "initialRecoveryFabricLocation": { "type": "string", "description": "The initial recovery fabric location.", "readOnly": true }, "multiVmGroupId": { "type": "string", "description": "The multi vm group Id." }, "multiVmGroupName": { "type": "string", "description": "The multi vm group name." }, "multiVmGroupCreateOption": { "$ref": "#/definitions/MultiVmGroupCreateOption", "description": "Whether Multi VM group is auto created or specified by user." }, "managementId": { "type": "string", "description": "The management Id." }, "protectionClusterId": { "type": "string", "description": "The replication protection cluster Id." }, "isClusterInfraReady": { "type": "boolean", "description": "A value indicating if the cluster infra is ready or not." }, "protectedDisks": { "type": "array", "description": "The list of protected disks.", "items": { "$ref": "#/definitions/A2AProtectedDiskDetails" } }, "unprotectedDisks": { "type": "array", "description": "The list of unprotected disks.", "items": { "$ref": "#/definitions/A2AUnprotectedDiskDetails" } }, "protectedManagedDisks": { "type": "array", "description": "The list of protected managed disks.", "items": { "$ref": "#/definitions/A2AProtectedManagedDiskDetails" } }, "recoveryBootDiagStorageAccountId": { "type": "string", "description": "The recovery boot diagnostic storage account Arm Id." }, "primaryFabricLocation": { "type": "string", "description": "Primary fabric location." }, "recoveryFabricLocation": { "type": "string", "description": "The recovery fabric location." }, "osType": { "type": "string", "description": "The type of operating system." }, "recoveryAzureVMSize": { "type": "string", "description": "The size of recovery virtual machine." }, "recoveryAzureVMName": { "type": "string", "description": "The name of recovery virtual machine." }, "recoveryAzureResourceGroupId": { "type": "string", "description": "The recovery resource group." }, "recoveryCloudService": { "type": "string", "description": "The recovery cloud service." }, "recoveryAvailabilitySet": { "type": "string", "description": "The recovery availability set." }, "selectedRecoveryAzureNetworkId": { "type": "string", "description": "The recovery virtual network." }, "selectedTfoAzureNetworkId": { "type": "string", "description": "The test failover virtual network." }, "vmNics": { "type": "array", "description": "The virtual machine nic details.", "items": { "$ref": "#/definitions/VMNicDetails" } }, "vmSyncedConfigDetails": { "$ref": "#/definitions/AzureToAzureVmSyncedConfigDetails", "description": "The synced configuration details." }, "monitoringPercentageCompletion": { "type": "integer", "format": "int32", "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property." }, "monitoringJobType": { "type": "string", "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property." }, "lastHeartbeat": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the source server." }, "agentVersion": { "type": "string", "description": "The agent version." }, "agentExpiryDate": { "type": "string", "format": "date-time", "description": "Agent expiry date." }, "isReplicationAgentUpdateRequired": { "type": "boolean", "description": "A value indicating whether replication agent update is required." }, "agentCertificateExpiryDate": { "type": "string", "format": "date-time", "description": "Agent certificate expiry date.", "readOnly": true }, "isReplicationAgentCertificateUpdateRequired": { "type": "boolean", "description": "A value indicating whether agent certificate update is required." }, "recoveryFabricObjectId": { "type": "string", "description": "The recovery fabric object Id." }, "vmProtectionState": { "type": "string", "description": "The protection state for the vm." }, "vmProtectionStateDescription": { "type": "string", "description": "The protection state description for the vm." }, "lifecycleId": { "type": "string", "description": "An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected item even though other internal Ids/ARM Id might be changing." }, "testFailoverRecoveryFabricObjectId": { "type": "string", "description": "The test failover fabric object Id." }, "rpoInSeconds": { "type": "integer", "format": "int64", "description": "The last RPO value in seconds." }, "lastRpoCalculatedTime": { "type": "string", "format": "date-time", "description": "The time (in UTC) when the last RPO value was calculated by Protection Service." }, "primaryAvailabilityZone": { "type": "string", "description": "The primary availability zone." }, "recoveryAvailabilityZone": { "type": "string", "description": "The recovery availability zone." }, "primaryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The primary Extended Location." }, "recoveryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The recovery Extended Location." }, "vmEncryptionType": { "$ref": "#/definitions/VmEncryptionType", "description": "The encryption type of the VM.", "readOnly": true }, "tfoAzureVMName": { "type": "string", "description": "The test failover vm name." }, "recoveryAzureGeneration": { "type": "string", "description": "The recovery azure generation.", "readOnly": true }, "recoveryProximityPlacementGroupId": { "type": "string", "description": "The recovery proximity placement group Id." }, "autoProtectionOfDataDisk": { "$ref": "#/definitions/AutoProtectionOfDataDisk", "description": "A value indicating whether the auto protection is enabled." }, "recoveryVirtualMachineScaleSetId": { "type": "string", "description": "The recovery virtual machine scale set id." }, "recoveryCapacityReservationGroupId": { "type": "string", "description": "The recovery capacity reservation group Id." }, "churnOptionSelected": { "$ref": "#/definitions/ChurnOptionSelected", "description": "A value indicating the churn option selected by user.", "readOnly": true }, "agentReinstallAttemptToVersion": { "type": "string", "description": "The agent version to which last agent reinstall was attempted." }, "osFamilyName": { "type": "string", "description": "The OS family name." }, "distroName": { "type": "string", "description": "The distro name." }, "distroNameForWhichAgentIsInstalled": { "type": "string", "description": "The agent os name last agent reinstall was attempted." }, "isAgentUpgradeable": { "type": "boolean", "description": "A value indicating whether replication agent upgradeable." }, "isAgentReinstallRequired": { "type": "boolean", "description": "A value indicating whether replication agent reinstallation is required." }, "reasonsBlockingReInstall": { "type": "string", "description": "value for reason blocking reinstall." }, "reasonsBlockingReinstallDetails": { "type": "array", "description": "whether reinstall is possible or not.", "items": { "$ref": "#/definitions/A2AAgentReinstallBlockingErrorDetails" } }, "isAgentUpgradeInProgress": { "type": "boolean", "description": "A value indicating whether replication agent Upgrade is In-Progress." }, "autoAgentUpgradeRetryCount": { "type": "integer", "format": "int64", "description": "auto agent upgrade retry count." }, "isAgentUpgradeRetryThresholdExhausted": { "type": "boolean", "description": "A value indicating whether replication agent Upgrade retry exhausted." }, "platformFaultDomain": { "type": "integer", "format": "int32", "description": "the platform fault domain." }, "recoveryConfidentialDataDiskEncryptionIdentity": { "type": "string", "format": "arm-id", "description": "The Azure resource ID of the confidential data disk encryption user-assigned identity. Applicable to CMK confidential VM data disks.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ManagedIdentity/userAssignedIdentities" } ] } } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "A2A" }, "A2AReplicationIntentDetails": { "type": "object", "description": "A2A provider specific settings.", "properties": { "fabricObjectId": { "type": "string", "description": "The fabric specific object Id of the virtual machine." }, "primaryLocation": { "type": "string", "description": "The primary location for the virtual machine." }, "recoveryLocation": { "type": "string", "description": "The recovery location for the virtual machine." }, "recoverySubscriptionId": { "type": "string", "description": "The recovery subscription Id of the virtual machine." }, "vmDisks": { "type": "array", "description": "The list of vm disk details.", "items": { "$ref": "#/definitions/A2AProtectionIntentDiskInputDetails" } }, "vmManagedDisks": { "type": "array", "description": "The list of vm managed disk details.", "items": { "$ref": "#/definitions/A2AProtectionIntentManagedDiskInputDetails" } }, "recoveryResourceGroupId": { "type": "string", "description": "The recovery resource group id." }, "protectionProfile": { "$ref": "#/definitions/ProtectionProfileCustomDetails", "description": "The protection profile custom details." }, "primaryStagingStorageAccount": { "$ref": "#/definitions/StorageAccountCustomDetails", "description": "The primary staging storage account details." }, "recoveryAvailabilitySet": { "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails", "description": "The recovery availability set details." }, "recoveryVirtualNetwork": { "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails", "description": "The recovery virtual network details." }, "recoveryProximityPlacementGroup": { "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails", "description": "The recovery proximity placement group custom details." }, "autoProtectionOfDataDisk": { "$ref": "#/definitions/AutoProtectionOfDataDisk", "description": "A value indicating whether the auto protection is enabled." }, "multiVmGroupName": { "type": "string", "description": "The multi vm group name." }, "multiVmGroupId": { "type": "string", "description": "The multi vm group id." }, "recoveryBootDiagStorageAccount": { "$ref": "#/definitions/StorageAccountCustomDetails", "description": "The boot diagnostic storage account." }, "diskEncryptionInfo": { "$ref": "#/definitions/DiskEncryptionInfo", "description": "The recovery disk encryption information (for two pass flows)." }, "recoveryAvailabilityZone": { "type": "string", "description": "The recovery availability zone." }, "recoveryAvailabilityType": { "type": "string", "description": "The recovery availability type of the virtual machine." }, "agentAutoUpdateStatus": { "$ref": "#/definitions/AgentAutoUpdateStatus", "description": "A value indicating whether the auto update is enabled." }, "automationAccountArmId": { "type": "string", "description": "The automation account arm id." }, "automationAccountAuthenticationType": { "type": "string", "description": "A value indicating the type authentication to use for automation Account.", "default": "RunAsAccount", "enum": [ "RunAsAccount", "SystemAssignedIdentity" ], "x-ms-enum": { "name": "AutomationAccountAuthenticationType", "modelAsString": true, "values": [ { "name": "RunAsAccount", "value": "RunAsAccount", "description": "RunAsAccount" }, { "name": "SystemAssignedIdentity", "value": "SystemAssignedIdentity", "description": "SystemAssignedIdentity" } ] } } }, "required": [ "recoveryAvailabilityType" ], "allOf": [ { "$ref": "#/definitions/ReplicationProtectionIntentProviderSpecificSettings" } ], "x-ms-discriminator-value": "A2A" }, "A2AReplicationProtectionClusterDetails": { "type": "object", "description": "A2A provider specific settings.", "properties": { "multiVmGroupId": { "type": "string", "description": "The multi vm group Id." }, "multiVmGroupName": { "type": "string", "description": "The multi vm group name." }, "multiVmGroupCreateOption": { "$ref": "#/definitions/MultiVmGroupCreateOption", "description": "Whether Multi VM group is auto created or specified by user." }, "primaryFabricLocation": { "type": "string", "description": "Primary fabric location." }, "recoveryFabricLocation": { "type": "string", "description": "The recovery fabric location." }, "failoverRecoveryPointId": { "type": "string", "description": "The recovery point Id to which the cluster was failed over." }, "clusterManagementId": { "type": "string", "description": "The cluster management Id." }, "rpoInSeconds": { "type": "integer", "format": "int64", "description": "The last RPO value in seconds." }, "lastRpoCalculatedTime": { "type": "string", "format": "date-time", "description": "The time (in UTC) when the last RPO value was calculated by Protection Service." }, "initialPrimaryZone": { "type": "string", "description": "The initial primary availability zone." }, "initialPrimaryFabricLocation": { "type": "string", "description": "The initial primary fabric location." }, "initialRecoveryZone": { "type": "string", "description": "The initial recovery availability zone." }, "initialRecoveryFabricLocation": { "type": "string", "description": "The initial recovery fabric location." }, "initialPrimaryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The initial primary extended location." }, "initialRecoveryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The initial recovery extended location." }, "primaryAvailabilityZone": { "type": "string", "description": "The primary availability zone." }, "recoveryAvailabilityZone": { "type": "string", "description": "The recovery availability zone." }, "primaryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The primary Extended Location." }, "recoveryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The recovery Extended Location." }, "lifecycleId": { "type": "string", "description": "An id that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the \"same\" protected cluster even though other internal Ids/ARM Id might be changing." } }, "allOf": [ { "$ref": "#/definitions/ReplicationClusterProviderSpecificSettings" } ], "x-ms-discriminator-value": "A2A" }, "A2AReprotectInput": { "type": "object", "description": "Azure specific reprotect input.", "properties": { "recoveryContainerId": { "type": "string", "description": "The recovery container Id." }, "vmDisks": { "type": "array", "description": "The list of vm disk details.", "items": { "$ref": "#/definitions/A2AVmDiskInputDetails" } }, "recoveryResourceGroupId": { "type": "string", "description": "The recovery resource group Id. Valid for V2 scenarios." }, "recoveryCloudServiceId": { "type": "string", "description": "The recovery cloud service Id. Valid for V1 scenarios." }, "recoveryAvailabilitySetId": { "type": "string", "description": "The recovery availability set." }, "policyId": { "type": "string", "description": "The Policy Id." } }, "allOf": [ { "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2ARpRecoveryPointType": { "type": "string", "description": "The recovery point type.", "enum": [ "Latest", "LatestApplicationConsistent", "LatestCrashConsistent", "LatestProcessed" ], "x-ms-enum": { "name": "A2ARpRecoveryPointType", "modelAsString": true, "values": [ { "name": "Latest", "value": "Latest", "description": "Latest" }, { "name": "LatestApplicationConsistent", "value": "LatestApplicationConsistent", "description": "LatestApplicationConsistent" }, { "name": "LatestCrashConsistent", "value": "LatestCrashConsistent", "description": "LatestCrashConsistent" }, { "name": "LatestProcessed", "value": "LatestProcessed", "description": "LatestProcessed" } ] } }, "A2ASharedDiskIRErrorDetails": { "type": "object", "description": "Extended location of the resource.", "properties": { "errorCode": { "type": "string", "description": "The error code.", "readOnly": true }, "errorCodeEnum": { "type": "string", "description": "The error code enum.", "readOnly": true }, "errorMessage": { "type": "string", "description": "The error message.", "readOnly": true }, "possibleCauses": { "type": "string", "description": "The possible causes.", "readOnly": true }, "recommendedAction": { "type": "string", "description": "The recommended action.", "readOnly": true } } }, "A2ASharedDiskReplicationDetails": { "type": "object", "description": "A2A provider specific settings.", "properties": { "managementId": { "type": "string", "description": "The management Id." }, "unprotectedDisks": { "type": "array", "description": "The list of unprotected disks.", "items": { "$ref": "#/definitions/A2AUnprotectedDiskDetails" }, "x-ms-identifiers": [ "diskLunId" ] }, "protectedManagedDisks": { "type": "array", "description": "The list of protected managed disks.", "items": { "$ref": "#/definitions/A2AProtectedManagedDiskDetails" }, "x-ms-identifiers": [ "diskId" ] }, "primaryFabricLocation": { "type": "string", "description": "Primary fabric location." }, "recoveryFabricLocation": { "type": "string", "description": "The recovery fabric location." }, "failoverRecoveryPointId": { "type": "string", "description": "The recovery point id to which the Virtual node was failed over." }, "monitoringPercentageCompletion": { "type": "integer", "format": "int32", "description": "The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property." }, "monitoringJobType": { "type": "string", "description": "The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property." }, "rpoInSeconds": { "type": "integer", "format": "int64", "description": "The last RPO value in seconds." }, "lastRpoCalculatedTime": { "type": "string", "format": "date-time", "description": "The time (in UTC) when the last RPO value was calculated by Protection Service." }, "sharedDiskIRErrors": { "type": "array", "description": "The IR Errors.", "items": { "$ref": "#/definitions/A2ASharedDiskIRErrorDetails" }, "x-ms-identifiers": [ "errorCode" ] } }, "allOf": [ { "$ref": "#/definitions/SharedDiskReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "A2A" }, "A2ASwitchClusterProtectionInput": { "type": "object", "description": "A2A specific switch cluster protection input.", "properties": { "recoveryContainerId": { "type": "string", "description": "The recovery container Id." }, "policyId": { "type": "string", "description": "The Policy Id." }, "protectedItemsDetail": { "type": "array", "items": { "$ref": "#/definitions/A2AProtectedItemDetail" }, "x-ms-identifiers": [ "replicationProtectedItemName" ] } }, "allOf": [ { "$ref": "#/definitions/SwitchClusterProtectionProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2ASwitchProtectionInput": { "type": "object", "description": "A2A specific switch protection input.", "properties": { "recoveryContainerId": { "type": "string", "description": "The recovery container Id." }, "vmDisks": { "type": "array", "description": "The list of vm disk details.", "items": { "$ref": "#/definitions/A2AVmDiskInputDetails" } }, "vmManagedDisks": { "type": "array", "description": "The list of vm managed disk details.", "items": { "$ref": "#/definitions/A2AVmManagedDiskInputDetails" } }, "recoveryResourceGroupId": { "type": "string", "description": "The recovery resource group Id. Valid for V2 scenarios." }, "recoveryCloudServiceId": { "type": "string", "description": "The recovery cloud service Id. Valid for V1 scenarios." }, "recoveryAvailabilitySetId": { "type": "string", "description": "The recovery availability set." }, "policyId": { "type": "string", "description": "The Policy Id." }, "recoveryBootDiagStorageAccountId": { "type": "string", "description": "The boot diagnostic storage account." }, "recoveryAvailabilityZone": { "type": "string", "description": "The recovery availability zone." }, "recoveryProximityPlacementGroupId": { "type": "string", "description": "The recovery proximity placement group Id." }, "recoveryVirtualMachineScaleSetId": { "type": "string", "description": "The virtual machine scale set id." }, "recoveryCapacityReservationGroupId": { "type": "string", "description": "The recovery capacity reservation group Id." }, "platformFaultDomain": { "type": "integer", "format": "int32", "description": "the platform fault domain." }, "diskEncryptionInfo": { "$ref": "#/definitions/DiskEncryptionInfo", "description": "The recovery disk encryption information." }, "recoveryConfidentialDataDiskEncryptionIdentity": { "type": "string", "format": "arm-id", "description": "The Azure resource ID of the confidential data disk encryption user-assigned identity. Applicable to CMK confidential VM data disks.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ManagedIdentity/userAssignedIdentities" } ] } } }, "allOf": [ { "$ref": "#/definitions/SwitchProtectionProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2ATestFailoverInput": { "type": "object", "description": "A2A provider specific input for test failover.", "properties": { "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed." }, "cloudServiceCreationOption": { "type": "string", "description": "A value indicating whether to use recovery cloud service for TFO or not." } }, "allOf": [ { "$ref": "#/definitions/TestFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AUnplannedFailoverInput": { "type": "object", "description": "A2A provider specific input for unplanned failover.", "properties": { "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed." }, "cloudServiceCreationOption": { "type": "string", "description": "A value indicating whether to use recovery cloud service for failover or not." } }, "allOf": [ { "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AUnprotectedDiskDetails": { "type": "object", "description": "A2A unprotected disk details.", "properties": { "diskLunId": { "type": "integer", "format": "int32", "description": "The source lun Id for the data disk." }, "diskAutoProtectionStatus": { "$ref": "#/definitions/AutoProtectionOfDataDisk", "description": "A value indicating whether the disk auto protection is enabled." } } }, "A2AUpdateContainerMappingInput": { "type": "object", "description": "A2A update protection container mapping.", "properties": { "agentAutoUpdateStatus": { "$ref": "#/definitions/AgentAutoUpdateStatus", "description": "A value indicating whether the auto update is enabled." }, "automationAccountArmId": { "type": "string", "description": "The automation account arm id." }, "automationAccountAuthenticationType": { "type": "string", "description": "A value indicating the type authentication to use for automation Account.", "default": "RunAsAccount", "enum": [ "RunAsAccount", "SystemAssignedIdentity" ], "x-ms-enum": { "name": "AutomationAccountAuthenticationType", "modelAsString": true, "values": [ { "name": "RunAsAccount", "value": "RunAsAccount", "description": "RunAsAccount" }, { "name": "SystemAssignedIdentity", "value": "SystemAssignedIdentity", "description": "SystemAssignedIdentity" } ] } } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AUpdateReplicationProtectedItemInput": { "type": "object", "description": "InMage Azure V2 input to update replication protected item.", "properties": { "recoveryCloudServiceId": { "type": "string", "description": "The target cloud service ARM Id (for V1)." }, "recoveryResourceGroupId": { "type": "string", "description": "The target resource group ARM Id (for V2)." }, "managedDiskUpdateDetails": { "type": "array", "description": "Managed disk update details.", "items": { "$ref": "#/definitions/A2AVmManagedDiskUpdateDetails" } }, "recoveryBootDiagStorageAccountId": { "type": "string", "description": "The boot diagnostic storage account." }, "diskEncryptionInfo": { "$ref": "#/definitions/DiskEncryptionInfo", "description": "The recovery os disk encryption information." }, "tfoAzureVMName": { "type": "string", "description": "The user given name for Test Failover VM." }, "recoveryProximityPlacementGroupId": { "type": "string", "description": "The recovery proximity placement group Id." }, "recoveryVirtualMachineScaleSetId": { "type": "string", "description": "The recovery virtual machine scale set Id." }, "recoveryCapacityReservationGroupId": { "type": "string", "description": "The recovery capacity reservation group Id." }, "recoveryAvailabilityZone": { "type": "string", "description": "The recovery availability zone." }, "platformFaultDomain": { "type": "integer", "format": "int32", "description": "The platform fault domain." }, "recoveryConfidentialDataDiskEncryptionIdentity": { "type": "string", "format": "arm-id", "description": "The Azure resource ID of the confidential data disk encryption user-assigned identity. Applicable to CMK confidential VM data disks.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ManagedIdentity/userAssignedIdentities" } ] } } }, "allOf": [ { "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" } ], "x-ms-discriminator-value": "A2A" }, "A2AVmDiskInputDetails": { "type": "object", "description": "A2A disk input details.", "properties": { "diskUri": { "type": "string", "description": "The disk Uri." }, "recoveryAzureStorageAccountId": { "type": "string", "description": "The recovery VHD storage account Id." }, "primaryStagingAzureStorageAccountId": { "type": "string", "description": "The primary staging storage account Id." } }, "required": [ "diskUri", "recoveryAzureStorageAccountId", "primaryStagingAzureStorageAccountId" ] }, "A2AVmManagedDiskInputDetails": { "type": "object", "description": "A2A managed disk input details.", "properties": { "diskId": { "type": "string", "description": "The disk Id." }, "primaryStagingAzureStorageAccountId": { "type": "string", "description": "The primary staging storage account Arm Id." }, "recoveryResourceGroupId": { "type": "string", "description": "The target resource group Arm Id." }, "recoveryReplicaDiskAccountType": { "type": "string", "description": "The replica disk type. Its an optional value and will be same as source disk type if not user provided." }, "recoveryTargetDiskAccountType": { "type": "string", "description": "The target disk type after failover. Its an optional value and will be same as source disk type if not user provided." }, "recoveryDiskEncryptionSetId": { "type": "string", "description": "The recovery disk encryption set Id." }, "diskEncryptionInfo": { "$ref": "#/definitions/DiskEncryptionInfo", "description": "The recovery disk encryption information (for one / single pass flows)." }, "recoveryNetworkAccessPolicy": { "$ref": "#/definitions/DiskNetworkAccessPolicy", "description": "The network access policy for the recovery managed disk." }, "recoveryDiskAccessId": { "type": "string", "description": "The recovery disk access Arm Id." }, "recoveryPublicNetworkAccess": { "$ref": "#/definitions/DiskPublicNetworkAccess", "description": "The public network access setting for the recovery managed disk." }, "confidentialDiskEncryptionInfo": { "$ref": "#/definitions/ConfidentialDiskEncryptionInfo", "description": "The confidential disk encryption info for the managed disk. Applicable to CMK confidential VMs." } }, "required": [ "diskId", "primaryStagingAzureStorageAccountId", "recoveryResourceGroupId" ] }, "A2AVmManagedDiskUpdateDetails": { "type": "object", "description": "A2A Vm managed disk update details.", "properties": { "diskId": { "type": "string", "description": "The disk Id." }, "recoveryTargetDiskAccountType": { "type": "string", "description": "The target disk type before failover." }, "recoveryReplicaDiskAccountType": { "type": "string", "description": "The replica disk type before failover." }, "diskEncryptionInfo": { "$ref": "#/definitions/DiskEncryptionInfo", "description": "The recovery os disk encryption information." }, "failoverDiskName": { "type": "string", "description": "The target disk name for unplanned failover operation." }, "tfoDiskName": { "type": "string", "description": "The target disk name for test failover operation." }, "confidentialDiskEncryptionInfo": { "$ref": "#/definitions/UpdateConfidentialDiskEncryptionInfo", "description": "The confidential disk encryption info to update for the managed disk. Only the recovery target confidential disk encryption set can be changed through this update operation. Applicable to A2A CMK confidential VMs." } } }, "A2AZoneDetails": { "type": "object", "description": "Zone details data.", "properties": { "source": { "type": "string", "description": "Source zone info." }, "target": { "type": "string", "description": "The target zone info." } } }, "ASRTask": { "type": "object", "description": "Task of the Job.", "properties": { "taskId": { "type": "string", "description": "The Id." }, "name": { "type": "string", "description": "The unique Task name." }, "startTime": { "type": "string", "format": "date-time", "description": "The start time." }, "endTime": { "type": "string", "format": "date-time", "description": "The end time." }, "allowedActions": { "type": "array", "description": "The state/actions applicable on this task.", "items": { "type": "string" } }, "friendlyName": { "type": "string", "description": "The name." }, "state": { "type": "string", "description": "The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other." }, "stateDescription": { "type": "string", "description": "The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped." }, "taskType": { "type": "string", "description": "The type of task. Details in CustomDetails property depend on this type." }, "customDetails": { "$ref": "#/definitions/TaskTypeDetails", "description": "The custom task details based on the task type." }, "groupTaskCustomDetails": { "$ref": "#/definitions/GroupTaskDetails", "description": "The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it." }, "errors": { "type": "array", "description": "The task error details.", "items": { "$ref": "#/definitions/JobErrorDetails" } } } }, "AddDisksInput": { "type": "object", "description": "Input for add disk(s) operation.", "properties": { "properties": { "$ref": "#/definitions/AddDisksInputProperties", "description": "Add disks input properties." } } }, "AddDisksInputProperties": { "type": "object", "description": "Add Disks input properties.", "properties": { "providerSpecificDetails": { "$ref": "#/definitions/AddDisksProviderSpecificInput", "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." } }, "required": [ "providerSpecificDetails" ] }, "AddDisksProviderSpecificInput": { "type": "object", "description": "Add Disks provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "AddRecoveryServicesProviderInput": { "type": "object", "description": "Input required to add a provider.", "properties": { "properties": { "$ref": "#/definitions/AddRecoveryServicesProviderInputProperties", "description": "The properties of an add provider request." } }, "required": [ "properties" ] }, "AddRecoveryServicesProviderInputProperties": { "type": "object", "description": "The properties of an add provider request.", "properties": { "machineName": { "type": "string", "description": "The name of the machine where the provider is getting added." }, "machineId": { "type": "string", "description": "The Id of the machine where the provider is getting added." }, "biosId": { "type": "string", "description": "The Bios Id of the machine." }, "authenticationIdentityInput": { "$ref": "#/definitions/IdentityProviderInput", "description": "The identity provider input for DRA authentication." }, "resourceAccessIdentityInput": { "$ref": "#/definitions/IdentityProviderInput", "description": "The identity provider input for resource access." }, "dataPlaneAuthenticationIdentityInput": { "$ref": "#/definitions/IdentityProviderInput", "description": "The identity provider input for data plane authentication." } }, "required": [ "machineName", "authenticationIdentityInput", "resourceAccessIdentityInput" ] }, "AddVCenterRequest": { "type": "object", "description": "Input required to add vCenter.", "properties": { "properties": { "$ref": "#/definitions/AddVCenterRequestProperties", "description": "The properties of an add vCenter request." } } }, "AddVCenterRequestProperties": { "type": "object", "description": "The properties of an add vCenter request.", "properties": { "friendlyName": { "type": "string", "description": "The friendly name of the vCenter." }, "ipAddress": { "type": "string", "description": "The IP address of the vCenter to be discovered." }, "processServerId": { "type": "string", "description": "The process server Id from where the discovery is orchestrated." }, "port": { "type": "string", "description": "The port number for discovery." }, "runAsAccountId": { "type": "string", "description": "The account Id which has privileges to discover the vCenter." } } }, "AgentAutoUpdateStatus": { "type": "string", "description": "A value indicating whether the auto update is enabled.", "enum": [ "Disabled", "Enabled" ], "x-ms-enum": { "name": "AgentAutoUpdateStatus", "modelAsString": true, "values": [ { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Enabled", "value": "Enabled", "description": "Enabled" } ] } }, "AgentDetails": { "type": "object", "description": "Agent details.", "properties": { "agentId": { "type": "string", "description": "The Id of the agent running on the server.", "readOnly": true }, "machineId": { "type": "string", "description": "The Id of the machine to which the agent is registered.", "readOnly": true }, "biosId": { "type": "string", "description": "The machine BIOS Id.", "readOnly": true }, "fqdn": { "type": "string", "description": "The machine FQDN.", "readOnly": true }, "disks": { "type": "array", "description": "The disks.", "items": { "$ref": "#/definitions/AgentDiskDetails" }, "readOnly": true } } }, "AgentDiskDetails": { "type": "object", "description": "Agent disk details.", "properties": { "diskId": { "type": "string", "description": "The disk Id.", "readOnly": true }, "diskName": { "type": "string", "description": "The disk name.", "readOnly": true }, "isOSDisk": { "type": "string", "description": "A value indicating whether the disk is the OS disk.", "readOnly": true }, "capacityInBytes": { "type": "integer", "format": "int64", "description": "The disk capacity in bytes.", "readOnly": true }, "lunId": { "type": "integer", "format": "int32", "description": "The lun of disk.", "readOnly": true } } }, "AgentReinstallBlockedReason": { "type": "string", "enum": [ "DistroNotSupported", "AgentNoHeartbeat", "Unknown" ], "x-ms-enum": { "name": "AgentReinstallBlockedReason", "modelAsString": true, "values": [ { "name": "DistroNotSupported", "value": "DistroNotSupported", "description": "DistroNotSupported" }, { "name": "AgentNoHeartbeat", "value": "AgentNoHeartbeat", "description": "AgentNoHeartbeat" }, { "name": "Unknown", "value": "Unknown", "description": "Unknown" } ] } }, "AgentUpgradeBlockedReason": { "type": "string", "enum": [ "AlreadyOnLatestVersion", "RebootRequired", "AgentNoHeartbeat", "RcmProxyNoHeartbeat", "ProcessServerNoHeartbeat", "IncompatibleApplianceVersion", "NotProtected", "UnsupportedProtectionScenario", "DistroIsNotReported", "DistroNotSupportedForUpgrade", "MissingUpgradePath", "InvalidAgentVersion", "InvalidDriverVersion", "ReInstallRequired", "Unknown" ], "x-ms-enum": { "name": "AgentUpgradeBlockedReason", "modelAsString": true, "values": [ { "name": "AlreadyOnLatestVersion", "value": "AlreadyOnLatestVersion", "description": "AlreadyOnLatestVersion" }, { "name": "RebootRequired", "value": "RebootRequired", "description": "RebootRequired" }, { "name": "AgentNoHeartbeat", "value": "AgentNoHeartbeat", "description": "AgentNoHeartbeat" }, { "name": "RcmProxyNoHeartbeat", "value": "RcmProxyNoHeartbeat", "description": "RcmProxyNoHeartbeat" }, { "name": "ProcessServerNoHeartbeat", "value": "ProcessServerNoHeartbeat", "description": "ProcessServerNoHeartbeat" }, { "name": "IncompatibleApplianceVersion", "value": "IncompatibleApplianceVersion", "description": "IncompatibleApplianceVersion" }, { "name": "NotProtected", "value": "NotProtected", "description": "NotProtected" }, { "name": "UnsupportedProtectionScenario", "value": "UnsupportedProtectionScenario", "description": "UnsupportedProtectionScenario" }, { "name": "DistroIsNotReported", "value": "DistroIsNotReported", "description": "DistroIsNotReported" }, { "name": "DistroNotSupportedForUpgrade", "value": "DistroNotSupportedForUpgrade", "description": "DistroNotSupportedForUpgrade" }, { "name": "MissingUpgradePath", "value": "MissingUpgradePath", "description": "MissingUpgradePath" }, { "name": "InvalidAgentVersion", "value": "InvalidAgentVersion", "description": "InvalidAgentVersion" }, { "name": "InvalidDriverVersion", "value": "InvalidDriverVersion", "description": "InvalidDriverVersion" }, { "name": "ReInstallRequired", "value": "ReInstallRequired", "description": "ReInstallRequired" }, { "name": "Unknown", "value": "Unknown", "description": "Unknown" } ] } }, "AgentVersionStatus": { "type": "string", "description": "A value indicating whether security update required.", "enum": [ "Supported", "NotSupported", "Deprecated", "UpdateRequired", "SecurityUpdateRequired" ], "x-ms-enum": { "name": "AgentVersionStatus", "modelAsString": true, "values": [ { "name": "Supported", "value": "Supported", "description": "Supported" }, { "name": "NotSupported", "value": "NotSupported", "description": "NotSupported" }, { "name": "Deprecated", "value": "Deprecated", "description": "Deprecated" }, { "name": "UpdateRequired", "value": "UpdateRequired", "description": "UpdateRequired" }, { "name": "SecurityUpdateRequired", "value": "SecurityUpdateRequired", "description": "SecurityUpdateRequired" } ] } }, "Alert": { "type": "object", "description": "Implements the Alert class.", "properties": { "properties": { "$ref": "#/definitions/AlertProperties", "description": "Alert related data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "AlertCollection": { "type": "object", "description": "Collection of alerts.", "properties": { "value": { "type": "array", "description": "The Alert items on this page", "items": { "$ref": "#/definitions/Alert" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AlertProperties": { "type": "object", "description": "The properties of an alert.", "properties": { "sendToOwners": { "type": "string", "description": "A value indicating whether to send email to subscription administrator." }, "customEmailAddresses": { "type": "array", "description": "The custom email address for sending emails.", "items": { "type": "string" } }, "locale": { "type": "string", "description": "The locale for the email notification." } } }, "AlternateLocationRecoveryOption": { "type": "string", "description": "The ALR option.", "enum": [ "CreateVmIfNotFound", "NoAction" ], "x-ms-enum": { "name": "AlternateLocationRecoveryOption", "modelAsString": true, "values": [ { "name": "CreateVmIfNotFound", "value": "CreateVmIfNotFound", "description": "CreateVmIfNotFound" }, { "name": "NoAction", "value": "NoAction", "description": "NoAction" } ] } }, "ApplianceCollection": { "type": "object", "description": "Collection of appliance details.", "properties": { "value": { "type": "array", "description": "The ReplicationAppliance items on this page", "items": { "$ref": "#/definitions/ReplicationAppliance" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ApplianceMonitoringDetails": { "type": "object", "description": "Appliance details of the migration item.", "properties": { "cpuDetails": { "$ref": "#/definitions/ApplianceResourceDetails", "description": "The appliance CPU details.", "readOnly": true }, "ramDetails": { "$ref": "#/definitions/ApplianceResourceDetails", "description": "The appliance RAM details.", "readOnly": true }, "datastoreSnapshot": { "type": "array", "description": "The appliance datastore snapshot details.", "items": { "$ref": "#/definitions/DataStoreUtilizationDetails" }, "readOnly": true, "x-ms-identifiers": [] }, "disksReplicationDetails": { "$ref": "#/definitions/ApplianceResourceDetails", "description": "The disk replication details.", "readOnly": true }, "esxiNfcBuffer": { "$ref": "#/definitions/ApplianceResourceDetails", "description": "The ESXi NFC buffer details.", "readOnly": true }, "networkBandwidth": { "$ref": "#/definitions/ApplianceResourceDetails", "description": "The appliance network bandwidth details.", "readOnly": true } } }, "ApplianceResourceDetails": { "type": "object", "description": "Details of the appliance resource.", "properties": { "capacity": { "type": "integer", "format": "int64", "description": "A value indicating the total capacity of appliance resource.", "readOnly": true }, "processUtilization": { "type": "number", "format": "double", "description": "A value indicating the utilization percentage by gateway agent on appliance.", "readOnly": true }, "totalUtilization": { "type": "number", "format": "double", "description": "A value indicating the total utilization percentage for all processes on the appliance.", "readOnly": true }, "status": { "type": "string", "description": "A value indicating the status of appliance resource.", "readOnly": true } } }, "ApplianceSpecificDetails": { "type": "object", "description": "Appliance specific details.", "properties": { "instanceType": { "type": "string", "description": "Gets the class type. Overridden in derived classes." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ApplyClusterRecoveryPointInput": { "type": "object", "description": "Input definition for apply cluster recovery point.", "properties": { "properties": { "$ref": "#/definitions/ApplyClusterRecoveryPointInputProperties", "description": "The properties to apply cluster recovery point input." } }, "required": [ "properties" ] }, "ApplyClusterRecoveryPointInputProperties": { "type": "object", "description": "Input definition for apply cluster recovery point properties.", "properties": { "clusterRecoveryPointId": { "type": "string", "format": "arm-id", "description": "The cluster recovery point id to be passed to failover to a particular recovery point.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters/recoveryPoints" } ] } }, "individualNodeRecoveryPoints": { "type": "array", "description": "The list of individual node recovery points.", "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.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems" } ] } } }, "providerSpecificDetails": { "$ref": "#/definitions/ApplyClusterRecoveryPointProviderSpecificInput", "description": "The provider specific input for applying cluster recovery point." } }, "required": [ "providerSpecificDetails" ] }, "ApplyClusterRecoveryPointProviderSpecificInput": { "type": "object", "description": "Provider specific input for apply cluster recovery point.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ApplyRecoveryPointInput": { "type": "object", "description": "Input to apply recovery point.", "properties": { "properties": { "$ref": "#/definitions/ApplyRecoveryPointInputProperties", "description": "The input properties to apply recovery point." } }, "required": [ "properties" ] }, "ApplyRecoveryPointInputProperties": { "type": "object", "description": "Input properties to apply recovery point.", "properties": { "recoveryPointId": { "type": "string", "description": "The recovery point Id." }, "providerSpecificDetails": { "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput", "description": "Provider specific input for applying recovery point." } }, "required": [ "providerSpecificDetails" ] }, "ApplyRecoveryPointProviderSpecificInput": { "type": "object", "description": "Provider specific input for apply recovery point.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "AsrJobDetails": { "type": "object", "description": "This class represents job details based on specific job type.", "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "x-ms-discriminator-value": "AsrJobDetails" }, "AutoProtectionOfDataDisk": { "type": "string", "description": "A value indicating whether the auto protection is enabled.", "enum": [ "Disabled", "Enabled" ], "x-ms-enum": { "name": "AutoProtectionOfDataDisk", "modelAsString": true, "values": [ { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Enabled", "value": "Enabled", "description": "Enabled" } ] } }, "AutomationRunbookTaskDetails": { "type": "object", "description": "This class represents the task details for an automation runbook.", "properties": { "name": { "type": "string", "description": "The recovery plan task name." }, "cloudServiceName": { "type": "string", "description": "The cloud service of the automation runbook account." }, "subscriptionId": { "type": "string", "description": "The subscription Id of the automation runbook account." }, "accountName": { "type": "string", "description": "The automation account name of the runbook." }, "runbookId": { "type": "string", "description": "The runbook Id." }, "runbookName": { "type": "string", "description": "The runbook name." }, "jobId": { "type": "string", "description": "The job Id of the runbook execution." }, "jobOutput": { "type": "string", "description": "The execution output of the runbook." }, "isPrimarySideScript": { "type": "boolean", "description": "A value indicating whether it is a primary side script or not." } }, "allOf": [ { "$ref": "#/definitions/TaskTypeDetails" } ], "x-ms-discriminator-value": "AutomationRunbookTaskDetails" }, "AzureFabricCreationInput": { "type": "object", "description": "Fabric provider specific settings.", "properties": { "location": { "type": "string", "description": "The Location." } }, "allOf": [ { "$ref": "#/definitions/FabricSpecificCreationInput" } ], "x-ms-discriminator-value": "Azure" }, "AzureFabricSpecificDetails": { "type": "object", "description": "Azure Fabric Specific Details.", "properties": { "location": { "type": "string", "description": "The Location for the Azure fabric." }, "containerIds": { "type": "array", "description": "The container Ids for the Azure fabric.", "items": { "type": "string" } }, "zones": { "type": "array", "description": "The zones.", "items": { "$ref": "#/definitions/A2AZoneDetails" } }, "extendedLocations": { "type": "array", "description": "The ExtendedLocations.", "items": { "$ref": "#/definitions/A2AExtendedLocationDetails" }, "x-ms-identifiers": [] }, "locationDetails": { "type": "array", "description": "The location details.", "items": { "$ref": "#/definitions/A2AFabricSpecificLocationDetails" }, "x-ms-identifiers": [] } }, "allOf": [ { "$ref": "#/definitions/FabricSpecificDetails" } ], "x-ms-discriminator-value": "Azure" }, "AzureToAzureCreateNetworkMappingInput": { "type": "object", "description": "Create network mappings input properties/behavior specific to Azure to Azure Network mapping.", "properties": { "primaryNetworkId": { "type": "string", "description": "The primary azure vnet Id." } }, "required": [ "primaryNetworkId" ], "allOf": [ { "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" } ], "x-ms-discriminator-value": "AzureToAzure" }, "AzureToAzureNetworkMappingSettings": { "type": "object", "description": "A2A Network Mapping fabric specific settings.", "properties": { "primaryFabricLocation": { "type": "string", "description": "The primary fabric location." }, "recoveryFabricLocation": { "type": "string", "description": "The recovery fabric location." } }, "allOf": [ { "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" } ], "x-ms-discriminator-value": "AzureToAzure" }, "AzureToAzureUpdateNetworkMappingInput": { "type": "object", "description": "Updates network mappings input.", "properties": { "primaryNetworkId": { "type": "string", "description": "The primary azure vnet Id." } }, "allOf": [ { "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" } ], "x-ms-discriminator-value": "AzureToAzure" }, "AzureToAzureVmSyncedConfigDetails": { "type": "object", "description": "Azure to Azure VM synced configuration details.", "properties": { "tags": { "type": "object", "description": "The Azure VM tags.", "additionalProperties": { "type": "string" } }, "inputEndpoints": { "type": "array", "description": "The Azure VM input endpoints.", "items": { "$ref": "#/definitions/InputEndpoint" } } } }, "AzureVmDiskDetails": { "type": "object", "description": "Disk details for E2A provider.", "properties": { "vhdType": { "type": "string", "description": "VHD type." }, "vhdId": { "type": "string", "description": "The VHD id." }, "diskId": { "type": "string", "description": "The disk resource id." }, "vhdName": { "type": "string", "description": "VHD name." }, "maxSizeMB": { "type": "string", "description": "Max side in MB." }, "targetDiskLocation": { "type": "string", "description": "Blob uri of the Azure disk." }, "targetDiskName": { "type": "string", "description": "The target Azure disk name." }, "lunId": { "type": "string", "description": "Ordinal\\LunId of the disk for the Azure VM." }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM ID." }, "customTargetDiskName": { "type": "string", "description": "The custom target Azure disk name." } } }, "ChurnOptionSelected": { "type": "string", "description": "A value indicating the churn option selected by user.", "enum": [ "Normal", "High" ], "x-ms-enum": { "name": "ChurnOptionSelected", "modelAsString": true, "values": [ { "name": "Normal", "value": "Normal", "description": "Normal" }, { "name": "High", "value": "High", "description": "High" } ] } }, "ClusterFailoverJobDetails": { "type": "object", "description": "This class represents the details for a failover job of cluster.", "properties": { "protectedItemDetails": { "type": "array", "description": "The test VM details.", "items": { "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" }, "x-ms-identifiers": [ "name" ] } }, "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "x-ms-discriminator-value": "ClusterFailoverJobDetails" }, "ClusterProviderSpecificRecoveryPointDetails": { "type": "object", "description": "Replication provider specific cluster recovery point details.", "properties": { "instanceType": { "type": "string", "description": "Gets the provider type.", "readOnly": true } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ClusterRecoveryPoint": { "type": "object", "description": "Recovery point.", "properties": { "id": { "type": "string", "format": "arm-id", "description": "The recovery point Id.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionClusters/recoveryPoints" } ] } }, "name": { "type": "string", "description": "The recovery point name." }, "type": { "type": "string", "description": "The resource type." }, "properties": { "$ref": "#/definitions/ClusterRecoveryPointProperties", "description": "The recovery point properties." } } }, "ClusterRecoveryPointCollection": { "type": "object", "description": "Collection of cluster recovery point details.", "properties": { "value": { "type": "array", "description": "The ClusterRecoveryPoint items on this page", "items": { "$ref": "#/definitions/ClusterRecoveryPoint" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ClusterRecoveryPointProperties": { "type": "object", "description": "Cluster recovery point properties.", "properties": { "recoveryPointTime": { "type": "string", "format": "date-time", "description": "The recovery point time." }, "recoveryPointType": { "$ref": "#/definitions/ClusterRecoveryPointType", "description": "The recovery point type." }, "providerSpecificDetails": { "$ref": "#/definitions/ClusterProviderSpecificRecoveryPointDetails", "description": "The provider specific details for the recovery point." } } }, "ClusterRecoveryPointType": { "type": "string", "description": "The recovery point type.", "enum": [ "NotSpecified", "ApplicationConsistent", "CrashConsistent" ], "x-ms-enum": { "name": "ClusterRecoveryPointType", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified" }, { "name": "ApplicationConsistent", "value": "ApplicationConsistent", "description": "ApplicationConsistent" }, { "name": "CrashConsistent", "value": "CrashConsistent", "description": "CrashConsistent" } ] } }, "ClusterSwitchProtectionJobDetails": { "type": "object", "description": "This class represents details for switch cluster protection job.", "properties": { "newReplicationProtectionClusterId": { "type": "string", "description": "ARM Id of the new replication protection cluster." } }, "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "x-ms-discriminator-value": "ClusterSwitchProtectionJobDetails" }, "ClusterTestFailoverCleanupInput": { "type": "object", "description": "Input definition for test failover cleanup for cluster.", "properties": { "properties": { "$ref": "#/definitions/ClusterTestFailoverCleanupInputProperties", "description": "Test failover cleanup input properties." } }, "required": [ "properties" ] }, "ClusterTestFailoverCleanupInputProperties": { "type": "object", "description": "Input definition for test failover cleanup input properties.", "properties": { "comments": { "type": "string", "description": "Test failover cleanup comments.", "maxLength": 1024 } } }, "ClusterTestFailoverInput": { "type": "object", "description": "Input definition for test cluster failover.", "properties": { "properties": { "$ref": "#/definitions/ClusterTestFailoverInputProperties", "description": "Test failover input properties." } }, "required": [ "properties" ] }, "ClusterTestFailoverInputProperties": { "type": "object", "description": "Input definition for test failover input properties.", "properties": { "failoverDirection": { "$ref": "#/definitions/FailoverDirection", "description": "Failover direction." }, "networkType": { "type": "string", "description": "Network type to be used for test failover." }, "networkId": { "type": "string", "format": "arm-id", "description": "The id of the network to be used for test failover.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Network/virtualNetworks" } ] } }, "providerSpecificDetails": { "$ref": "#/definitions/ClusterTestFailoverProviderSpecificInput", "description": "Provider specific settings." } } }, "ClusterTestFailoverJobDetails": { "type": "object", "description": "This class represents the details for a test failover job of cluster.", "properties": { "testFailoverStatus": { "type": "string", "description": "The test failover status." }, "comments": { "type": "string", "description": "The test failover comments." }, "networkName": { "type": "string", "description": "The test network name." }, "networkFriendlyName": { "type": "string", "description": "The test network friendly name." }, "networkType": { "type": "string", "description": "The test network type (see TestFailoverInput enum for possible values)." }, "protectedItemDetails": { "type": "array", "description": "The test VM details.", "items": { "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" } } }, "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "x-ms-discriminator-value": "ClusterTestFailoverJobDetails" }, "ClusterTestFailoverProviderSpecificInput": { "type": "object", "description": "Provider specific test cluster failover input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ClusterUnplannedFailoverInput": { "type": "object", "description": "Input definition for unplanned cluster failover.", "properties": { "properties": { "$ref": "#/definitions/ClusterUnplannedFailoverInputProperties", "description": "Unplanned failover input properties." } }, "required": [ "properties" ] }, "ClusterUnplannedFailoverInputProperties": { "type": "object", "description": "Input definition for unplanned failover input properties.", "properties": { "failoverDirection": { "type": "string", "description": "Failover direction." }, "sourceSiteOperations": { "type": "string", "description": "Source site operations status." }, "providerSpecificDetails": { "$ref": "#/definitions/ClusterUnplannedFailoverProviderSpecificInput", "description": "Provider specific settings." } } }, "ClusterUnplannedFailoverProviderSpecificInput": { "type": "object", "description": "Provider specific unplanned cluster failover input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ComputeSizeErrorDetails": { "type": "object", "description": "Represents the error used to indicate why the target compute size is not applicable.", "properties": { "message": { "type": "string", "description": "The error message." }, "severity": { "type": "string", "description": "The severity of the error." } } }, "ConfidentialDiskEncryptionInfo": { "type": "object", "description": "Confidential disk encryption info for an A2A CMK confidential VM managed disk. Specifies the confidential disk encryption set ID for the replica disk used during replication and the confidential disk encryption set ID for the target disk used after failover.", "properties": { "recoveryReplicaConfidentialDiskEncryptionSetId": { "type": "string", "format": "arm-id", "description": "The Azure resource ID of the confidential disk encryption set used for the replica disk. Applicable to CMK confidential VMs.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Compute/diskEncryptionSets" } ] } }, "recoveryTargetConfidentialDiskEncryptionSetId": { "type": "string", "format": "arm-id", "description": "The Azure resource ID of the confidential disk encryption set used for the target disk after failover. Applicable to CMK confidential VMs.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Compute/diskEncryptionSets" } ] } } } }, "ConfigurationSettings": { "type": "object", "description": "Replication provider specific settings.", "properties": { "instanceType": { "type": "string", "description": "Gets the class type. Overridden in derived classes." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ConfigureAlertRequest": { "type": "object", "description": "Request to configure alerts for the system.", "properties": { "properties": { "$ref": "#/definitions/ConfigureAlertRequestProperties", "description": "The properties of a configure alert request." } } }, "ConfigureAlertRequestProperties": { "type": "object", "description": "Properties of a configure alert request.", "properties": { "sendToOwners": { "type": "string", "description": "A value indicating whether to send email to subscription administrator." }, "customEmailAddresses": { "type": "array", "description": "The custom email address for sending emails.", "items": { "type": "string" } }, "locale": { "type": "string", "description": "The locale for the email notification." } } }, "ConsistencyCheckTaskDetails": { "type": "object", "description": "This class contains monitoring details of all the inconsistent Protected Entities in Vmm.", "properties": { "vmDetails": { "type": "array", "description": "The list of inconsistent Vm details.", "items": { "$ref": "#/definitions/InconsistentVmDetails" } } }, "allOf": [ { "$ref": "#/definitions/TaskTypeDetails" } ], "x-ms-discriminator-value": "ConsistencyCheckTaskDetails" }, "CreateNetworkMappingInput": { "type": "object", "description": "Create network mappings input.", "properties": { "properties": { "$ref": "#/definitions/CreateNetworkMappingInputProperties", "description": "Input properties for creating network mapping." } }, "required": [ "properties" ] }, "CreateNetworkMappingInputProperties": { "type": "object", "description": "Common input details for network mapping operation.", "properties": { "recoveryFabricName": { "type": "string", "description": "Recovery fabric Name." }, "recoveryNetworkId": { "type": "string", "description": "Recovery network Id." }, "fabricSpecificDetails": { "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput", "description": "Fabric specific input properties." } }, "required": [ "recoveryNetworkId" ] }, "CreatePolicyInput": { "type": "object", "description": "Protection Policy input.", "properties": { "properties": { "$ref": "#/definitions/CreatePolicyInputProperties", "description": "Policy creation properties." } } }, "CreatePolicyInputProperties": { "type": "object", "description": "Policy creation properties.", "properties": { "providerSpecificInput": { "$ref": "#/definitions/PolicyProviderSpecificInput", "description": "The ReplicationProviderSettings." } } }, "CreateProtectionContainerInput": { "type": "object", "description": "Create protection container input.", "properties": { "properties": { "$ref": "#/definitions/CreateProtectionContainerInputProperties", "description": "Create protection container input properties." } } }, "CreateProtectionContainerInputProperties": { "type": "object", "description": "Create protection container input properties.", "properties": { "providerSpecificInput": { "type": "array", "description": "Provider specific inputs for container creation.", "items": { "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" } } } }, "CreateProtectionContainerMappingInput": { "type": "object", "description": "Configure pairing input.", "properties": { "properties": { "$ref": "#/definitions/CreateProtectionContainerMappingInputProperties", "description": "Configure protection input properties." } } }, "CreateProtectionContainerMappingInputProperties": { "type": "object", "description": "Configure pairing input properties.", "properties": { "targetProtectionContainerId": { "type": "string", "description": "The target unique protection container name." }, "policyId": { "type": "string", "description": "Applicable policy." }, "providerSpecificInput": { "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput", "description": "Provider specific input for pairing." } } }, "CreateProtectionIntentInput": { "type": "object", "description": "Create protection intent input.", "properties": { "properties": { "$ref": "#/definitions/CreateProtectionIntentProperties", "description": "Create protection intent input properties." } } }, "CreateProtectionIntentProperties": { "type": "object", "description": "Create protection intent input properties.", "properties": { "providerSpecificDetails": { "$ref": "#/definitions/CreateProtectionIntentProviderSpecificDetails", "description": "The ReplicationProviderInput. For A2A provider, it will be A2ACreateProtectionIntentInput object." } } }, "CreateProtectionIntentProviderSpecificDetails": { "type": "object", "description": "Create protection intent provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "CreateRecoveryPlanInput": { "type": "object", "description": "Create recovery plan input class.", "properties": { "properties": { "$ref": "#/definitions/CreateRecoveryPlanInputProperties", "description": "Recovery plan creation properties." } }, "required": [ "properties" ] }, "CreateRecoveryPlanInputProperties": { "type": "object", "description": "Recovery plan creation properties.", "properties": { "primaryFabricId": { "type": "string", "description": "The primary fabric Id." }, "recoveryFabricId": { "type": "string", "description": "The recovery fabric Id." }, "failoverDeploymentModel": { "$ref": "#/definitions/FailoverDeploymentModel", "description": "The failover deployment model." }, "groups": { "type": "array", "description": "The recovery plan groups.", "items": { "$ref": "#/definitions/RecoveryPlanGroup" } }, "providerSpecificInput": { "type": "array", "description": "The provider specific input.", "items": { "$ref": "#/definitions/RecoveryPlanProviderSpecificInput" } } }, "required": [ "primaryFabricId", "recoveryFabricId", "groups" ] }, "CriticalJobHistoryDetails": { "type": "object", "description": "Critical past job details of the migration item.", "properties": { "jobName": { "type": "string", "description": "The job name.", "readOnly": true }, "jobId": { "type": "string", "description": "The ARM Id of the job being executed.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job.", "readOnly": true }, "jobStatus": { "type": "string", "description": "The job state.", "readOnly": true } } }, "CurrentJobDetails": { "type": "object", "description": "Current job details of the migration item.", "properties": { "jobName": { "type": "string", "description": "The job name.", "readOnly": true }, "jobId": { "type": "string", "description": "The ARM Id of the job being executed.", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "The start time of the job.", "readOnly": true } } }, "CurrentScenarioDetails": { "type": "object", "description": "Current scenario details of the protected entity.", "properties": { "scenarioName": { "type": "string", "description": "Scenario name." }, "jobId": { "type": "string", "description": "ARM Id of the job being executed." }, "startTime": { "type": "string", "format": "date-time", "description": "Start time of the workflow." } } }, "DataStore": { "type": "object", "description": "The datastore details of the MT.", "properties": { "symbolicName": { "type": "string", "description": "The symbolic name of data store." }, "uuid": { "type": "string", "description": "The uuid of data store." }, "capacity": { "type": "string", "description": "The capacity of data store in GBs." }, "freeSpace": { "type": "string", "description": "The free space of data store in GBs." }, "type": { "type": "string", "description": "The type of data store." } } }, "DataStoreUtilizationDetails": { "type": "object", "description": "Details of the appliance resource.", "properties": { "totalSnapshotsSupported": { "type": "integer", "format": "int64", "description": "The total count of snapshots supported by the datastore.", "readOnly": true }, "totalSnapshotsCreated": { "type": "integer", "format": "int64", "description": "The total snapshots created for server migration in the datastore.", "readOnly": true }, "dataStoreName": { "type": "string", "description": "The datastore name.", "readOnly": true } } }, "DataSyncStatus": { "type": "string", "description": "The data sync option.", "enum": [ "ForDownTime", "ForSynchronization" ], "x-ms-enum": { "name": "DataSyncStatus", "modelAsString": true, "values": [ { "name": "ForDownTime", "value": "ForDownTime", "description": "ForDownTime" }, { "name": "ForSynchronization", "value": "ForSynchronization", "description": "ForSynchronization" } ] } }, "DisableProtectionInput": { "type": "object", "description": "Disable protection input.", "properties": { "properties": { "$ref": "#/definitions/DisableProtectionInputProperties", "description": "Disable protection input properties." } }, "required": [ "properties" ] }, "DisableProtectionInputProperties": { "type": "object", "description": "Disable protection input properties.", "properties": { "disableProtectionReason": { "$ref": "#/definitions/DisableProtectionReason", "description": "Disable protection reason. It can have values NotSpecified/MigrationComplete." }, "replicationProviderInput": { "$ref": "#/definitions/DisableProtectionProviderSpecificInput", "description": "Replication provider specific input." } } }, "DisableProtectionProviderSpecificInput": { "type": "object", "description": "Disable protection provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "DisableProtectionReason": { "type": "string", "description": "Disable protection reason. It can have values NotSpecified/MigrationComplete.", "enum": [ "NotSpecified", "MigrationComplete" ], "x-ms-enum": { "name": "DisableProtectionReason", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified" }, { "name": "MigrationComplete", "value": "MigrationComplete", "description": "MigrationComplete" } ] } }, "DiscoverProtectableItemRequest": { "type": "object", "description": "Request to add a physical machine as a protectable item in a container.", "properties": { "properties": { "$ref": "#/definitions/DiscoverProtectableItemRequestProperties", "description": "The properties of a discover protectable item request." } } }, "DiscoverProtectableItemRequestProperties": { "type": "object", "description": "Discover protectable item properties.", "properties": { "friendlyName": { "type": "string", "description": "The friendly name of the physical machine." }, "ipAddress": { "type": "string", "description": "The IP address of the physical machine to be discovered." }, "osType": { "type": "string", "description": "The OS type on the physical machine." } } }, "DiskAccountType": { "type": "string", "description": "The disk type.", "enum": [ "Standard_LRS", "Premium_LRS", "StandardSSD_LRS", "PremiumV2_LRS", "UltraSSD_LRS", "StandardSSD_ZRS", "Premium_ZRS" ], "x-ms-enum": { "name": "DiskAccountType", "modelAsString": true, "values": [ { "name": "Standard_LRS", "value": "Standard_LRS", "description": "Standard_LRS" }, { "name": "Premium_LRS", "value": "Premium_LRS", "description": "Premium_LRS" }, { "name": "StandardSSD_LRS", "value": "StandardSSD_LRS", "description": "StandardSSD_LRS" }, { "name": "PremiumV2_LRS", "value": "PremiumV2_LRS", "description": "PremiumV2_LRS" }, { "name": "UltraSSD_LRS", "value": "UltraSSD_LRS", "description": "UltraSSD_LRS" }, { "name": "StandardSSD_ZRS", "value": "StandardSSD_ZRS", "description": "StandardSSD_ZRS" }, { "name": "Premium_ZRS", "value": "Premium_ZRS", "description": "Premium_ZRS" } ] } }, "DiskDetails": { "type": "object", "description": "Onprem disk details data.", "properties": { "maxSizeMB": { "type": "integer", "format": "int64", "description": "The hard disk max size in MB." }, "vhdType": { "type": "string", "description": "The type of the volume." }, "vhdId": { "type": "string", "description": "The VHD Id." }, "vhdName": { "type": "string", "description": "The VHD name." } } }, "DiskEncryptionInfo": { "type": "object", "description": "Recovery disk encryption info (BEK and KEK).", "properties": { "diskEncryptionKeyInfo": { "$ref": "#/definitions/DiskEncryptionKeyInfo", "description": "The recovery KeyVault reference for secret." }, "keyEncryptionKeyInfo": { "$ref": "#/definitions/KeyEncryptionKeyInfo", "description": "The recovery KeyVault reference for key." } } }, "DiskEncryptionKeyInfo": { "type": "object", "description": "Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows).", "properties": { "secretIdentifier": { "type": "string", "description": "The secret url / identifier." }, "keyVaultResourceArmId": { "type": "string", "description": "The KeyVault resource ARM id for secret." } } }, "DiskNetworkAccessPolicy": { "type": "string", "description": "The network access policy for managed disks.", "enum": [ "AllowAll", "AllowPrivate", "DenyAll" ], "x-ms-enum": { "name": "DiskNetworkAccessPolicy", "modelAsString": true, "values": [ { "name": "AllowAll", "value": "AllowAll", "description": "Allow all network access." }, { "name": "AllowPrivate", "value": "AllowPrivate", "description": "Allow private access through disk access resource." }, { "name": "DenyAll", "value": "DenyAll", "description": "Deny all network access." } ] } }, "DiskPublicNetworkAccess": { "type": "string", "description": "The public network access setting for managed disks.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "DiskPublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Public network access is enabled." }, { "name": "Disabled", "value": "Disabled", "description": "Public network access is disabled." } ] } }, "DiskReplicationProgressHealth": { "type": "string", "description": "The progress health.", "enum": [ "None", "InProgress", "SlowProgress", "NoProgress", "Queued" ], "x-ms-enum": { "name": "DiskReplicationProgressHealth", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "InProgress", "value": "InProgress", "description": "InProgress" }, { "name": "SlowProgress", "value": "SlowProgress", "description": "SlowProgress" }, { "name": "NoProgress", "value": "NoProgress", "description": "NoProgress" }, { "name": "Queued", "value": "Queued", "description": "Queued" } ] } }, "DiskState": { "type": "string", "description": "The disk state.", "enum": [ "Unavailable", "InitialReplicationPending", "InitialReplicationFailed", "Protected" ], "x-ms-enum": { "name": "DiskState", "modelAsString": true, "values": [ { "name": "Unavailable", "value": "Unavailable", "description": "Unavailable" }, { "name": "InitialReplicationPending", "value": "InitialReplicationPending", "description": "InitialReplicationPending" }, { "name": "InitialReplicationFailed", "value": "InitialReplicationFailed", "description": "InitialReplicationFailed" }, { "name": "Protected", "value": "Protected", "description": "Protected" } ] } }, "DiskVolumeDetails": { "type": "object", "description": "Volume details.", "properties": { "label": { "type": "string", "description": "The volume label." }, "name": { "type": "string", "description": "The volume name." } } }, "Display": { "type": "object", "description": "Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.", "properties": { "provider": { "type": "string", "description": "The provider. The localized friendly form of the resource provider name - it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"." }, "resource": { "type": "string", "description": "The resource. The localized friendly form of the resource related to this action/operation - it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent's display.resource field). e.g. \"Virtual Machines\" or \"Scheduler Job Collections\", or \"Virtual Machine VM Sizes\" or \"Scheduler Jobs\"." }, "operation": { "type": "string", "description": "The operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'." }, "description": { "type": "string", "description": "The description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise - it will be used in tool tips and detailed views. Prescriptive guidance for namespaces: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespaces: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'." } } }, "DraDetails": { "type": "object", "description": "DRA details.", "properties": { "id": { "type": "string", "description": "The DRA Id.", "readOnly": true }, "name": { "type": "string", "description": "The DRA name.", "readOnly": true }, "biosId": { "type": "string", "description": "The DRA Bios Id.", "readOnly": true }, "version": { "type": "string", "description": "The version.", "readOnly": true }, "lastHeartbeatUtc": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the DRA.", "readOnly": true }, "health": { "$ref": "#/definitions/ProtectionHealth", "description": "The health.", "readOnly": true }, "healthErrors": { "type": "array", "description": "The health errors.", "items": { "$ref": "#/definitions/HealthError" }, "readOnly": true }, "forwardProtectedItemCount": { "type": "integer", "format": "int32", "description": "The count of protected items which are protected in forward direction.", "readOnly": true }, "reverseProtectedItemCount": { "type": "integer", "format": "int32", "description": "The count of protected items which are protected in reverse direction.", "readOnly": true } } }, "EnableMigrationInput": { "type": "object", "description": "Enable migration input.", "properties": { "properties": { "$ref": "#/definitions/EnableMigrationInputProperties", "description": "Enable migration input properties." } }, "required": [ "properties" ] }, "EnableMigrationInputProperties": { "type": "object", "description": "Enable migration input properties.", "properties": { "policyId": { "type": "string", "description": "The policy Id." }, "providerSpecificDetails": { "$ref": "#/definitions/EnableMigrationProviderSpecificInput", "description": "The provider specific details." } }, "required": [ "policyId", "providerSpecificDetails" ] }, "EnableMigrationProviderSpecificInput": { "type": "object", "description": "Enable migration provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "EnableProtectionInput": { "type": "object", "description": "Enable protection input.", "properties": { "properties": { "$ref": "#/definitions/EnableProtectionInputProperties", "description": "Enable protection input properties." } } }, "EnableProtectionInputProperties": { "type": "object", "description": "Enable protection input properties.", "properties": { "policyId": { "type": "string", "description": "The Policy Id." }, "protectableItemId": { "type": "string", "description": "The protectable item Id." }, "providerSpecificDetails": { "$ref": "#/definitions/EnableProtectionProviderSpecificInput", "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." } } }, "EnableProtectionProviderSpecificInput": { "type": "object", "description": "Enable protection provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "EncryptionDetails": { "type": "object", "description": "Encryption details for the fabric.", "properties": { "kekState": { "type": "string", "description": "The key encryption key state for the Vmm." }, "kekCertThumbprint": { "type": "string", "description": "The key encryption key certificate thumbprint." }, "kekCertExpiryDate": { "type": "string", "format": "date-time", "description": "The key encryption key certificate expiry date." } } }, "EthernetAddressType": { "type": "string", "description": "The source IP address type.", "enum": [ "Dynamic", "Static" ], "x-ms-enum": { "name": "EthernetAddressType", "modelAsString": true, "values": [ { "name": "Dynamic", "value": "Dynamic", "description": "Dynamic" }, { "name": "Static", "value": "Static", "description": "Static" } ] } }, "Event": { "type": "object", "description": "Implements the Event class.", "properties": { "properties": { "$ref": "#/definitions/EventProperties", "description": "Event related data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "EventCollection": { "type": "object", "description": "Collection of fabric details.", "properties": { "value": { "type": "array", "description": "The Event items on this page", "items": { "$ref": "#/definitions/Event" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "EventProperties": { "type": "object", "description": "The properties of a monitoring event.", "properties": { "eventCode": { "type": "string", "description": "The Id of the monitoring event." }, "description": { "type": "string", "description": "The event name." }, "eventType": { "type": "string", "description": "The type of the event. for example: VM Health, Server Health, Job Failure etc." }, "affectedObjectFriendlyName": { "type": "string", "description": "The friendly name of the source of the event on which it is raised (for example, VM, VMM etc)." }, "affectedObjectCorrelationId": { "type": "string", "description": "The affected object correlationId for the event." }, "severity": { "type": "string", "description": "The severity of the event." }, "timeOfOccurrence": { "type": "string", "format": "date-time", "description": "The time of occurrence of the event." }, "fabricId": { "type": "string", "description": "The ARM ID of the fabric." }, "providerSpecificDetails": { "$ref": "#/definitions/EventProviderSpecificDetails", "description": "The provider specific settings." }, "eventSpecificDetails": { "$ref": "#/definitions/EventSpecificDetails", "description": "The event specific settings." }, "healthErrors": { "type": "array", "description": "The list of errors / warnings capturing details associated with the issue(s).", "items": { "$ref": "#/definitions/HealthError" } } } }, "EventProviderSpecificDetails": { "type": "object", "description": "Model class for provider specific details for an event.", "properties": { "instanceType": { "type": "string", "description": "Gets the class type. Overridden in derived classes." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "EventSpecificDetails": { "type": "object", "description": "Model class for event specific details for an event.", "properties": { "instanceType": { "type": "string", "description": "Gets the class type. Overridden in derived classes." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ExistingProtectionProfile": { "type": "object", "description": "Existing storage account input.", "properties": { "protectionProfileId": { "type": "string", "description": "The protection profile Arm Id. Throw error, if resource does not exists." } }, "required": [ "protectionProfileId" ], "allOf": [ { "$ref": "#/definitions/ProtectionProfileCustomDetails" } ], "x-ms-discriminator-value": "Existing" }, "ExistingRecoveryAvailabilitySet": { "type": "object", "description": "Existing recovery availability set input.", "properties": { "recoveryAvailabilitySetId": { "type": "string", "description": "The recovery availability set Id. Will throw error, if resource does not exist." } }, "allOf": [ { "$ref": "#/definitions/RecoveryAvailabilitySetCustomDetails" } ], "x-ms-discriminator-value": "Existing" }, "ExistingRecoveryProximityPlacementGroup": { "type": "object", "description": "Existing recovery proximity placement group input.", "properties": { "recoveryProximityPlacementGroupId": { "type": "string", "description": "The recovery proximity placement group Id. Will throw error, if resource does not exist." } }, "allOf": [ { "$ref": "#/definitions/RecoveryProximityPlacementGroupCustomDetails" } ], "x-ms-discriminator-value": "Existing" }, "ExistingRecoveryRecoveryResourceGroup": { "type": "object", "description": "Existing recovery resource group input.", "properties": { "recoveryResourceGroupId": { "type": "string", "description": "The recovery resource group Id. Valid for V2 scenarios." } }, "allOf": [ { "$ref": "#/definitions/RecoveryResourceGroupCustomDetails" } ], "x-ms-discriminator-value": "Existing" }, "ExistingRecoveryVirtualNetwork": { "type": "object", "description": "Existing recovery virtual network input.", "properties": { "recoveryVirtualNetworkId": { "type": "string", "description": "The recovery virtual network Id. Will throw error, if resource does not exist." }, "recoverySubnetName": { "type": "string", "description": "The recovery subnet name." } }, "required": [ "recoveryVirtualNetworkId" ], "allOf": [ { "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails" } ], "x-ms-discriminator-value": "Existing" }, "ExistingStorageAccount": { "type": "object", "description": "Existing storage account input.", "properties": { "azureStorageAccountId": { "type": "string", "description": "The storage account Arm Id. Throw error, if resource does not exists." } }, "required": [ "azureStorageAccountId" ], "allOf": [ { "$ref": "#/definitions/StorageAccountCustomDetails" } ], "x-ms-discriminator-value": "Existing" }, "ExportJobDetails": { "type": "object", "description": "This class represents details for export jobs workflow.", "properties": { "blobUri": { "type": "string", "description": "BlobUri of the exported jobs." }, "sasToken": { "$ref": "#/definitions/SecretString", "description": "The sas token to access blob." } }, "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "x-ms-discriminator-value": "ExportJobDetails" }, "ExportJobOutputSerializationType": { "type": "string", "description": "The output type of the jobs.", "enum": [ "Json", "Xml", "Excel" ], "x-ms-enum": { "name": "ExportJobOutputSerializationType", "modelAsString": true, "values": [ { "name": "Json", "value": "Json", "description": "Json" }, { "name": "Xml", "value": "Xml", "description": "Xml" }, { "name": "Excel", "value": "Excel", "description": "Excel" } ] } }, "ExtendedLocation": { "type": "object", "description": "Extended location of the resource.", "properties": { "name": { "type": "string", "description": "The name of the extended location." }, "type": { "$ref": "#/definitions/ExtendedLocationType", "description": "The extended location type." } }, "required": [ "name", "type" ] }, "ExtendedLocationType": { "type": "string", "description": "The extended location type.", "enum": [ "EdgeZone" ], "x-ms-enum": { "name": "ExtendedLocationType", "modelAsString": true, "values": [ { "name": "EdgeZone", "value": "EdgeZone", "description": "EdgeZone" } ] } }, "Fabric": { "type": "object", "description": "Fabric definition.", "properties": { "properties": { "$ref": "#/definitions/FabricProperties", "description": "Fabric related data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "FabricCollection": { "type": "object", "description": "Collection of fabric details.", "properties": { "value": { "type": "array", "description": "The Fabric items on this page", "items": { "$ref": "#/definitions/Fabric" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "FabricCreationInput": { "type": "object", "description": "Site details provided during the time of site creation.", "properties": { "properties": { "$ref": "#/definitions/FabricCreationInputProperties", "description": "Fabric creation input." } } }, "FabricCreationInputProperties": { "type": "object", "description": "Properties of site details provided during the time of site creation.", "properties": { "customDetails": { "$ref": "#/definitions/FabricSpecificCreationInput", "description": "Fabric provider specific creation input." } } }, "FabricProperties": { "type": "object", "description": "Fabric properties.", "properties": { "friendlyName": { "type": "string", "description": "Friendly name of the fabric." }, "encryptionDetails": { "$ref": "#/definitions/EncryptionDetails", "description": "Encryption details for the fabric." }, "rolloverEncryptionDetails": { "$ref": "#/definitions/EncryptionDetails", "description": "Rollover encryption details for the fabric." }, "internalIdentifier": { "type": "string", "description": "Dra Registration Id." }, "bcdrState": { "type": "string", "description": "BCDR state of the fabric." }, "customDetails": { "$ref": "#/definitions/FabricSpecificDetails", "description": "Fabric specific settings." }, "healthErrorDetails": { "type": "array", "description": "Fabric health error details.", "items": { "$ref": "#/definitions/HealthError" } }, "health": { "type": "string", "description": "Health of fabric." } } }, "FabricReplicationGroupTaskDetails": { "type": "object", "description": "This class represents the fabric replication group task details.", "properties": { "skippedReason": { "type": "string", "description": "The skipped reason." }, "skippedReasonString": { "type": "string", "description": "The skipped reason string." } }, "allOf": [ { "$ref": "#/definitions/JobTaskDetails" } ], "x-ms-discriminator-value": "FabricReplicationGroupTaskDetails" }, "FabricSpecificCreateNetworkMappingInput": { "type": "object", "description": "Input details specific to fabrics during Network Mapping.", "properties": { "instanceType": { "type": "string", "description": "The instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "FabricSpecificCreationInput": { "type": "object", "description": "Fabric provider specific settings.", "properties": { "instanceType": { "type": "string", "description": "Gets the class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "FabricSpecificDetails": { "type": "object", "description": "Fabric specific details.", "properties": { "instanceType": { "type": "string", "description": "Gets the class type. Overridden in derived classes." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "FabricSpecificUpdateNetworkMappingInput": { "type": "object", "description": "Input details specific to fabrics during Network Mapping.", "properties": { "instanceType": { "type": "string", "description": "The instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "FailoverDeploymentModel": { "type": "string", "description": "The failover deployment model.", "enum": [ "NotApplicable", "Classic", "ResourceManager" ], "x-ms-enum": { "name": "FailoverDeploymentModel", "modelAsString": true, "values": [ { "name": "NotApplicable", "value": "NotApplicable", "description": "NotApplicable" }, { "name": "Classic", "value": "Classic", "description": "Classic" }, { "name": "ResourceManager", "value": "ResourceManager", "description": "ResourceManager" } ] } }, "FailoverDirection": { "type": "string", "description": "Failover direction.", "enum": [ "PrimaryToRecovery", "RecoveryToPrimary" ], "x-ms-enum": { "name": "FailoverDirection", "modelAsString": true, "values": [ { "name": "PrimaryToRecovery", "value": "PrimaryToRecovery", "description": "PrimaryToRecovery" }, { "name": "RecoveryToPrimary", "value": "RecoveryToPrimary", "description": "RecoveryToPrimary" } ] } }, "FailoverJobDetails": { "type": "object", "description": "This class represents the details for a failover job.", "properties": { "protectedItemDetails": { "type": "array", "description": "The test VM details.", "items": { "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" } } }, "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "x-ms-discriminator-value": "FailoverJobDetails" }, "FailoverProcessServerRequest": { "type": "object", "description": "Request to failover a process server.", "properties": { "properties": { "$ref": "#/definitions/FailoverProcessServerRequestProperties", "description": "The properties of the PS Failover request." } } }, "FailoverProcessServerRequestProperties": { "type": "object", "description": "The properties of the Failover Process Server request.", "properties": { "containerName": { "type": "string", "description": "The container identifier." }, "sourceProcessServerId": { "type": "string", "description": "The source process server." }, "targetProcessServerId": { "type": "string", "description": "The new process server." }, "vmsToMigrate": { "type": "array", "description": "The VMS to migrate.", "items": { "type": "string" } }, "updateType": { "type": "string", "description": "A value for failover type. It can be systemlevel/serverlevel." } } }, "FailoverReplicationProtectedItemDetails": { "type": "object", "description": "Failover details for a replication protected item.", "properties": { "name": { "type": "string", "description": "The name." }, "friendlyName": { "type": "string", "description": "The friendly name." }, "testVmName": { "type": "string", "description": "The test Vm name." }, "testVmFriendlyName": { "type": "string", "description": "The test Vm friendly name." }, "networkConnectionStatus": { "type": "string", "description": "The network connection status." }, "networkFriendlyName": { "type": "string", "description": "The network friendly name." }, "subnet": { "type": "string", "description": "The network subnet." }, "recoveryPointId": { "type": "string", "description": "The recovery point Id." }, "recoveryPointTime": { "type": "string", "format": "date-time", "description": "The recovery point time." } } }, "GatewayOperationDetails": { "type": "object", "description": "Details of the gateway operation.", "properties": { "state": { "type": "string", "description": "A value indicating the state of gateway operation.", "readOnly": true }, "progressPercentage": { "type": "integer", "format": "int32", "description": "A value indicating the progress percentage of gateway operation.", "readOnly": true }, "timeElapsed": { "type": "integer", "format": "int64", "description": "A value indicating the time elapsed for the operation in milliseconds.", "readOnly": true }, "timeRemaining": { "type": "integer", "format": "int64", "description": "A value indicating the time remaining for the operation in milliseconds.", "readOnly": true }, "uploadSpeed": { "type": "integer", "format": "int64", "description": "A value indicating the upload speed in bytes per second.", "readOnly": true }, "hostName": { "type": "string", "description": "A value indicating the ESXi host name.", "readOnly": true }, "dataStores": { "type": "array", "description": "A value indicating the datastore collection.", "items": { "type": "string" }, "readOnly": true }, "vmwareReadThroughput": { "type": "integer", "format": "int64", "description": "A value indicating the VMware read throughput in bytes per second.", "readOnly": true } } }, "GroupTaskDetails": { "type": "object", "description": "This class represents the group task details when parent child relationship exists in the drill down.", "properties": { "instanceType": { "type": "string", "description": "The type of task details." }, "childTasks": { "type": "array", "description": "The child tasks.", "items": { "$ref": "#/definitions/ASRTask" } } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "HealthError": { "type": "object", "description": "Health Error.", "properties": { "innerHealthErrors": { "type": "array", "description": "The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.", "items": { "$ref": "#/definitions/InnerHealthError" } }, "errorSource": { "type": "string", "description": "Source of error." }, "errorType": { "type": "string", "description": "Type of error." }, "errorLevel": { "type": "string", "description": "Level of error." }, "errorCategory": { "type": "string", "description": "Category of error." }, "errorCode": { "type": "string", "description": "Error code." }, "summaryMessage": { "type": "string", "description": "Summary message of the entity." }, "errorMessage": { "type": "string", "description": "Error message." }, "possibleCauses": { "type": "string", "description": "Possible causes of error." }, "recommendedAction": { "type": "string", "description": "Recommended action to resolve error." }, "creationTimeUtc": { "type": "string", "format": "date-time", "description": "Error creation time (UTC)." }, "recoveryProviderErrorMessage": { "type": "string", "description": "DRA error message." }, "entityId": { "type": "string", "description": "ID of the entity." }, "errorId": { "type": "string", "description": "The health error unique id." }, "customerResolvability": { "$ref": "#/definitions/HealthErrorCustomerResolvability", "description": "Value indicating whether the health error is customer resolvable." } } }, "HealthErrorCategory": { "type": "string", "description": "The category of the health error.", "enum": [ "None", "Replication", "TestFailover", "Configuration", "FabricInfrastructure", "VersionExpiry", "AgentAutoUpdateInfra", "AgentAutoUpdateArtifactDeleted", "AgentAutoUpdateRunAsAccount", "AgentAutoUpdateRunAsAccountExpiry", "AgentAutoUpdateRunAsAccountExpired" ], "x-ms-enum": { "name": "HealthErrorCategory", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Replication", "value": "Replication", "description": "Replication" }, { "name": "TestFailover", "value": "TestFailover", "description": "TestFailover" }, { "name": "Configuration", "value": "Configuration", "description": "Configuration" }, { "name": "FabricInfrastructure", "value": "FabricInfrastructure", "description": "FabricInfrastructure" }, { "name": "VersionExpiry", "value": "VersionExpiry", "description": "VersionExpiry" }, { "name": "AgentAutoUpdateInfra", "value": "AgentAutoUpdateInfra", "description": "AgentAutoUpdateInfra" }, { "name": "AgentAutoUpdateArtifactDeleted", "value": "AgentAutoUpdateArtifactDeleted", "description": "AgentAutoUpdateArtifactDeleted" }, { "name": "AgentAutoUpdateRunAsAccount", "value": "AgentAutoUpdateRunAsAccount", "description": "AgentAutoUpdateRunAsAccount" }, { "name": "AgentAutoUpdateRunAsAccountExpiry", "value": "AgentAutoUpdateRunAsAccountExpiry", "description": "AgentAutoUpdateRunAsAccountExpiry" }, { "name": "AgentAutoUpdateRunAsAccountExpired", "value": "AgentAutoUpdateRunAsAccountExpired", "description": "AgentAutoUpdateRunAsAccountExpired" } ] } }, "HealthErrorCustomerResolvability": { "type": "string", "description": "Value indicating whether the health error is customer resolvable.", "enum": [ "Allowed", "NotAllowed" ], "x-ms-enum": { "name": "HealthErrorCustomerResolvability", "modelAsString": true, "values": [ { "name": "Allowed", "value": "Allowed", "description": "Allowed" }, { "name": "NotAllowed", "value": "NotAllowed", "description": "NotAllowed" } ] } }, "HealthErrorSummary": { "type": "object", "description": "class to define the summary of the health error details.", "properties": { "summaryCode": { "type": "string", "description": "The code of the health error." }, "category": { "$ref": "#/definitions/HealthErrorCategory", "description": "The category of the health error." }, "severity": { "$ref": "#/definitions/Severity", "description": "Severity of error." }, "summaryMessage": { "type": "string", "description": "The summary message of the health error." }, "affectedResourceType": { "type": "string", "description": "The type of affected ARM resource." }, "affectedResourceSubtype": { "type": "string", "description": "The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable." }, "affectedResourceCorrelationIds": { "type": "array", "description": "The list of affected resource correlation Ids. This can be used to uniquely identify the count of items affected by a specific category and severity as well as count of item affected by an specific issue.", "items": { "type": "string" } } } }, "HyperVHostDetails": { "type": "object", "description": "Hyper-V host details.", "properties": { "id": { "type": "string", "description": "The Hyper-V host Id.", "readOnly": true }, "name": { "type": "string", "description": "The Hyper-V host name.", "readOnly": true }, "marsAgentVersion": { "type": "string", "description": "The Mars agent version.", "readOnly": true } } }, "HyperVReplica2012EventDetails": { "type": "object", "description": "Model class for event details of a HyperVReplica E2E event.", "properties": { "containerName": { "type": "string", "description": "The container friendly name." }, "fabricName": { "type": "string", "description": "The fabric friendly name." }, "remoteContainerName": { "type": "string", "description": "The remote container name." }, "remoteFabricName": { "type": "string", "description": "The remote fabric name." } }, "allOf": [ { "$ref": "#/definitions/EventProviderSpecificDetails" } ], "x-ms-discriminator-value": "HyperVReplica2012" }, "HyperVReplica2012R2EventDetails": { "type": "object", "description": "Model class for event details of a HyperVReplica blue E2E event.", "properties": { "containerName": { "type": "string", "description": "The container friendly name." }, "fabricName": { "type": "string", "description": "The fabric friendly name." }, "remoteContainerName": { "type": "string", "description": "The remote container name." }, "remoteFabricName": { "type": "string", "description": "The remote fabric name." } }, "allOf": [ { "$ref": "#/definitions/EventProviderSpecificDetails" } ], "x-ms-discriminator-value": "HyperVReplica2012R2" }, "HyperVReplicaAzureApplyRecoveryPointInput": { "type": "object", "description": "ApplyRecoveryPoint input specific to HyperVReplicaAzure provider.", "properties": { "primaryKekCertificatePfx": { "$ref": "#/definitions/SecretString", "description": "The primary kek certificate pfx." }, "secondaryKekCertificatePfx": { "$ref": "#/definitions/SecretString", "description": "The secondary kek certificate pfx." } }, "allOf": [ { "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaAzureDiskInputDetails": { "type": "object", "description": "Disk input details.", "properties": { "diskId": { "type": "string", "description": "The DiskId." }, "logStorageAccountId": { "type": "string", "description": "The LogStorageAccountId." }, "diskType": { "$ref": "#/definitions/DiskAccountType", "description": "The disk type." }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM ID." }, "sectorSizeInBytes": { "type": "integer", "format": "int32", "description": "The logical sector size (in bytes), 512 by default." }, "iops": { "type": "integer", "format": "int64", "description": "The number of IOPS allowed for Premium V2 and Ultra disks." }, "throughputInMbps": { "type": "integer", "format": "int64", "description": "The total throughput in Mbps for Premium V2 and Ultra disks." }, "diskSizeInGB": { "type": "integer", "format": "int64", "description": "The target disk size in GB." } } }, "HyperVReplicaAzureEnableProtectionInput": { "type": "object", "description": "HyperVReplicaAzure specific enable protection input.", "properties": { "hvHostVmId": { "type": "string", "description": "The Hyper-V host VM Id." }, "vmName": { "type": "string", "description": "The VM Name." }, "osType": { "type": "string", "description": "The OS type associated with VM." }, "userSelectedOSName": { "type": "string", "description": "The OS name selected by user." }, "vhdId": { "type": "string", "description": "The OS disk VHD id associated with VM." }, "targetStorageAccountId": { "type": "string", "description": "The storage account Id." }, "targetAzureNetworkId": { "type": "string", "description": "The selected target Azure network Id." }, "targetAzureSubnetId": { "type": "string", "description": "The selected target Azure subnet Id." }, "enableRdpOnTargetOption": { "type": "string", "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum." }, "targetAzureVmName": { "type": "string", "description": "The target azure VM Name." }, "logStorageAccountId": { "type": "string", "description": "The storage account to be used for logging during replication." }, "disksToInclude": { "type": "array", "description": "The list of VHD Ids of disks to be protected.", "items": { "type": "string" } }, "targetAzureV1ResourceGroupId": { "type": "string", "description": "The Id of the target resource group (for classic deployment) in which the failover VM is to be created." }, "targetAzureV2ResourceGroupId": { "type": "string", "description": "The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created." }, "useManagedDisks": { "type": "string", "description": "A value indicating whether managed disks should be used during failover." }, "targetAvailabilitySetId": { "type": "string", "description": "The target availability set ARM Id for resource manager deployment." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "licenseType": { "$ref": "#/definitions/LicenseType", "description": "License type." }, "sqlServerLicenseType": { "$ref": "#/definitions/SqlServerLicenseType", "description": "The SQL Server license type." }, "linuxLicenseType": { "$ref": "#/definitions/LinuxLicenseType", "description": "The license type for Linux VM's." }, "targetVmSecurityProfile": { "$ref": "#/definitions/SecurityProfileProperties", "description": "The target VM security profile." }, "targetVmSize": { "type": "string", "description": "The target VM size." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The proximity placement group ARM Id." }, "useManagedDisksForReplication": { "type": "string", "description": "A value indicating whether managed disks should be used during replication." }, "diskType": { "$ref": "#/definitions/DiskAccountType", "description": "The disk type." }, "disksToIncludeForManagedDisks": { "type": "array", "description": "The disks to include list for managed disks.", "items": { "$ref": "#/definitions/HyperVReplicaAzureDiskInputDetails" } }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM Id." }, "targetVmTags": { "type": "object", "description": "The target VM tags.", "additionalProperties": { "type": "string" } }, "seedManagedDiskTags": { "type": "object", "description": "The tags for the seed managed disks.", "additionalProperties": { "type": "string" } }, "targetManagedDiskTags": { "type": "object", "description": "The tags for the target managed disks.", "additionalProperties": { "type": "string" } }, "targetNicTags": { "type": "object", "description": "The tags for the target NICs.", "additionalProperties": { "type": "string" } }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "allOf": [ { "$ref": "#/definitions/EnableProtectionProviderSpecificInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaAzureEventDetails": { "type": "object", "description": "Model class for event details of a HyperVReplica E2A event.", "properties": { "containerName": { "type": "string", "description": "The container friendly name." }, "fabricName": { "type": "string", "description": "The fabric friendly name." }, "remoteContainerName": { "type": "string", "description": "The remote container name." } }, "allOf": [ { "$ref": "#/definitions/EventProviderSpecificDetails" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaAzureFailbackProviderInput": { "type": "object", "description": "HyperVReplicaAzureFailback specific planned failover input.", "properties": { "dataSyncOption": { "type": "string", "description": "Data sync option." }, "recoveryVmCreationOption": { "type": "string", "description": "ALR options to create alternate recovery." }, "providerIdForAlternateRecovery": { "type": "string", "description": "Provider Id for alternate location." } }, "allOf": [ { "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzureFailback" }, "HyperVReplicaAzureManagedDiskDetails": { "type": "object", "description": "Hyper-V Managed disk details.", "properties": { "diskId": { "type": "string", "description": "The disk Id." }, "seedManagedDiskId": { "type": "string", "description": "Seed managed disk Id." }, "replicaDiskType": { "type": "string", "description": "The replica disk type." }, "diskEncryptionSetId": { "type": "string", "description": "The disk encryption set ARM Id." }, "targetDiskAccountType": { "$ref": "#/definitions/DiskAccountType", "description": "The disk type." }, "sectorSizeInBytes": { "type": "integer", "format": "int32", "description": "The logical sector size (in bytes), 512 by default." }, "iops": { "type": "integer", "format": "int64", "description": "The number of IOPS allowed for Premium V2 and Ultra disks." }, "throughputInMbps": { "type": "integer", "format": "int64", "description": "The total throughput in Mbps for Premium V2 and Ultra disks." }, "diskSizeInGB": { "type": "integer", "format": "int64", "description": "The target disk size in GB." } } }, "HyperVReplicaAzurePlannedFailoverProviderInput": { "type": "object", "description": "HyperVReplicaAzure specific planned failover input.", "properties": { "primaryKekCertificatePfx": { "$ref": "#/definitions/SecretString", "description": "Primary kek certificate pfx." }, "secondaryKekCertificatePfx": { "$ref": "#/definitions/SecretString", "description": "Secondary kek certificate pfx." }, "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed." }, "osUpgradeVersion": { "type": "string", "description": "A value indicating the inplace OS Upgrade version." }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "allOf": [ { "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaAzurePolicyDetails": { "type": "object", "description": "Hyper-V Replica Azure specific protection profile details.", "properties": { "recoveryPointHistoryDurationInHours": { "type": "integer", "format": "int32", "description": "The duration (in hours) to which point the recovery history needs to be maintained." }, "applicationConsistentSnapshotFrequencyInHours": { "type": "integer", "format": "int32", "description": "The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM." }, "replicationInterval": { "type": "integer", "format": "int32", "description": "The replication interval." }, "onlineReplicationStartTime": { "type": "string", "description": "The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately." }, "encryption": { "type": "string", "description": "A value indicating whether encryption is enabled for virtual machines in this cloud." }, "activeStorageAccountId": { "type": "string", "description": "The active storage account Id." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaAzurePolicyInput": { "type": "object", "description": "Hyper-V Replica Azure specific input for creating a protection profile.", "properties": { "recoveryPointHistoryDuration": { "type": "integer", "format": "int32", "description": "The duration (in hours) to which point the recovery history needs to be maintained." }, "applicationConsistentSnapshotFrequencyInHours": { "type": "integer", "format": "int32", "description": "The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM." }, "replicationInterval": { "type": "integer", "format": "int32", "description": "The replication interval." }, "onlineReplicationStartTime": { "type": "string", "description": "The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately." }, "storageAccounts": { "type": "array", "description": "The list of storage accounts to which the VMs in the primary cloud can replicate to.", "items": { "type": "string" } } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaAzureReplicationDetails": { "type": "object", "description": "Hyper V Replica Azure provider specific settings.", "properties": { "azureVmDiskDetails": { "type": "array", "description": "Azure VM Disk details.", "items": { "$ref": "#/definitions/AzureVmDiskDetails" } }, "recoveryAzureVmName": { "type": "string", "description": "Recovery Azure given name." }, "recoveryAzureVMSize": { "type": "string", "description": "The Recovery Azure VM size." }, "recoveryAzureStorageAccount": { "type": "string", "description": "The recovery Azure storage account." }, "recoveryAzureLogStorageAccountId": { "type": "string", "description": "The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection." }, "lastReplicatedTime": { "type": "string", "format": "date-time", "description": "The Last replication time." }, "rpoInSeconds": { "type": "integer", "format": "int64", "description": "Last RPO value." }, "lastRpoCalculatedTime": { "type": "string", "format": "date-time", "description": "The last RPO calculated time." }, "vmId": { "type": "string", "description": "The virtual machine Id." }, "vmProtectionState": { "type": "string", "description": "The protection state for the vm." }, "vmProtectionStateDescription": { "type": "string", "description": "The protection state description for the vm." }, "initialReplicationDetails": { "$ref": "#/definitions/InitialReplicationDetails", "description": "Initial replication details." }, "vmNics": { "type": "array", "description": "The PE Network details.", "items": { "$ref": "#/definitions/VMNicDetails" } }, "selectedRecoveryAzureNetworkId": { "type": "string", "description": "The selected recovery azure network Id." }, "selectedSourceNicId": { "type": "string", "description": "The selected source nic Id which will be used as the primary nic during failover." }, "encryption": { "type": "string", "description": "The encryption info." }, "oSDetails": { "$ref": "#/definitions/OSDetails", "description": "The operating system info." }, "sourceVmRamSizeInMB": { "type": "integer", "format": "int32", "description": "The RAM size of the VM on the primary side." }, "sourceVmCpuCount": { "type": "integer", "format": "int32", "description": "The CPU count of the VM on the primary side." }, "enableRdpOnTargetOption": { "type": "string", "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum." }, "recoveryAzureResourceGroupId": { "type": "string", "description": "The target resource group Id." }, "recoveryAvailabilitySetId": { "type": "string", "description": "The recovery availability set Id." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The target proximity placement group Id." }, "useManagedDisks": { "type": "string", "description": "A value indicating whether managed disks should be used during failover." }, "licenseType": { "type": "string", "description": "License Type of the VM to be used." }, "sqlServerLicenseType": { "type": "string", "description": "The SQL Server license type." }, "linuxLicenseType": { "$ref": "#/definitions/LinuxLicenseType", "description": "The license type for Linux VM's." }, "lastRecoveryPointReceived": { "type": "string", "format": "date-time", "description": "The last recovery point received time.", "readOnly": true }, "targetVmTags": { "type": "object", "description": "The target VM tags.", "additionalProperties": { "type": "string" } }, "seedManagedDiskTags": { "type": "object", "description": "The tags for the seed managed disks.", "additionalProperties": { "type": "string" } }, "targetManagedDiskTags": { "type": "object", "description": "The tags for the target managed disks.", "additionalProperties": { "type": "string" } }, "targetNicTags": { "type": "object", "description": "The tags for the target NICs.", "additionalProperties": { "type": "string" } }, "protectedManagedDisks": { "type": "array", "description": "The list of protected managed disks.", "items": { "$ref": "#/definitions/HyperVReplicaAzureManagedDiskDetails" }, "x-ms-identifiers": [] }, "allAvailableOSUpgradeConfigurations": { "type": "array", "description": "A value indicating all available inplace OS Upgrade configurations.", "items": { "$ref": "#/definitions/OSUpgradeSupportedVersions" }, "x-ms-identifiers": [] }, "targetVmSecurityProfile": { "$ref": "#/definitions/SecurityProfileProperties", "description": "The target VM security profile." }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaAzureReprotectInput": { "type": "object", "description": "Azure specific reprotect input.", "properties": { "hvHostVmId": { "type": "string", "description": "The Hyper-V host Vm Id." }, "vmName": { "type": "string", "description": "The Vm Name." }, "osType": { "type": "string", "description": "The OS type associated with vm." }, "vHDId": { "type": "string", "description": "The OS disk VHD id associated with vm." }, "storageAccountId": { "type": "string", "description": "The storage account name." }, "logStorageAccountId": { "type": "string", "description": "The storage account to be used for logging during replication." } }, "allOf": [ { "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaAzureRpRecoveryPointType": { "type": "string", "description": "The recovery point type.", "enum": [ "Latest", "LatestApplicationConsistent", "LatestProcessed" ], "x-ms-enum": { "name": "HyperVReplicaAzureRpRecoveryPointType", "modelAsString": true, "values": [ { "name": "Latest", "value": "Latest", "description": "Latest" }, { "name": "LatestApplicationConsistent", "value": "LatestApplicationConsistent", "description": "LatestApplicationConsistent" }, { "name": "LatestProcessed", "value": "LatestProcessed", "description": "LatestProcessed" } ] } }, "HyperVReplicaAzureTestFailoverInput": { "type": "object", "description": "HvrA provider specific input for test failover.", "properties": { "primaryKekCertificatePfx": { "$ref": "#/definitions/SecretString", "description": "Primary kek certificate pfx." }, "secondaryKekCertificatePfx": { "$ref": "#/definitions/SecretString", "description": "Secondary kek certificate pfx." }, "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed." }, "osUpgradeVersion": { "type": "string", "description": "A value indicating the inplace OS Upgrade version." } }, "allOf": [ { "$ref": "#/definitions/TestFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaAzureUnplannedFailoverInput": { "type": "object", "description": "HvrA provider specific input for unplanned failover.", "properties": { "primaryKekCertificatePfx": { "$ref": "#/definitions/SecretString", "description": "Primary kek certificate pfx." }, "secondaryKekCertificatePfx": { "$ref": "#/definitions/SecretString", "description": "Secondary kek certificate pfx." }, "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed." } }, "allOf": [ { "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaAzureUpdateReplicationProtectedItemInput": { "type": "object", "description": "HyperV replica Azure input to update replication protected item.", "properties": { "recoveryAzureV1ResourceGroupId": { "type": "string", "description": "The recovery Azure resource group Id for classic deployment." }, "recoveryAzureV2ResourceGroupId": { "type": "string", "description": "The recovery Azure resource group Id for resource manager deployment." }, "useManagedDisks": { "type": "string", "description": "A value indicating whether managed disks should be used during failover." }, "diskIdToDiskEncryptionMap": { "type": "object", "description": "The dictionary of disk resource Id to disk encryption set ARM Id.", "additionalProperties": { "type": "string" } }, "targetProximityPlacementGroupId": { "type": "string", "description": "The target proximity placement group Id." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetVmTags": { "type": "object", "description": "The target VM tags.", "additionalProperties": { "type": "string" } }, "targetManagedDiskTags": { "type": "object", "description": "The tags for the target managed disks.", "additionalProperties": { "type": "string" } }, "targetNicTags": { "type": "object", "description": "The tags for the target NICs.", "additionalProperties": { "type": "string" } }, "sqlServerLicenseType": { "$ref": "#/definitions/SqlServerLicenseType", "description": "The SQL Server license type." }, "linuxLicenseType": { "$ref": "#/definitions/LinuxLicenseType", "description": "The license type for Linux VM's." }, "userSelectedOSName": { "type": "string", "description": "The OS name selected by user." }, "vmDisks": { "type": "array", "description": "The list of disk update properties.", "items": { "$ref": "#/definitions/UpdateDiskInput" } }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "allOf": [ { "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "HyperVReplicaBaseEventDetails": { "type": "object", "description": "Abstract model class for event details of a HyperVReplica E2E event.", "properties": { "containerName": { "type": "string", "description": "The container friendly name." }, "fabricName": { "type": "string", "description": "The fabric friendly name." }, "remoteContainerName": { "type": "string", "description": "The remote container name." }, "remoteFabricName": { "type": "string", "description": "The remote fabric name." } }, "allOf": [ { "$ref": "#/definitions/EventProviderSpecificDetails" } ], "x-ms-discriminator-value": "HyperVReplicaBaseEventDetails" }, "HyperVReplicaBasePolicyDetails": { "type": "object", "description": "Base class for HyperVReplica policy details.", "properties": { "recoveryPoints": { "type": "integer", "format": "int32", "description": "A value indicating the number of recovery points." }, "applicationConsistentSnapshotFrequencyInHours": { "type": "integer", "format": "int32", "description": "A value indicating the application consistent frequency." }, "compression": { "type": "string", "description": "A value indicating whether compression has to be enabled." }, "initialReplicationMethod": { "type": "string", "description": "A value indicating whether IR is online." }, "onlineReplicationStartTime": { "type": "string", "description": "A value indicating the online IR start time." }, "offlineReplicationImportPath": { "type": "string", "description": "A value indicating the offline IR import path." }, "offlineReplicationExportPath": { "type": "string", "description": "A value indicating the offline IR export path." }, "replicationPort": { "type": "integer", "format": "int32", "description": "A value indicating the recovery HTTPS port." }, "allowedAuthenticationType": { "type": "integer", "format": "int32", "description": "A value indicating the authentication type." }, "replicaDeletionOption": { "type": "string", "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "HyperVReplicaBasePolicyDetails" }, "HyperVReplicaBaseReplicationDetails": { "type": "object", "description": "Hyper V replica provider specific settings base class.", "properties": { "lastReplicatedTime": { "type": "string", "format": "date-time", "description": "The Last replication time." }, "vmNics": { "type": "array", "description": "The PE Network details.", "items": { "$ref": "#/definitions/VMNicDetails" } }, "vmId": { "type": "string", "description": "The virtual machine Id." }, "vmProtectionState": { "type": "string", "description": "The protection state for the vm." }, "vmProtectionStateDescription": { "type": "string", "description": "The protection state description for the vm." }, "initialReplicationDetails": { "$ref": "#/definitions/InitialReplicationDetails", "description": "Initial replication details." }, "vMDiskDetails": { "type": "array", "description": "VM disk details.", "items": { "$ref": "#/definitions/DiskDetails" } } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "HyperVReplicaBaseReplicationDetails" }, "HyperVReplicaBluePolicyDetails": { "type": "object", "description": "Hyper-V Replica Blue specific protection profile details.", "properties": { "replicationFrequencyInSeconds": { "type": "integer", "format": "int32", "description": "A value indicating the replication interval." }, "recoveryPoints": { "type": "integer", "format": "int32", "description": "A value indicating the number of recovery points." }, "applicationConsistentSnapshotFrequencyInHours": { "type": "integer", "format": "int32", "description": "A value indicating the application consistent frequency." }, "compression": { "type": "string", "description": "A value indicating whether compression has to be enabled." }, "initialReplicationMethod": { "type": "string", "description": "A value indicating whether IR is online." }, "onlineReplicationStartTime": { "type": "string", "description": "A value indicating the online IR start time." }, "offlineReplicationImportPath": { "type": "string", "description": "A value indicating the offline IR import path." }, "offlineReplicationExportPath": { "type": "string", "description": "A value indicating the offline IR export path." }, "replicationPort": { "type": "integer", "format": "int32", "description": "A value indicating the recovery HTTPS port." }, "allowedAuthenticationType": { "type": "integer", "format": "int32", "description": "A value indicating the authentication type." }, "replicaDeletionOption": { "type": "string", "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud" } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "HyperVReplica2012R2" }, "HyperVReplicaBluePolicyInput": { "type": "object", "description": "HyperV Replica Blue policy input.", "properties": { "replicationFrequencyInSeconds": { "type": "integer", "format": "int32", "description": "A value indicating the replication interval." } }, "allOf": [ { "$ref": "#/definitions/HyperVReplicaPolicyInput" } ], "x-ms-discriminator-value": "HyperVReplica2012R2" }, "HyperVReplicaBlueReplicationDetails": { "type": "object", "description": "HyperV replica 2012 R2 (Blue) replication details.", "properties": { "lastReplicatedTime": { "type": "string", "format": "date-time", "description": "The Last replication time." }, "vmNics": { "type": "array", "description": "The PE Network details.", "items": { "$ref": "#/definitions/VMNicDetails" } }, "vmId": { "type": "string", "description": "The virtual machine Id." }, "vmProtectionState": { "type": "string", "description": "The protection state for the vm." }, "vmProtectionStateDescription": { "type": "string", "description": "The protection state description for the vm." }, "initialReplicationDetails": { "$ref": "#/definitions/InitialReplicationDetails", "description": "Initial replication details." }, "vMDiskDetails": { "type": "array", "description": "VM disk details.", "items": { "$ref": "#/definitions/DiskDetails" } } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "HyperVReplica2012R2" }, "HyperVReplicaPolicyDetails": { "type": "object", "description": "Hyper-V Replica Blue specific protection profile details.", "properties": { "recoveryPoints": { "type": "integer", "format": "int32", "description": "A value indicating the number of recovery points." }, "applicationConsistentSnapshotFrequencyInHours": { "type": "integer", "format": "int32", "description": "A value indicating the application consistent frequency." }, "compression": { "type": "string", "description": "A value indicating whether compression has to be enabled." }, "initialReplicationMethod": { "type": "string", "description": "A value indicating whether IR is online." }, "onlineReplicationStartTime": { "type": "string", "description": "A value indicating the online IR start time." }, "offlineReplicationImportPath": { "type": "string", "description": "A value indicating the offline IR import path." }, "offlineReplicationExportPath": { "type": "string", "description": "A value indicating the offline IR export path." }, "replicationPort": { "type": "integer", "format": "int32", "description": "A value indicating the recovery HTTPS port." }, "allowedAuthenticationType": { "type": "integer", "format": "int32", "description": "A value indicating the authentication type." }, "replicaDeletionOption": { "type": "string", "description": "A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud" } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "HyperVReplica2012" }, "HyperVReplicaPolicyInput": { "type": "object", "description": "Hyper-V Replica specific policy Input.", "properties": { "recoveryPoints": { "type": "integer", "format": "int32", "description": "A value indicating the number of recovery points." }, "applicationConsistentSnapshotFrequencyInHours": { "type": "integer", "format": "int32", "description": "A value indicating the application consistent frequency." }, "compression": { "type": "string", "description": "A value indicating whether compression has to be enabled." }, "initialReplicationMethod": { "type": "string", "description": "A value indicating whether IR is online." }, "onlineReplicationStartTime": { "type": "string", "description": "A value indicating the online IR start time." }, "offlineReplicationImportPath": { "type": "string", "description": "A value indicating the offline IR import path." }, "offlineReplicationExportPath": { "type": "string", "description": "A value indicating the offline IR export path." }, "replicationPort": { "type": "integer", "format": "int32", "description": "A value indicating the recovery HTTPS port." }, "allowedAuthenticationType": { "type": "integer", "format": "int32", "description": "A value indicating the authentication type." }, "replicaDeletion": { "type": "string", "description": "A value indicating whether the VM has to be auto deleted." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificInput" } ], "x-ms-discriminator-value": "HyperVReplica2012" }, "HyperVReplicaReplicationDetails": { "type": "object", "description": "HyperV replica 2012 replication details.", "properties": { "lastReplicatedTime": { "type": "string", "format": "date-time", "description": "The Last replication time." }, "vmNics": { "type": "array", "description": "The PE Network details.", "items": { "$ref": "#/definitions/VMNicDetails" } }, "vmId": { "type": "string", "description": "The virtual machine Id." }, "vmProtectionState": { "type": "string", "description": "The protection state for the vm." }, "vmProtectionStateDescription": { "type": "string", "description": "The protection state description for the vm." }, "initialReplicationDetails": { "$ref": "#/definitions/InitialReplicationDetails", "description": "Initial replication details." }, "vMDiskDetails": { "type": "array", "description": "VM disk details.", "items": { "$ref": "#/definitions/DiskDetails" } } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "HyperVReplica2012" }, "HyperVSiteDetails": { "type": "object", "description": "HyperVSite fabric specific details.", "properties": { "hyperVHosts": { "type": "array", "description": "The list of Hyper-V hosts associated with the fabric.", "items": { "$ref": "#/definitions/HyperVHostDetails" } } }, "allOf": [ { "$ref": "#/definitions/FabricSpecificDetails" } ], "x-ms-discriminator-value": "HyperVSite" }, "HyperVVirtualMachineDetails": { "type": "object", "description": "Single Host fabric provider specific VM settings.", "properties": { "sourceItemId": { "type": "string", "description": "The source id of the object." }, "generation": { "type": "string", "description": "The id of the object in fabric." }, "osDetails": { "$ref": "#/definitions/OSDetails", "description": "The Last replication time." }, "diskDetails": { "type": "array", "description": "The Last successful failover time.", "items": { "$ref": "#/definitions/DiskDetails" } }, "hasPhysicalDisk": { "$ref": "#/definitions/PresenceStatus", "description": "A value indicating whether the VM has a physical disk attached. String value of SrsDataContract.PresenceStatus enum." }, "hasFibreChannelAdapter": { "$ref": "#/definitions/PresenceStatus", "description": "A value indicating whether the VM has a fibre channel adapter attached. String value of SrsDataContract.PresenceStatus enum." }, "hasSharedVhd": { "$ref": "#/definitions/PresenceStatus", "description": "A value indicating whether the VM has a shared VHD attached. String value of SrsDataContract.PresenceStatus enum." }, "hyperVHostId": { "type": "string", "description": "The Id of the hyper-v host in fabric." } }, "allOf": [ { "$ref": "#/definitions/ConfigurationSettings" } ], "x-ms-discriminator-value": "HyperVVirtualMachine" }, "IPConfigDetails": { "type": "object", "properties": { "name": { "type": "string" }, "isPrimary": { "type": "boolean" }, "subnetName": { "type": "string" }, "staticIPAddress": { "type": "string" }, "ipAddressType": { "type": "string" }, "isSeletedForFailover": { "type": "boolean" }, "recoverySubnetName": { "type": "string" }, "recoveryStaticIPAddress": { "type": "string" }, "recoveryIPAddressType": { "type": "string" }, "recoveryPublicIPAddressId": { "type": "string" }, "recoveryLBBackendAddressPoolIds": { "type": "array", "items": { "type": "string" } }, "tfoSubnetName": { "type": "string" }, "tfoStaticIPAddress": { "type": "string" }, "tfoPublicIPAddressId": { "type": "string" }, "tfoLBBackendAddressPoolIds": { "type": "array", "items": { "type": "string" } }, "ipVersion": { "$ref": "#/definitions/IPVersion", "description": "The IP version (IPv4 / IPv6) of the ip-config, as reported by the service. Read-only - it reflects the discovered NIC configuration and cannot be set by the caller. Orthogonal to the allocation type (static / dynamic). Omitted when IPv6 support is not enabled.", "readOnly": true } } }, "IPConfigInputDetails": { "type": "object", "properties": { "ipConfigName": { "type": "string" }, "isPrimary": { "type": "boolean" }, "isSeletedForFailover": { "type": "boolean" }, "recoverySubnetName": { "type": "string" }, "recoveryStaticIPAddress": { "type": "string" }, "recoveryPublicIPAddressId": { "type": "string" }, "recoveryLBBackendAddressPoolIds": { "type": "array", "items": { "type": "string" } }, "tfoSubnetName": { "type": "string" }, "tfoStaticIPAddress": { "type": "string" }, "tfoPublicIPAddressId": { "type": "string" }, "tfoLBBackendAddressPoolIds": { "type": "array", "items": { "type": "string" } } } }, "IPVersion": { "type": "string", "description": "The IP version (address family) of an ip-config.", "enum": [ "IPv4", "IPv6" ], "x-ms-enum": { "name": "IPVersion", "modelAsString": true, "values": [ { "name": "IPv4", "value": "IPv4", "description": "The ip-config carries an IPv4 address." }, { "name": "IPv6", "value": "IPv6", "description": "The ip-config carries an IPv6 address." } ] } }, "IdentityProviderDetails": { "type": "object", "description": "Identity provider details.", "properties": { "tenantId": { "type": "string", "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services." }, "applicationId": { "type": "string", "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services." }, "objectId": { "type": "string", "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services." }, "audience": { "type": "string", "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services." }, "aadAuthority": { "type": "string", "description": "The base authority for Azure Active Directory authentication." } } }, "IdentityProviderInput": { "type": "object", "description": "Identity provider input.", "properties": { "tenantId": { "type": "string", "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services." }, "applicationId": { "type": "string", "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services." }, "objectId": { "type": "string", "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services." }, "audience": { "type": "string", "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services." }, "aadAuthority": { "type": "string", "description": "The base authority for Azure Active Directory authentication." } }, "required": [ "tenantId", "applicationId", "objectId", "audience", "aadAuthority" ] }, "InMageAgentDetails": { "type": "object", "description": "The details of the InMage agent.", "properties": { "agentVersion": { "type": "string", "description": "The agent version." }, "agentUpdateStatus": { "type": "string", "description": "A value indicating whether installed agent needs to be updated." }, "postUpdateRebootStatus": { "type": "string", "description": "A value indicating whether reboot is required after update is applied." }, "agentExpiryDate": { "type": "string", "format": "date-time", "description": "Agent expiry date." } } }, "InMageAzureV2ApplyRecoveryPointInput": { "type": "object", "description": "ApplyRecoveryPoint input specific to InMageAzureV2 provider.", "allOf": [ { "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2DiskInputDetails": { "type": "object", "description": "Disk input details.", "properties": { "diskId": { "type": "string", "description": "The DiskId." }, "logStorageAccountId": { "type": "string", "description": "The LogStorageAccountId." }, "diskType": { "$ref": "#/definitions/DiskAccountType", "description": "The disk type." }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM ID." } } }, "InMageAzureV2EnableProtectionInput": { "type": "object", "description": "VMware Azure specific enable protection input.", "properties": { "masterTargetId": { "type": "string", "description": "The Master target Id." }, "processServerId": { "type": "string", "description": "The Process Server Id." }, "storageAccountId": { "type": "string", "description": "The storage account Id." }, "runAsAccountId": { "type": "string", "description": "The CS account Id." }, "multiVmGroupId": { "type": "string", "description": "The multi VM group Id." }, "multiVmGroupName": { "type": "string", "description": "The multi VM group name." }, "disksToInclude": { "type": "array", "description": "The disks to include list.", "items": { "$ref": "#/definitions/InMageAzureV2DiskInputDetails" } }, "targetAzureNetworkId": { "type": "string", "description": "The selected target Azure network Id." }, "targetAzureSubnetId": { "type": "string", "description": "The selected target Azure subnet Id." }, "enableRdpOnTargetOption": { "type": "string", "description": "The selected option to enable RDP\\SSH on target VM after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum." }, "targetAzureVmName": { "type": "string", "description": "The target azure VM Name." }, "logStorageAccountId": { "type": "string", "description": "The storage account to be used for logging during replication." }, "targetAzureV1ResourceGroupId": { "type": "string", "description": "The Id of the target resource group (for classic deployment) in which the failover VM is to be created." }, "targetAzureV2ResourceGroupId": { "type": "string", "description": "The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created." }, "diskType": { "$ref": "#/definitions/DiskAccountType", "description": "The disk type." }, "targetAvailabilitySetId": { "type": "string", "description": "The target availability set ARM Id for resource manager deployment." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The proximity placement group ARM Id." }, "licenseType": { "$ref": "#/definitions/LicenseType", "description": "License type." }, "sqlServerLicenseType": { "$ref": "#/definitions/SqlServerLicenseType", "description": "The SQL Server license type." }, "targetVmSize": { "type": "string", "description": "The target VM size." }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM Id." }, "targetVmTags": { "type": "object", "description": "The target VM tags.", "additionalProperties": { "type": "string" } }, "seedManagedDiskTags": { "type": "object", "description": "The tags for the seed managed disks.", "additionalProperties": { "type": "string" } }, "targetManagedDiskTags": { "type": "object", "description": "The tags for the target managed disks.", "additionalProperties": { "type": "string" } }, "targetNicTags": { "type": "object", "description": "The tags for the target NICs.", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "#/definitions/EnableProtectionProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2EventDetails": { "type": "object", "description": "Model class for event details of a VMwareAzureV2 event.", "properties": { "eventType": { "type": "string", "description": "InMage Event type. Takes one of the values of InMageDataContract.InMageMonitoringEventType." }, "category": { "type": "string", "description": "InMage Event Category." }, "component": { "type": "string", "description": "InMage Event Component." }, "correctiveAction": { "type": "string", "description": "Corrective Action string for the event." }, "details": { "type": "string", "description": "InMage Event Details." }, "summary": { "type": "string", "description": "InMage Event Summary." }, "siteName": { "type": "string", "description": "VMware Site name." } }, "allOf": [ { "$ref": "#/definitions/EventProviderSpecificDetails" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2ManagedDiskDetails": { "type": "object", "description": "InMageAzureV2 Managed disk details.", "properties": { "diskId": { "type": "string", "description": "The disk id." }, "seedManagedDiskId": { "type": "string", "description": "Seed managed disk Id." }, "replicaDiskType": { "type": "string", "description": "The replica disk type." }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM ID." }, "targetDiskName": { "type": "string", "description": "The target disk name." } } }, "InMageAzureV2PolicyDetails": { "type": "object", "description": "InMage Azure v2 specific protection profile details.", "properties": { "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency in minutes." }, "recoveryPointThresholdInMinutes": { "type": "integer", "format": "int32", "description": "The recovery point threshold in minutes." }, "recoveryPointHistory": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency in minutes." }, "multiVmSyncStatus": { "type": "string", "description": "A value indicating whether multi-VM sync has to be enabled." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2PolicyInput": { "type": "object", "description": "VMWare Azure specific policy Input.", "properties": { "recoveryPointThresholdInMinutes": { "type": "integer", "format": "int32", "description": "The recovery point threshold in minutes." }, "recoveryPointHistory": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency (in minutes)." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency (in minutes)." }, "multiVmSyncStatus": { "$ref": "#/definitions/SetMultiVmSyncStatus", "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'." } }, "required": [ "multiVmSyncStatus" ], "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2ProtectedDiskDetails": { "type": "object", "description": "InMageAzureV2 protected disk details.", "properties": { "diskId": { "type": "string", "description": "The disk id." }, "diskName": { "type": "string", "description": "The disk name." }, "protectionStage": { "type": "string", "description": "The protection stage." }, "healthErrorCode": { "type": "string", "description": "The health error code for the disk." }, "rpoInSeconds": { "type": "integer", "format": "int64", "description": "The RPO in seconds." }, "resyncRequired": { "type": "string", "description": "A value indicating whether resync is required for this disk." }, "resyncProgressPercentage": { "type": "integer", "format": "int32", "description": "The resync progress percentage." }, "resyncDurationInSeconds": { "type": "integer", "format": "int64", "description": "The resync duration in seconds." }, "diskCapacityInBytes": { "type": "integer", "format": "int64", "description": "The disk capacity in bytes." }, "fileSystemCapacityInBytes": { "type": "integer", "format": "int64", "description": "The disk file system capacity in bytes." }, "sourceDataInMegaBytes": { "type": "number", "format": "double", "description": "The source data transit in MB." }, "psDataInMegaBytes": { "type": "number", "format": "double", "description": "The PS data transit in MB." }, "targetDataInMegaBytes": { "type": "number", "format": "double", "description": "The target data transit in MB." }, "diskResized": { "type": "string", "description": "A value indicating whether disk is resized." }, "lastRpoCalculatedTime": { "type": "string", "format": "date-time", "description": "The last RPO calculated time." }, "resyncProcessedBytes": { "type": "integer", "format": "int64", "description": "The resync processed bytes." }, "resyncTotalTransferredBytes": { "type": "integer", "format": "int64", "description": "The resync total transferred bytes." }, "resyncLast15MinutesTransferredBytes": { "type": "integer", "format": "int64", "description": "The resync last 15 minutes transferred bytes." }, "resyncLastDataTransferTimeUTC": { "type": "string", "format": "date-time", "description": "The last data transfer time in UTC." }, "resyncStartTime": { "type": "string", "format": "date-time", "description": "The resync start time." }, "progressHealth": { "type": "string", "description": "The Progress Health." }, "progressStatus": { "type": "string", "description": "The Progress Status." }, "secondsToTakeSwitchProvider": { "type": "integer", "format": "int64", "description": "The seconds to take for switch provider." } } }, "InMageAzureV2RecoveryPointDetails": { "type": "object", "description": "InMage Azure V2 provider specific recovery point details.", "properties": { "isMultiVmSyncPoint": { "type": "string", "description": "A value indicating whether the recovery point is multi VM consistent." } }, "allOf": [ { "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2ReplicationDetails": { "type": "object", "description": "InMageAzureV2 provider specific settings.", "properties": { "infrastructureVmId": { "type": "string", "description": "The infrastructure VM Id." }, "vCenterInfrastructureId": { "type": "string", "description": "The vCenter infrastructure Id." }, "protectionStage": { "type": "string", "description": "The protection stage." }, "vmId": { "type": "string", "description": "The virtual machine Id." }, "vmProtectionState": { "type": "string", "description": "The protection state for the vm." }, "vmProtectionStateDescription": { "type": "string", "description": "The protection state description for the vm." }, "resyncProgressPercentage": { "type": "integer", "format": "int32", "description": "The resync progress percentage." }, "rpoInSeconds": { "type": "integer", "format": "int64", "description": "The RPO in seconds." }, "compressedDataRateInMB": { "type": "number", "format": "double", "description": "The compressed data change rate in MB." }, "uncompressedDataRateInMB": { "type": "number", "format": "double", "description": "The uncompressed data change rate in MB." }, "ipAddress": { "type": "string", "description": "The source IP address." }, "agentVersion": { "type": "string", "description": "The agent version." }, "agentExpiryDate": { "type": "string", "format": "date-time", "description": "Agent expiry date." }, "isAgentUpdateRequired": { "type": "string", "description": "A value indicating whether installed agent needs to be updated." }, "isRebootAfterUpdateRequired": { "type": "string", "description": "A value indicating whether the source server requires a restart after update." }, "lastHeartbeat": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the source server." }, "processServerId": { "type": "string", "description": "The process server Id." }, "processServerName": { "type": "string", "description": "The process server name." }, "multiVmGroupId": { "type": "string", "description": "The multi vm group Id." }, "multiVmGroupName": { "type": "string", "description": "The multi vm group name." }, "multiVmSyncStatus": { "type": "string", "description": "A value indicating whether multi vm sync is enabled or disabled." }, "protectedDisks": { "type": "array", "description": "The list of protected disks.", "items": { "$ref": "#/definitions/InMageAzureV2ProtectedDiskDetails" } }, "diskResized": { "type": "string", "description": "A value indicating whether any disk is resized for this VM." }, "masterTargetId": { "type": "string", "description": "The master target Id." }, "sourceVmCpuCount": { "type": "integer", "format": "int32", "description": "The CPU count of the VM on the primary side." }, "sourceVmRamSizeInMB": { "type": "integer", "format": "int32", "description": "The RAM size of the VM on the primary side." }, "osType": { "type": "string", "description": "The type of the OS on the VM." }, "vhdName": { "type": "string", "description": "The OS disk VHD name." }, "osDiskId": { "type": "string", "description": "The id of the disk containing the OS." }, "azureVMDiskDetails": { "type": "array", "description": "Azure VM Disk details.", "items": { "$ref": "#/definitions/AzureVmDiskDetails" } }, "recoveryAzureVMName": { "type": "string", "description": "Recovery Azure given name." }, "recoveryAzureVMSize": { "type": "string", "description": "The Recovery Azure VM size." }, "recoveryAzureStorageAccount": { "type": "string", "description": "The recovery Azure storage account." }, "recoveryAzureLogStorageAccountId": { "type": "string", "description": "The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection." }, "vmNics": { "type": "array", "description": "The PE Network details.", "items": { "$ref": "#/definitions/VMNicDetails" } }, "selectedRecoveryAzureNetworkId": { "type": "string", "description": "The selected recovery azure network Id." }, "selectedTfoAzureNetworkId": { "type": "string", "description": "The test failover virtual network." }, "selectedSourceNicId": { "type": "string", "description": "The selected source nic Id which will be used as the primary nic during failover." }, "discoveryType": { "type": "string", "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical." }, "enableRdpOnTargetOption": { "type": "string", "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum." }, "datastores": { "type": "array", "description": "The datastores of the on-premise machine. Value can be list of strings that contain datastore names.", "items": { "type": "string" } }, "targetVmId": { "type": "string", "description": "The ARM Id of the target Azure VM. This value will be null until the VM is failed over. Only after failure it will be populated with the ARM Id of the Azure VM." }, "recoveryAzureResourceGroupId": { "type": "string", "description": "The target resource group Id." }, "recoveryAvailabilitySetId": { "type": "string", "description": "The recovery availability set Id." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The target proximity placement group Id." }, "useManagedDisks": { "type": "string", "description": "A value indicating whether managed disks should be used during failover." }, "licenseType": { "type": "string", "description": "License Type of the VM to be used." }, "sqlServerLicenseType": { "type": "string", "description": "The SQL Server license type." }, "validationErrors": { "type": "array", "description": "The validation errors of the on-premise machine Value can be list of validation errors.", "items": { "$ref": "#/definitions/HealthError" } }, "lastRpoCalculatedTime": { "type": "string", "format": "date-time", "description": "The last RPO calculated time." }, "lastUpdateReceivedTime": { "type": "string", "format": "date-time", "description": "The last update time received from on-prem components." }, "replicaId": { "type": "string", "description": "The replica id of the protected item." }, "osVersion": { "type": "string", "description": "The OS Version of the protected item." }, "protectedManagedDisks": { "type": "array", "description": "The list of protected managed disks.", "items": { "$ref": "#/definitions/InMageAzureV2ManagedDiskDetails" } }, "lastRecoveryPointReceived": { "type": "string", "format": "date-time", "description": "The last recovery point received time.", "readOnly": true }, "firmwareType": { "type": "string", "description": "The firmware type of this protected item." }, "azureVmGeneration": { "type": "string", "description": "The target generation for this protected item." }, "isAdditionalStatsAvailable": { "type": "boolean", "description": "A value indicating whether additional IR stats are available or not." }, "totalDataTransferred": { "type": "integer", "format": "int64", "description": "The total transferred data in bytes." }, "totalProgressHealth": { "type": "string", "description": "The progress health." }, "targetVmTags": { "type": "object", "description": "The target VM tags.", "additionalProperties": { "type": "string" } }, "seedManagedDiskTags": { "type": "object", "description": "The tags for the seed managed disks.", "additionalProperties": { "type": "string" } }, "targetManagedDiskTags": { "type": "object", "description": "The tags for the target managed disks.", "additionalProperties": { "type": "string" } }, "targetNicTags": { "type": "object", "description": "The tags for the target NICs.", "additionalProperties": { "type": "string" } }, "switchProviderBlockingErrorDetails": { "type": "array", "description": "The switch provider blocking error information.", "items": { "$ref": "#/definitions/InMageAzureV2SwitchProviderBlockingErrorDetails" } }, "switchProviderDetails": { "$ref": "#/definitions/InMageAzureV2SwitchProviderDetails", "description": "The switch provider blocking error information." }, "supportedOSVersions": { "type": "array", "description": "A value indicating the inplace OS Upgrade version.", "items": { "type": "string" } }, "allAvailableOSUpgradeConfigurations": { "type": "array", "description": "A value indicating all available inplace OS Upgrade configurations.", "items": { "$ref": "#/definitions/OSUpgradeSupportedVersions" }, "x-ms-identifiers": [] }, "osName": { "type": "string", "description": "The name of the OS on the VM.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2ReprotectInput": { "type": "object", "description": "InMageAzureV2 specific provider input.", "properties": { "masterTargetId": { "type": "string", "description": "The Master target Id." }, "processServerId": { "type": "string", "description": "The Process Server Id." }, "storageAccountId": { "type": "string", "description": "The storage account id." }, "runAsAccountId": { "type": "string", "description": "The CS account Id." }, "policyId": { "type": "string", "description": "The Policy Id." }, "logStorageAccountId": { "type": "string", "description": "The storage account to be used for logging during replication." }, "disksToInclude": { "type": "array", "description": "The disks to include list.", "items": { "type": "string" } } }, "allOf": [ { "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2SwitchProviderBlockingErrorDetails": { "type": "object", "description": "InMageAzureV2 switch provider blocking error details.", "properties": { "errorCode": { "type": "string", "description": "The error code.", "readOnly": true }, "errorMessage": { "type": "string", "description": "The error message.", "readOnly": true }, "possibleCauses": { "type": "string", "description": "The possible causes.", "readOnly": true }, "recommendedAction": { "type": "string", "description": "The recommended action.", "readOnly": true }, "errorMessageParameters": { "type": "object", "description": "The error message parameters.", "additionalProperties": { "type": "string" }, "readOnly": true }, "errorTags": { "type": "object", "description": "The error tags.", "additionalProperties": { "type": "string" }, "readOnly": true } } }, "InMageAzureV2SwitchProviderDetails": { "type": "object", "description": "InMageAzureV2 switch provider details.", "properties": { "targetVaultId": { "type": "string", "description": "The target vault Id.", "readOnly": true }, "targetResourceId": { "type": "string", "description": "The target resource Id.", "readOnly": true }, "targetFabricId": { "type": "string", "description": "The target fabric Id.", "readOnly": true }, "targetApplianceId": { "type": "string", "description": "The target appliance Id.", "readOnly": true } } }, "InMageAzureV2SwitchProviderProviderInput": { "type": "object", "description": "Provider specific input for InMageAzureV2 switch provider.", "properties": { "targetVaultID": { "type": "string", "description": "The target vault Id." }, "targetFabricID": { "type": "string", "description": "The target fabric Id." }, "targetApplianceID": { "type": "string", "description": "The target appliance Id." } }, "required": [ "targetVaultID", "targetFabricID", "targetApplianceID" ], "allOf": [ { "$ref": "#/definitions/SwitchProviderProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2TestFailoverInput": { "type": "object", "description": "InMageAzureV2 provider specific input for test failover.", "properties": { "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed." }, "osUpgradeVersion": { "type": "string", "description": "A value indicating the inplace OS Upgrade version." } }, "allOf": [ { "$ref": "#/definitions/TestFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2UnplannedFailoverInput": { "type": "object", "description": "InMageAzureV2 provider specific input for unplanned failover.", "properties": { "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed." }, "osUpgradeVersion": { "type": "string", "description": "A value indicating the inplace OS Upgrade version." } }, "allOf": [ { "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageAzureV2UpdateReplicationProtectedItemInput": { "type": "object", "description": "InMage Azure V2 input to update replication protected item.", "properties": { "recoveryAzureV1ResourceGroupId": { "type": "string", "description": "The recovery Azure resource group Id for classic deployment." }, "recoveryAzureV2ResourceGroupId": { "type": "string", "description": "The recovery Azure resource group Id for resource manager deployment." }, "useManagedDisks": { "type": "string", "description": "A value indicating whether managed disks should be used during failover." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The target proximity placement group Id." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetVmTags": { "type": "object", "description": "The target VM tags.", "additionalProperties": { "type": "string" } }, "targetManagedDiskTags": { "type": "object", "description": "The tags for the target managed disks.", "additionalProperties": { "type": "string" } }, "targetNicTags": { "type": "object", "description": "The tags for the target NICs.", "additionalProperties": { "type": "string" } }, "sqlServerLicenseType": { "$ref": "#/definitions/SqlServerLicenseType", "description": "The SQL Server license type." }, "vmDisks": { "type": "array", "description": "The list of disk update properties.", "items": { "$ref": "#/definitions/UpdateDiskInput" } } }, "allOf": [ { "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "InMageBasePolicyDetails": { "type": "object", "description": "Base class for the policies of providers using InMage replication.", "properties": { "recoveryPointThresholdInMinutes": { "type": "integer", "format": "int32", "description": "The recovery point threshold in minutes." }, "recoveryPointHistory": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency in minutes." }, "multiVmSyncStatus": { "type": "string", "description": "A value indicating whether multi-VM sync has to be enabled." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "InMageBasePolicyDetails" }, "InMageDisableProtectionProviderSpecificInput": { "type": "object", "description": "InMage disable protection provider specific input.", "properties": { "replicaVmDeletionStatus": { "type": "string", "description": "A value indicating whether the replica VM should be destroyed or retained. Values from Delete and Retain." } }, "allOf": [ { "$ref": "#/definitions/DisableProtectionProviderSpecificInput" } ], "x-ms-discriminator-value": "InMage" }, "InMageDiskDetails": { "type": "object", "description": "VMware/Physical specific Disk Details.", "properties": { "diskId": { "type": "string", "description": "The disk Id." }, "diskName": { "type": "string", "description": "The disk name." }, "diskSizeInMB": { "type": "string", "description": "The disk size in MB." }, "diskType": { "type": "string", "description": "Whether disk is system disk or data disk." }, "diskConfiguration": { "type": "string", "description": "Whether disk is dynamic disk or basic disk." }, "volumeList": { "type": "array", "description": "Volumes of the disk.", "items": { "$ref": "#/definitions/DiskVolumeDetails" } } } }, "InMageDiskExclusionInput": { "type": "object", "description": "DiskExclusionInput when doing enable protection of virtual machine in InMage provider.", "properties": { "volumeOptions": { "type": "array", "description": "The volume label based option for disk exclusion.", "items": { "$ref": "#/definitions/InMageVolumeExclusionOptions" } }, "diskSignatureOptions": { "type": "array", "description": "The guest disk signature based option for disk exclusion.", "items": { "$ref": "#/definitions/InMageDiskSignatureExclusionOptions" } } } }, "InMageDiskSignatureExclusionOptions": { "type": "object", "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", "properties": { "diskSignature": { "type": "string", "description": "The guest signature of disk to be excluded from replication." } } }, "InMageEnableProtectionInput": { "type": "object", "description": "VMware Azure specific enable protection input.", "properties": { "vmFriendlyName": { "type": "string", "description": "The VM Name." }, "masterTargetId": { "type": "string", "description": "The Master Target Id." }, "processServerId": { "type": "string", "description": "The Process Server Id." }, "retentionDrive": { "type": "string", "description": "The retention drive to use on the MT." }, "runAsAccountId": { "type": "string", "description": "The CS account Id." }, "multiVmGroupId": { "type": "string", "description": "The multi VM group Id." }, "multiVmGroupName": { "type": "string", "description": "The multi VM group name." }, "datastoreName": { "type": "string", "description": "The target datastore name." }, "diskExclusionInput": { "$ref": "#/definitions/InMageDiskExclusionInput", "description": "The enable disk exclusion input." }, "disksToInclude": { "type": "array", "description": "The disks to include list.", "items": { "type": "string" } } }, "required": [ "masterTargetId", "processServerId", "retentionDrive", "multiVmGroupId", "multiVmGroupName" ], "allOf": [ { "$ref": "#/definitions/EnableProtectionProviderSpecificInput" } ], "x-ms-discriminator-value": "InMage" }, "InMageFabricSwitchProviderBlockingErrorDetails": { "type": "object", "description": "InMageFabric switch provider blocking error details.", "properties": { "errorCode": { "type": "string", "description": "The error code.", "readOnly": true }, "errorMessage": { "type": "string", "description": "The error message.", "readOnly": true }, "possibleCauses": { "type": "string", "description": "The possible causes.", "readOnly": true }, "recommendedAction": { "type": "string", "description": "The recommended action.", "readOnly": true }, "errorMessageParameters": { "type": "object", "description": "The error message parameters.", "additionalProperties": { "type": "string" }, "readOnly": true }, "errorTags": { "type": "object", "description": "The error tags.", "additionalProperties": { "type": "string" }, "readOnly": true } } }, "InMagePolicyDetails": { "type": "object", "description": "InMage specific protection profile details.", "properties": { "recoveryPointThresholdInMinutes": { "type": "integer", "format": "int32", "description": "The recovery point threshold in minutes." }, "recoveryPointHistory": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency in minutes." }, "multiVmSyncStatus": { "type": "string", "description": "A value indicating whether multi-VM sync has to be enabled." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "InMage" }, "InMagePolicyInput": { "type": "object", "description": "VMWare Azure specific protection profile Input.", "properties": { "recoveryPointThresholdInMinutes": { "type": "integer", "format": "int32", "description": "The recovery point threshold in minutes." }, "recoveryPointHistory": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency (in minutes)." }, "multiVmSyncStatus": { "$ref": "#/definitions/SetMultiVmSyncStatus", "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'." } }, "required": [ "multiVmSyncStatus" ], "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificInput" } ], "x-ms-discriminator-value": "InMage" }, "InMageProtectedDiskDetails": { "type": "object", "description": "InMage protected disk details.", "properties": { "diskId": { "type": "string", "description": "The disk id." }, "diskName": { "type": "string", "description": "The disk name." }, "protectionStage": { "type": "string", "description": "The protection stage." }, "healthErrorCode": { "type": "string", "description": "The health error code for the disk." }, "rpoInSeconds": { "type": "integer", "format": "int64", "description": "The RPO in seconds." }, "resyncRequired": { "type": "string", "description": "A value indicating whether resync is required for this disk." }, "resyncProgressPercentage": { "type": "integer", "format": "int32", "description": "The resync progress percentage." }, "resyncDurationInSeconds": { "type": "integer", "format": "int64", "description": "The resync duration in seconds." }, "diskCapacityInBytes": { "type": "integer", "format": "int64", "description": "The disk capacity in bytes." }, "fileSystemCapacityInBytes": { "type": "integer", "format": "int64", "description": "The file system capacity in bytes." }, "sourceDataInMB": { "type": "number", "format": "double", "description": "The source data transit in MB." }, "psDataInMB": { "type": "number", "format": "double", "description": "The PS data transit in MB." }, "targetDataInMB": { "type": "number", "format": "double", "description": "The target data transit in MB." }, "diskResized": { "type": "string", "description": "A value indicating whether disk is resized." }, "lastRpoCalculatedTime": { "type": "string", "format": "date-time", "description": "The last RPO calculated time." }, "resyncProcessedBytes": { "type": "integer", "format": "int64", "description": "The resync processed bytes." }, "resyncTotalTransferredBytes": { "type": "integer", "format": "int64", "description": "The resync total transferred bytes." }, "resyncLast15MinutesTransferredBytes": { "type": "integer", "format": "int64", "description": "The resync last 15 minutes transferred bytes." }, "resyncLastDataTransferTimeUTC": { "type": "string", "format": "date-time", "description": "The last data transfer time in UTC." }, "resyncStartTime": { "type": "string", "format": "date-time", "description": "The resync start time." }, "progressHealth": { "type": "string", "description": "The Progress Health." }, "progressStatus": { "type": "string", "description": "The Progress Status." } } }, "InMageRcmAddDisksInput": { "type": "object", "description": "InMageRcm add disk(s) input.", "properties": { "disks": { "type": "array", "description": "The list of disk details.", "items": { "$ref": "#/definitions/InMageRcmDiskInput" }, "x-ms-identifiers": [ "diskId" ] } }, "required": [ "disks" ], "allOf": [ { "$ref": "#/definitions/AddDisksProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmAgentReinstallBlockingErrorDetails": { "type": "object", "description": "InMageRcm source agent reinstall blocking error details.", "properties": { "errorCode": { "type": "string", "description": "error code." }, "errorMessage": { "type": "string", "description": "error message." }, "possibleCauses": { "type": "string", "description": "possible causes." }, "recommendedAction": { "type": "string", "description": "recommended action." }, "errorMessageParameters": { "type": "object", "description": "error message parameters.", "additionalProperties": { "type": "string" } }, "errorTags": { "type": "object", "description": "error tags.", "additionalProperties": { "type": "string" } } } }, "InMageRcmAgentUpgradeBlockingErrorDetails": { "type": "object", "description": "InMageRcm source agent upgrade blocking error details.", "properties": { "errorCode": { "type": "string", "description": "The error code.", "readOnly": true }, "errorMessage": { "type": "string", "description": "The error message.", "readOnly": true }, "possibleCauses": { "type": "string", "description": "The possible causes.", "readOnly": true }, "recommendedAction": { "type": "string", "description": "The recommended action.", "readOnly": true }, "errorMessageParameters": { "type": "object", "description": "The error message parameters.", "additionalProperties": { "type": "string" }, "readOnly": true }, "errorTags": { "type": "object", "description": "The error tags.", "additionalProperties": { "type": "string" }, "readOnly": true } } }, "InMageRcmApplianceDetails": { "type": "object", "description": "InMageRcm appliance details.", "properties": { "id": { "type": "string", "description": "The appliance Id.", "readOnly": true }, "name": { "type": "string", "description": "The appliance name.", "readOnly": true }, "fabricArmId": { "type": "string", "description": "The fabric ARM Id.", "readOnly": true }, "processServer": { "$ref": "#/definitions/ProcessServerDetails", "description": "The process server.", "readOnly": true }, "rcmProxy": { "$ref": "#/definitions/RcmProxyDetails", "description": "The of RCM proxy.", "readOnly": true }, "pushInstaller": { "$ref": "#/definitions/PushInstallerDetails", "description": "The push installer.", "readOnly": true }, "replicationAgent": { "$ref": "#/definitions/ReplicationAgentDetails", "description": "The replication agent.", "readOnly": true }, "reprotectAgent": { "$ref": "#/definitions/ReprotectAgentDetails", "description": "The reprotect agent.", "readOnly": true }, "marsAgent": { "$ref": "#/definitions/MarsAgentDetails", "description": "The Mars agent.", "readOnly": true }, "dra": { "$ref": "#/definitions/DraDetails", "description": "The DRA.", "readOnly": true }, "switchProviderBlockingErrorDetails": { "type": "array", "description": "The switch provider blocking error information.", "items": { "$ref": "#/definitions/InMageRcmFabricSwitchProviderBlockingErrorDetails" }, "readOnly": true } } }, "InMageRcmApplianceSpecificDetails": { "type": "object", "description": "InMageRcm appliance specific details.", "properties": { "appliances": { "type": "array", "description": "The list of appliances.", "items": { "$ref": "#/definitions/InMageRcmApplianceDetails" }, "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/ApplianceSpecificDetails" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmApplyRecoveryPointInput": { "type": "object", "description": "ApplyRecoveryPoint input specific to InMageRcm provider.", "properties": { "recoveryPointId": { "type": "string", "description": "The recovery point Id." } }, "required": [ "recoveryPointId" ], "allOf": [ { "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmDiscoveredProtectedVmDetails": { "type": "object", "description": "InMageRcm discovered protected VM details.", "properties": { "vCenterId": { "type": "string", "description": "The VCenter Id.", "readOnly": true }, "vCenterFqdn": { "type": "string", "description": "The VCenter fqdn.", "readOnly": true }, "datastores": { "type": "array", "description": "The list of datastores.", "items": { "type": "string" }, "readOnly": true }, "ipAddresses": { "type": "array", "description": "The list of IP addresses.", "items": { "type": "string" }, "readOnly": true }, "vmwareToolsStatus": { "type": "string", "description": "The VMware tools status.", "readOnly": true }, "powerStatus": { "type": "string", "description": "The VM power status.", "readOnly": true }, "vmFqdn": { "type": "string", "description": "The VM fqdn.", "readOnly": true }, "osName": { "type": "string", "description": "The VM's OS name.", "readOnly": true }, "createdTimestamp": { "type": "string", "format": "date-time", "description": "The SDS created timestamp.", "readOnly": true }, "updatedTimestamp": { "type": "string", "format": "date-time", "description": "The SDS updated timestamp.", "readOnly": true }, "isDeleted": { "type": "boolean", "description": "A value indicating whether the VM is deleted.", "readOnly": true }, "lastDiscoveryTimeInUtc": { "type": "string", "format": "date-time", "description": "The last time when SDS information discovered in SRS.", "readOnly": true } } }, "InMageRcmDiskInput": { "type": "object", "description": "InMageRcm disk input.", "properties": { "diskId": { "type": "string", "description": "The disk Id." }, "logStorageAccountId": { "type": "string", "description": "The log storage account ARM Id." }, "diskType": { "$ref": "#/definitions/DiskAccountType", "description": "The disk type." }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM Id." }, "confidentialDiskEncryptionSetId": { "type": "string", "description": "The ConfidentialDiskEncryptionSet ARM Id." }, "sectorSizeInBytes": { "type": "integer", "format": "int32", "description": "The logical sector size (in bytes), 512 by default." }, "iops": { "type": "integer", "format": "int64", "description": "The number of IOPS allowed for Premium V2 and Ultra disks." }, "throughputInMbps": { "type": "integer", "format": "int64", "description": "The total throughput in Mbps for Premium V2 and Ultra disks." }, "diskSizeInGB": { "type": "integer", "format": "int64", "description": "The target disk size in GB." } }, "required": [ "diskId", "logStorageAccountId", "diskType" ] }, "InMageRcmDisksDefaultInput": { "type": "object", "description": "InMageRcm disk input.", "properties": { "logStorageAccountId": { "type": "string", "description": "The log storage account ARM Id." }, "diskType": { "$ref": "#/definitions/DiskAccountType", "description": "The disk type." }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM Id." }, "confidentialDiskEncryptionSetId": { "type": "string", "description": "The ConfidentialDiskEncryptionSet ARM Id." }, "sectorSizeInBytes": { "type": "integer", "format": "int32", "description": "The logical sector size (in bytes), 512 by default." }, "iops": { "type": "integer", "format": "int64", "description": "The number of IOPS allowed for Premium V2 and Ultra disks." }, "throughputInMbps": { "type": "integer", "format": "int64", "description": "The total throughput in Mbps for Premium V2 and Ultra disks." }, "diskSizeInGB": { "type": "integer", "format": "int64", "description": "The target disk size in GB." } }, "required": [ "logStorageAccountId", "diskType" ] }, "InMageRcmEnableProtectionInput": { "type": "object", "description": "InMageRcm specific enable protection input.", "properties": { "fabricDiscoveryMachineId": { "type": "string", "description": "The ARM Id of discovered machine." }, "disksToInclude": { "type": "array", "description": "The disks to include list.", "items": { "$ref": "#/definitions/InMageRcmDiskInput" } }, "disksDefault": { "$ref": "#/definitions/InMageRcmDisksDefaultInput", "description": "The default disk input." }, "targetResourceGroupId": { "type": "string", "description": "The target resource group ARM Id." }, "targetNetworkId": { "type": "string", "description": "The selected target network ARM Id." }, "testNetworkId": { "type": "string", "description": "The selected test network ARM Id." }, "targetSubnetName": { "type": "string", "description": "The selected target subnet name." }, "testSubnetName": { "type": "string", "description": "The selected test subnet name." }, "targetVmName": { "type": "string", "description": "The target VM name." }, "targetVmSize": { "type": "string", "description": "The target VM size." }, "licenseType": { "$ref": "#/definitions/LicenseType", "description": "The license type." }, "targetAvailabilitySetId": { "type": "string", "description": "The target availability set ARM Id." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The target proximity placement group Id." }, "targetBootDiagnosticsStorageAccountId": { "type": "string", "description": "The target boot diagnostics storage account ARM Id." }, "runAsAccountId": { "type": "string", "description": "The run-as account Id." }, "processServerId": { "type": "string", "description": "The process server Id." }, "multiVmGroupName": { "type": "string", "description": "The multi VM group name." }, "sqlServerLicenseType": { "$ref": "#/definitions/SqlServerLicenseType", "description": "The SQL Server license type." }, "linuxLicenseType": { "$ref": "#/definitions/LinuxLicenseType", "description": "The license type for Linux VM's." }, "targetVmTags": { "type": "array", "description": "The target VM tags.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "seedManagedDiskTags": { "type": "array", "description": "The tags for the seed managed disks.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "targetManagedDiskTags": { "type": "array", "description": "The tags for the target managed disks.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "targetNicTags": { "type": "array", "description": "The tags for the target NICs.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "userSelectedOSName": { "type": "string", "description": "The OS name selected by user." }, "targetVmSecurityProfile": { "$ref": "#/definitions/SecurityProfileProperties", "description": "The target VM security profile." }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." }, "targetExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The target extended location." } }, "required": [ "fabricDiscoveryMachineId", "targetResourceGroupId", "processServerId" ], "allOf": [ { "$ref": "#/definitions/EnableProtectionProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmEventDetails": { "type": "object", "description": "Event details for InMageRcm provider.", "properties": { "protectedItemName": { "type": "string", "description": "The protected item name.", "readOnly": true }, "vmName": { "type": "string", "description": "The protected item name.", "readOnly": true }, "latestAgentVersion": { "type": "string", "description": "The latest agent version.", "readOnly": true }, "jobId": { "type": "string", "description": "The job Id.", "readOnly": true }, "fabricName": { "type": "string", "description": "The fabric name.", "readOnly": true }, "applianceName": { "type": "string", "description": "The appliance name.", "readOnly": true }, "serverType": { "type": "string", "description": "The server type.", "readOnly": true }, "componentDisplayName": { "type": "string", "description": "The component display name.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/EventProviderSpecificDetails" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmFabricCreationInput": { "type": "object", "description": "InMageRcm fabric provider specific settings.", "properties": { "vmwareSiteId": { "type": "string", "description": "The ARM Id of the VMware site." }, "physicalSiteId": { "type": "string", "description": "The ARM Id of the physical site." }, "sourceAgentIdentity": { "$ref": "#/definitions/IdentityProviderInput", "description": "The identity provider input for source agent authentication." } }, "required": [ "vmwareSiteId", "physicalSiteId", "sourceAgentIdentity" ], "allOf": [ { "$ref": "#/definitions/FabricSpecificCreationInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmFabricSpecificDetails": { "type": "object", "description": "InMageRcm fabric specific details.", "properties": { "vmwareSiteId": { "type": "string", "description": "The ARM Id of the VMware site.", "readOnly": true }, "physicalSiteId": { "type": "string", "description": "The ARM Id of the physical site.", "readOnly": true }, "serviceEndpoint": { "type": "string", "description": "The service endpoint.", "readOnly": true }, "serviceResourceId": { "type": "string", "description": "The service resource Id.", "readOnly": true }, "serviceContainerId": { "type": "string", "description": "The service container Id.", "readOnly": true }, "dataPlaneUri": { "type": "string", "description": "The data plane Uri.", "readOnly": true }, "controlPlaneUri": { "type": "string", "description": "The control plane Uri.", "readOnly": true }, "sourceAgentIdentityDetails": { "$ref": "#/definitions/IdentityProviderDetails", "description": "The source agent identity details." }, "processServers": { "type": "array", "description": "The list of process servers.", "items": { "$ref": "#/definitions/ProcessServerDetails" }, "readOnly": true }, "rcmProxies": { "type": "array", "description": "The list of RCM proxies.", "items": { "$ref": "#/definitions/RcmProxyDetails" }, "readOnly": true }, "pushInstallers": { "type": "array", "description": "The list of push installers.", "items": { "$ref": "#/definitions/PushInstallerDetails" }, "readOnly": true }, "replicationAgents": { "type": "array", "description": "The list of replication agents.", "items": { "$ref": "#/definitions/ReplicationAgentDetails" }, "readOnly": true }, "reprotectAgents": { "type": "array", "description": "The list of reprotect agents.", "items": { "$ref": "#/definitions/ReprotectAgentDetails" }, "readOnly": true }, "marsAgents": { "type": "array", "description": "The list of Mars agents.", "items": { "$ref": "#/definitions/MarsAgentDetails" }, "readOnly": true }, "dras": { "type": "array", "description": "The list of DRAs.", "items": { "$ref": "#/definitions/DraDetails" }, "readOnly": true }, "agentDetails": { "type": "array", "description": "The list of agent details.", "items": { "$ref": "#/definitions/AgentDetails" }, "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/FabricSpecificDetails" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmFabricSwitchProviderBlockingErrorDetails": { "type": "object", "description": "InMageRcmFabric switch provider blocking error details.", "properties": { "errorCode": { "type": "string", "description": "The error code.", "readOnly": true }, "errorMessage": { "type": "string", "description": "The error message.", "readOnly": true }, "possibleCauses": { "type": "string", "description": "The possible causes.", "readOnly": true }, "recommendedAction": { "type": "string", "description": "The recommended action.", "readOnly": true }, "errorMessageParameters": { "type": "object", "description": "The error message parameters.", "additionalProperties": { "type": "string" }, "readOnly": true }, "errorTags": { "type": "object", "description": "The error tags.", "additionalProperties": { "type": "string" }, "readOnly": true } } }, "InMageRcmFailbackDiscoveredProtectedVmDetails": { "type": "object", "description": "InMageRcmFailback discovered VM details.", "properties": { "vCenterId": { "type": "string", "description": "The VCenter Id.", "readOnly": true }, "vCenterFqdn": { "type": "string", "description": "The VCenter fqdn.", "readOnly": true }, "datastores": { "type": "array", "description": "The list of datastores.", "items": { "type": "string" }, "readOnly": true }, "ipAddresses": { "type": "array", "description": "The list of IP addresses.", "items": { "type": "string" }, "readOnly": true }, "vmwareToolsStatus": { "type": "string", "description": "The VMware tools status.", "readOnly": true }, "powerStatus": { "type": "string", "description": "The VM power status.", "readOnly": true }, "vmFqdn": { "type": "string", "description": "The VM fqdn.", "readOnly": true }, "osName": { "type": "string", "description": "The VM's OS name.", "readOnly": true }, "createdTimestamp": { "type": "string", "format": "date-time", "description": "The SDS created timestamp.", "readOnly": true }, "updatedTimestamp": { "type": "string", "format": "date-time", "description": "The SDS updated timestamp.", "readOnly": true }, "isDeleted": { "type": "boolean", "description": "A value indicating whether the VM is deleted.", "readOnly": true }, "lastDiscoveryTimeInUtc": { "type": "string", "format": "date-time", "description": "The last time when SDS information discovered in SRS.", "readOnly": true } } }, "InMageRcmFailbackEventDetails": { "type": "object", "description": "Event details for InMageRcmFailback provider.", "properties": { "protectedItemName": { "type": "string", "description": "The protected item name.", "readOnly": true }, "vmName": { "type": "string", "description": "The protected item name.", "readOnly": true }, "applianceName": { "type": "string", "description": "The appliance name.", "readOnly": true }, "serverType": { "type": "string", "description": "The server type.", "readOnly": true }, "componentDisplayName": { "type": "string", "description": "The component display name.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/EventProviderSpecificDetails" } ], "x-ms-discriminator-value": "InMageRcmFailback" }, "InMageRcmFailbackMobilityAgentDetails": { "type": "object", "description": "InMageRcmFailback mobility agent details.", "properties": { "version": { "type": "string", "description": "The agent version.", "readOnly": true }, "latestVersion": { "type": "string", "description": "The latest agent version available.", "readOnly": true }, "driverVersion": { "type": "string", "description": "The driver version.", "readOnly": true }, "latestUpgradableVersionWithoutReboot": { "type": "string", "description": "The latest upgradeable version available without reboot.", "readOnly": true }, "agentVersionExpiryDate": { "type": "string", "format": "date-time", "description": "The agent version expiry date.", "readOnly": true }, "driverVersionExpiryDate": { "type": "string", "format": "date-time", "description": "The driver version expiry date.", "readOnly": true }, "lastHeartbeatUtc": { "type": "string", "format": "date-time", "description": "The time of the last heartbeat received from the agent.", "readOnly": true }, "reasonsBlockingUpgrade": { "type": "array", "description": "The whether update is possible or not.", "items": { "$ref": "#/definitions/AgentUpgradeBlockedReason" }, "readOnly": true }, "isUpgradeable": { "type": "string", "description": "A value indicating whether agent is upgradeable or not.", "readOnly": true } } }, "InMageRcmFailbackNicDetails": { "type": "object", "description": "InMageRcmFailback NIC details.", "properties": { "macAddress": { "type": "string", "description": "The mac address.", "readOnly": true }, "networkName": { "type": "string", "description": "The network name.", "readOnly": true }, "adapterType": { "type": "string", "description": "The adapter type.", "readOnly": true }, "sourceIpAddress": { "type": "string", "description": "The IP address.", "readOnly": true } } }, "InMageRcmFailbackPlannedFailoverProviderInput": { "type": "object", "description": "Provider specific input for InMageRcmFailback failover.", "properties": { "recoveryPointType": { "$ref": "#/definitions/InMageRcmFailbackRecoveryPointType", "description": "The recovery point type." } }, "required": [ "recoveryPointType" ], "allOf": [ { "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput" } ], "x-ms-discriminator-value": "InMageRcmFailback" }, "InMageRcmFailbackPolicyCreationInput": { "type": "object", "description": "InMageRcmFailback policy creation input.", "properties": { "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency (in minutes)." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency (in minutes)." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageRcmFailback" }, "InMageRcmFailbackPolicyDetails": { "type": "object", "description": "InMageRcm failback specific policy details.", "properties": { "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency in minutes." }, "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency in minutes." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "InMageRcmFailback" }, "InMageRcmFailbackProtectedDiskDetails": { "type": "object", "description": "InMageRcmFailback protected disk details.", "properties": { "diskId": { "type": "string", "description": "The disk Id (reported by source agent).", "readOnly": true }, "diskName": { "type": "string", "description": "The disk name.", "readOnly": true }, "isOSDisk": { "type": "string", "description": "A value indicating whether the disk is the OS disk.", "readOnly": true }, "capacityInBytes": { "type": "integer", "format": "int64", "description": "The disk capacity in bytes.", "readOnly": true }, "diskUuid": { "type": "string", "description": "The disk Uuid (reported by vCenter).", "readOnly": true }, "dataPendingInLogDataStoreInMB": { "type": "number", "format": "double", "description": "The data pending in log data store in MB.", "readOnly": true }, "dataPendingAtSourceAgentInMB": { "type": "number", "format": "double", "description": "The data pending at source agent in MB.", "readOnly": true }, "isInitialReplicationComplete": { "type": "string", "description": "A value indicating whether initial replication is complete or not.", "readOnly": true }, "irDetails": { "$ref": "#/definitions/InMageRcmFailbackSyncDetails", "description": "The initial replication details." }, "resyncDetails": { "$ref": "#/definitions/InMageRcmFailbackSyncDetails", "description": "The resync details." }, "lastSyncTime": { "type": "string", "format": "date-time", "description": "The last sync time.", "readOnly": true } } }, "InMageRcmFailbackRecoveryPointType": { "type": "string", "description": "The recovery point type.", "enum": [ "ApplicationConsistent", "CrashConsistent" ], "x-ms-enum": { "name": "InMageRcmFailbackRecoveryPointType", "modelAsString": true, "values": [ { "name": "ApplicationConsistent", "value": "ApplicationConsistent", "description": "ApplicationConsistent" }, { "name": "CrashConsistent", "value": "CrashConsistent", "description": "CrashConsistent" } ] } }, "InMageRcmFailbackReplicationDetails": { "type": "object", "description": "InMageRcmFailback provider specific details.", "properties": { "internalIdentifier": { "type": "string", "description": "The virtual machine internal identifier.", "readOnly": true }, "azureVirtualMachineId": { "type": "string", "description": "The ARM Id of the azure VM.", "readOnly": true }, "multiVmGroupName": { "type": "string", "description": "The multi VM group name.", "readOnly": true }, "reprotectAgentId": { "type": "string", "description": "The reprotect agent Id.", "readOnly": true }, "reprotectAgentName": { "type": "string", "description": "The reprotect agent name.", "readOnly": true }, "osType": { "type": "string", "description": "The type of the OS on the VM.", "readOnly": true }, "logStorageAccountId": { "type": "string", "description": "The log storage account ARM Id.", "readOnly": true }, "targetvCenterId": { "type": "string", "description": "The target vCenter Id.", "readOnly": true }, "targetDataStoreName": { "type": "string", "description": "The target datastore name.", "readOnly": true }, "targetVmName": { "type": "string", "description": "The target VM name.", "readOnly": true }, "initialReplicationProgressPercentage": { "type": "integer", "format": "int32", "description": "The initial replication progress percentage.", "readOnly": true }, "initialReplicationProcessedBytes": { "type": "integer", "format": "int64", "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", "readOnly": true }, "initialReplicationTransferredBytes": { "type": "integer", "format": "int64", "description": "The initial replication transferred bytes from source VM to target for all selected disks on source VM.", "readOnly": true }, "initialReplicationProgressHealth": { "$ref": "#/definitions/VmReplicationProgressHealth", "description": "The initial replication progress health.", "readOnly": true }, "resyncProgressPercentage": { "type": "integer", "format": "int32", "description": "The resync progress percentage.", "readOnly": true }, "resyncProcessedBytes": { "type": "integer", "format": "int64", "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", "readOnly": true }, "resyncTransferredBytes": { "type": "integer", "format": "int64", "description": "The resync transferred bytes from source VM to target for all selected disks on source VM.", "readOnly": true }, "resyncProgressHealth": { "$ref": "#/definitions/VmReplicationProgressHealth", "description": "The resync progress health.", "readOnly": true }, "resyncRequired": { "type": "string", "description": "A value indicating whether resync is required.", "readOnly": true }, "resyncState": { "$ref": "#/definitions/ResyncState", "description": "The resync state.", "readOnly": true }, "protectedDisks": { "type": "array", "description": "The list of protected disks.", "items": { "$ref": "#/definitions/InMageRcmFailbackProtectedDiskDetails" } }, "mobilityAgentDetails": { "$ref": "#/definitions/InMageRcmFailbackMobilityAgentDetails", "description": "The mobility agent information." }, "vmNics": { "type": "array", "description": "The network details.", "items": { "$ref": "#/definitions/InMageRcmFailbackNicDetails" } }, "lastPlannedFailoverStartTime": { "type": "string", "format": "date-time", "description": "The last planned failover start time.", "readOnly": true }, "lastPlannedFailoverStatus": { "$ref": "#/definitions/PlannedFailoverStatus", "description": "The last planned failover status.", "readOnly": true }, "discoveredVmDetails": { "$ref": "#/definitions/InMageRcmFailbackDiscoveredProtectedVmDetails", "description": "The discovered VM information." }, "lastUsedPolicyId": { "type": "string", "description": "The policy Id used by the forward replication.", "readOnly": true }, "lastUsedPolicyFriendlyName": { "type": "string", "description": "The policy friendly name used by the forward replication.", "readOnly": true }, "isAgentRegistrationSuccessfulAfterFailover": { "type": "boolean", "description": "A value indicating whether agent registration was successful after failover.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "InMageRcmFailback" }, "InMageRcmFailbackReprotectInput": { "type": "object", "description": "InMageRcmFailback specific provider input.", "properties": { "processServerId": { "type": "string", "description": "The process server Id." }, "runAsAccountId": { "type": "string", "description": "The run as account Id." }, "policyId": { "type": "string", "description": "The Policy Id." } }, "required": [ "processServerId", "policyId" ], "allOf": [ { "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageRcmFailback" }, "InMageRcmFailbackSyncDetails": { "type": "object", "description": "InMageRcmFailback disk level sync details.", "properties": { "progressHealth": { "$ref": "#/definitions/DiskReplicationProgressHealth", "description": "The progress health.", "readOnly": true }, "transferredBytes": { "type": "integer", "format": "int64", "description": "The transferred bytes from source VM to azure for the disk.", "readOnly": true }, "last15MinutesTransferredBytes": { "type": "integer", "format": "int64", "description": "The bytes transferred in last 15 minutes from source VM to target.", "readOnly": true }, "lastDataTransferTimeUtc": { "type": "string", "description": "The time of the last data transfer from source VM to target.", "readOnly": true }, "processedBytes": { "type": "integer", "format": "int64", "description": "The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes.", "readOnly": true }, "startTime": { "type": "string", "description": "The start time.", "readOnly": true }, "lastRefreshTime": { "type": "string", "description": "The last refresh time.", "readOnly": true }, "progressPercentage": { "type": "integer", "format": "int32", "description": "Progress in percentage. Progress percentage is calculated based on processed bytes.", "readOnly": true } } }, "InMageRcmLastAgentUpgradeErrorDetails": { "type": "object", "description": "InMageRcm last source agent upgrade error details.", "properties": { "errorCode": { "type": "string", "description": "The error code.", "readOnly": true }, "errorMessage": { "type": "string", "description": "The error message.", "readOnly": true }, "possibleCauses": { "type": "string", "description": "The possible causes.", "readOnly": true }, "recommendedAction": { "type": "string", "description": "The recommended action.", "readOnly": true }, "errorMessageParameters": { "type": "object", "description": "The error message parameters.", "additionalProperties": { "type": "string" }, "readOnly": true }, "errorTags": { "type": "object", "description": "The error tags.", "additionalProperties": { "type": "string" }, "readOnly": true } } }, "InMageRcmMobilityAgentDetails": { "type": "object", "description": "InMageRcm mobility agent details.", "properties": { "version": { "type": "string", "description": "The agent version.", "readOnly": true }, "latestVersion": { "type": "string", "description": "The latest agent version available.", "readOnly": true }, "latestAgentReleaseDate": { "type": "string", "description": "The latest agent version release date.", "readOnly": true }, "driverVersion": { "type": "string", "description": "The driver version.", "readOnly": true }, "latestUpgradableVersionWithoutReboot": { "type": "string", "description": "The latest upgradeable version available without reboot.", "readOnly": true }, "agentVersionExpiryDate": { "type": "string", "format": "date-time", "description": "The agent version expiry date.", "readOnly": true }, "driverVersionExpiryDate": { "type": "string", "format": "date-time", "description": "The driver version expiry date.", "readOnly": true }, "lastHeartbeatUtc": { "type": "string", "format": "date-time", "description": "The time of the last heartbeat received from the agent.", "readOnly": true }, "reasonsBlockingUpgrade": { "type": "array", "description": "The whether update is possible or not.", "items": { "$ref": "#/definitions/AgentUpgradeBlockedReason" }, "readOnly": true }, "isUpgradeable": { "type": "string", "description": "A value indicating whether agent is upgradeable or not.", "readOnly": true }, "agentReinstallState": { "$ref": "#/definitions/MobilityAgentReinstallType", "description": "The agent auto reinstall state.", "readOnly": true }, "lastAgentReinstallType": { "type": "string", "description": "The last agent reinstall type.", "readOnly": true }, "agentReinstallJobId": { "type": "string", "description": "The agent reinstall job Id.", "readOnly": true }, "agentReinstallAttemptToVersion": { "type": "string", "description": "The last agent reinstall type.", "readOnly": true }, "osFamilyName": { "type": "string", "description": "The OS family name." }, "distroName": { "type": "string", "description": "The distro name." }, "distroNameForWhichAgentIsInstalled": { "type": "string", "description": "Distro name for which agent is installed." }, "isAgentUpgradeable": { "type": "boolean", "description": "A value indicating whether replication agent upgradeable." }, "isAgentReinstallRequired": { "type": "boolean", "description": "A value indicating whether replication agent reinstallation is required." }, "isLastReinstallSuccessful": { "type": "boolean", "description": "A value indicating whether replication agent reinstallation is required." }, "reasonsBlockingReinstall": { "type": "array", "description": "whether reinstall is possible or not.", "items": { "$ref": "#/definitions/AgentReinstallBlockedReason" }, "readOnly": true }, "reasonsBlockingReinstallDetails": { "type": "array", "description": "whether reinstall is possible or not.", "items": { "$ref": "#/definitions/InMageRcmAgentReinstallBlockingErrorDetails" }, "readOnly": true } } }, "InMageRcmNicDetails": { "type": "object", "description": "InMageRcm NIC details.", "properties": { "nicId": { "type": "string", "description": "The NIC Id.", "readOnly": true }, "isPrimaryNic": { "type": "string", "description": "A value indicating whether this is the primary NIC." }, "isSelectedForFailover": { "type": "string", "description": "A value indicating whether this NIC is selected for failover." }, "sourceIPAddress": { "type": "string", "description": "The source IP address.", "readOnly": true }, "sourceIPAddressType": { "$ref": "#/definitions/EthernetAddressType", "description": "The source IP address type.", "readOnly": true }, "sourceNetworkId": { "type": "string", "description": "Source network Id.", "readOnly": true }, "sourceSubnetName": { "type": "string", "description": "Source subnet name.", "readOnly": true }, "targetIPAddress": { "type": "string", "description": "The target IP address." }, "targetIPAddressType": { "$ref": "#/definitions/EthernetAddressType", "description": "The target IP address type." }, "targetSubnetName": { "type": "string", "description": "Target subnet name." }, "testSubnetName": { "type": "string", "description": "Test subnet name." }, "testIPAddress": { "type": "string", "description": "The test IP address." }, "testIPAddressType": { "$ref": "#/definitions/EthernetAddressType", "description": "The test IP address type." }, "targetNicName": { "type": "string", "description": "The target NIC name." } } }, "InMageRcmNicInput": { "type": "object", "description": "InMageRcm NIC input.", "properties": { "nicId": { "type": "string", "description": "The NIC Id." }, "isPrimaryNic": { "type": "string", "description": "A value indicating whether this is the primary NIC." }, "isSelectedForFailover": { "type": "string", "description": "A value indicating whether this NIC is selected for failover." }, "targetSubnetName": { "type": "string", "description": "Target subnet name." }, "targetStaticIPAddress": { "type": "string", "description": "The target static IP address." }, "testSubnetName": { "type": "string", "description": "The test subnet name." }, "testStaticIPAddress": { "type": "string", "description": "The test static IP address." }, "targetNicName": { "type": "string", "description": "The target NIC name." } }, "required": [ "nicId", "isPrimaryNic" ] }, "InMageRcmPolicyCreationInput": { "type": "object", "description": "InMageRcm policy creation input.", "properties": { "recoveryPointHistoryInMinutes": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency (in minutes)." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency (in minutes)." }, "enableMultiVmSync": { "type": "string", "description": "A value indicating whether multi-VM sync has to be enabled." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmPolicyDetails": { "type": "object", "description": "InMageRcm specific policy details.", "properties": { "recoveryPointHistoryInMinutes": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency in minutes." }, "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency in minutes." }, "enableMultiVmSync": { "type": "string", "description": "A value indicating whether multi-VM sync has to be enabled." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmProtectedDiskDetails": { "type": "object", "description": "InMageRcm protected disk details.", "properties": { "diskId": { "type": "string", "description": "The disk Id.", "readOnly": true }, "diskName": { "type": "string", "description": "The disk name.", "readOnly": true }, "isOSDisk": { "type": "string", "description": "A value indicating whether the disk is the OS disk.", "readOnly": true }, "capacityInBytes": { "type": "integer", "format": "int64", "description": "The disk capacity in bytes.", "readOnly": true }, "diskState": { "$ref": "#/definitions/DiskState", "description": "The disk state.", "readOnly": true }, "logStorageAccountId": { "type": "string", "description": "The log storage account ARM Id.", "readOnly": true }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM Id.", "readOnly": true }, "confidentialDiskEncryptionSetId": { "type": "string", "description": "The ConfidentialDiskEncryptionSet ARM Id.", "readOnly": true }, "seedManagedDiskId": { "type": "string", "description": "The ARM Id of the seed managed disk.", "readOnly": true }, "seedBlobUri": { "type": "string", "description": "The uri of the seed blob.", "readOnly": true }, "targetManagedDiskId": { "type": "string", "description": "The ARM Id of the target managed disk.", "readOnly": true }, "diskType": { "$ref": "#/definitions/DiskAccountType", "description": "The disk type." }, "dataPendingInLogDataStoreInMB": { "type": "number", "format": "double", "description": "The data pending in log data store in MB.", "readOnly": true }, "dataPendingAtSourceAgentInMB": { "type": "number", "format": "double", "description": "The data pending at source agent in MB.", "readOnly": true }, "isInitialReplicationComplete": { "type": "string", "description": "A value indicating whether initial replication is complete or not.", "readOnly": true }, "irDetails": { "$ref": "#/definitions/InMageRcmSyncDetails", "description": "The initial replication details." }, "resyncDetails": { "$ref": "#/definitions/InMageRcmSyncDetails", "description": "The resync details." }, "customTargetDiskName": { "type": "string", "description": "The custom target Azure disk name." }, "sectorSizeInBytes": { "type": "integer", "format": "int32", "description": "The logical sector size (in bytes), 512 by default." }, "iops": { "type": "integer", "format": "int64", "description": "The number of IOPS allowed for Premium V2 and Ultra disks." }, "throughputInMbps": { "type": "integer", "format": "int64", "description": "The total throughput in Mbps for Premium V2 and Ultra disks." }, "diskSizeInGB": { "type": "integer", "format": "int64", "description": "The target disk size in GB." } } }, "InMageRcmProtectionContainerMappingDetails": { "type": "object", "description": "InMageRcm provider specific container mapping details.", "properties": { "enableAgentAutoUpgrade": { "type": "string", "description": "A value indicating whether the flag for enable agent auto upgrade.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmRecoveryPointDetails": { "type": "object", "description": "InMageRcm provider specific recovery point details.", "properties": { "isMultiVmSyncPoint": { "type": "string", "description": "A value indicating whether the recovery point is multi VM consistent.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmReplicationDetails": { "type": "object", "description": "InMageRcm provider specific details.", "properties": { "internalIdentifier": { "type": "string", "description": "The virtual machine internal identifier.", "readOnly": true }, "fabricDiscoveryMachineId": { "type": "string", "description": "The ARM Id of the discovered VM.", "readOnly": true }, "multiVmGroupName": { "type": "string", "description": "The multi VM group name.", "readOnly": true }, "discoveryType": { "type": "string", "description": "The type of the discovered VM.", "readOnly": true }, "processServerId": { "type": "string", "description": "The process server Id.", "readOnly": true }, "processorCoreCount": { "type": "integer", "format": "int32", "description": "The processor core count.", "readOnly": true }, "allocatedMemoryInMB": { "type": "number", "format": "double", "description": "The allocated memory in MB.", "readOnly": true }, "processServerName": { "type": "string", "description": "The process server name.", "readOnly": true }, "runAsAccountId": { "type": "string", "description": "The run-as account Id.", "readOnly": true }, "osType": { "type": "string", "description": "The type of the OS on the VM.", "readOnly": true }, "firmwareType": { "type": "string", "description": "The firmware type.", "readOnly": true }, "primaryNicIpAddress": { "type": "string", "description": "The IP address of the primary network interface.", "readOnly": true }, "targetGeneration": { "type": "string", "description": "The target generation.", "readOnly": true }, "licenseType": { "type": "string", "description": "License Type of the VM to be used." }, "linuxLicenseType": { "$ref": "#/definitions/LinuxLicenseType", "description": "The license type for Linux VM's." }, "storageAccountId": { "type": "string", "description": "The replication storage account ARM Id. This is applicable only for the blob based replication test hook.", "readOnly": true }, "targetVmName": { "type": "string", "description": "Target VM name." }, "targetVmSize": { "type": "string", "description": "The target VM size." }, "targetResourceGroupId": { "type": "string", "description": "The target resource group Id." }, "targetLocation": { "type": "string", "description": "The target location." }, "targetAvailabilitySetId": { "type": "string", "description": "The target availability set Id." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The target extended location." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The target proximity placement group Id." }, "targetBootDiagnosticsStorageAccountId": { "type": "string", "description": "The target boot diagnostics storage account ARM Id." }, "targetNetworkId": { "type": "string", "description": "The target network Id." }, "testNetworkId": { "type": "string", "description": "The test network Id." }, "failoverRecoveryPointId": { "type": "string", "description": "The recovery point Id to which the VM was failed over.", "readOnly": true }, "lastRecoveryPointReceived": { "type": "string", "format": "date-time", "description": "The last recovery point received time.", "readOnly": true }, "lastRpoInSeconds": { "type": "integer", "format": "int64", "description": "The last recovery point objective value.", "readOnly": true }, "lastRpoCalculatedTime": { "type": "string", "format": "date-time", "description": "The last recovery point objective calculated time.", "readOnly": true }, "lastRecoveryPointId": { "type": "string", "description": "The last recovery point Id.", "readOnly": true }, "initialReplicationProgressPercentage": { "type": "integer", "format": "int32", "description": "The initial replication progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", "readOnly": true }, "initialReplicationProcessedBytes": { "type": "integer", "format": "int64", "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", "readOnly": true }, "initialReplicationTransferredBytes": { "type": "integer", "format": "int64", "description": "The initial replication transferred bytes from source VM to azure for all selected disks on source VM.", "readOnly": true }, "initialReplicationProgressHealth": { "$ref": "#/definitions/VmReplicationProgressHealth", "description": "The initial replication progress health.", "readOnly": true }, "resyncProgressPercentage": { "type": "integer", "format": "int32", "description": "The resync progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", "readOnly": true }, "resyncProcessedBytes": { "type": "integer", "format": "int64", "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", "readOnly": true }, "resyncTransferredBytes": { "type": "integer", "format": "int64", "description": "The resync transferred bytes from source VM to azure for all selected disks on source VM.", "readOnly": true }, "resyncProgressHealth": { "$ref": "#/definitions/VmReplicationProgressHealth", "description": "The resync progress health.", "readOnly": true }, "resyncRequired": { "type": "string", "description": "A value indicating whether resync is required.", "readOnly": true }, "resyncState": { "$ref": "#/definitions/ResyncState", "description": "The resync state.", "readOnly": true }, "agentUpgradeState": { "$ref": "#/definitions/MobilityAgentUpgradeState", "description": "The agent auto upgrade state.", "readOnly": true }, "lastAgentUpgradeType": { "type": "string", "description": "The last agent upgrade type.", "readOnly": true }, "agentUpgradeJobId": { "type": "string", "description": "The agent upgrade job Id.", "readOnly": true }, "agentUpgradeAttemptToVersion": { "type": "string", "description": "The agent version to which last agent upgrade was attempted.", "readOnly": true }, "protectedDisks": { "type": "array", "description": "The list of protected disks.", "items": { "$ref": "#/definitions/InMageRcmProtectedDiskDetails" } }, "unprotectedDisks": { "type": "array", "description": "The list of unprotected disks.", "items": { "$ref": "#/definitions/InMageRcmUnProtectedDiskDetails" }, "x-ms-identifiers": [ "diskId" ] }, "isLastUpgradeSuccessful": { "type": "string", "description": "A value indicating whether last agent upgrade was successful or not.", "readOnly": true }, "isAgentRegistrationSuccessfulAfterFailover": { "type": "boolean", "description": "A value indicating whether agent registration was successful after failover.", "readOnly": true }, "mobilityAgentDetails": { "$ref": "#/definitions/InMageRcmMobilityAgentDetails", "description": "The mobility agent information." }, "lastAgentUpgradeErrorDetails": { "type": "array", "description": "The last agent upgrade error information.", "items": { "$ref": "#/definitions/InMageRcmLastAgentUpgradeErrorDetails" } }, "agentUpgradeBlockingErrorDetails": { "type": "array", "description": "The agent upgrade blocking error information.", "items": { "$ref": "#/definitions/InMageRcmAgentUpgradeBlockingErrorDetails" } }, "vmNics": { "type": "array", "description": "The network details.", "items": { "$ref": "#/definitions/InMageRcmNicDetails" } }, "discoveredVmDetails": { "$ref": "#/definitions/InMageRcmDiscoveredProtectedVmDetails", "description": "The discovered VM details." }, "targetVmTags": { "type": "array", "description": "The target VM tags.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "seedManagedDiskTags": { "type": "array", "description": "The tags for the seed managed disks.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "targetManagedDiskTags": { "type": "array", "description": "The tags for the target managed disks.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "targetNicTags": { "type": "array", "description": "The tags for the target NICs.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "sqlServerLicenseType": { "type": "string", "description": "The SQL Server license type." }, "supportedOSVersions": { "type": "array", "description": "A value indicating the inplace OS Upgrade version.", "items": { "type": "string" } }, "osName": { "type": "string", "description": "The OS name associated with VM." }, "targetVmSecurityProfile": { "$ref": "#/definitions/SecurityProfileProperties", "description": "The target VM security profile." }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmReprotectInput": { "type": "object", "description": "InMageRcm specific provider input.", "properties": { "reprotectAgentId": { "type": "string", "description": "The reprotect agent Id." }, "datastoreName": { "type": "string", "description": "The target datastore name." }, "logStorageAccountId": { "type": "string", "description": "The log storage account ARM Id." }, "policyId": { "type": "string", "description": "The Policy Id." } }, "required": [ "reprotectAgentId", "datastoreName", "logStorageAccountId" ], "allOf": [ { "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmSyncDetails": { "type": "object", "description": "InMageRcm disk level sync details.", "properties": { "progressHealth": { "$ref": "#/definitions/DiskReplicationProgressHealth", "description": "The progress health.", "readOnly": true }, "transferredBytes": { "type": "integer", "format": "int64", "description": "The transferred bytes from source VM to azure for the disk.", "readOnly": true }, "last15MinutesTransferredBytes": { "type": "integer", "format": "int64", "description": "The bytes transferred in last 15 minutes from source VM to azure.", "readOnly": true }, "lastDataTransferTimeUtc": { "type": "string", "description": "The time of the last data transfer from source VM to azure.", "readOnly": true }, "processedBytes": { "type": "integer", "format": "int64", "description": "The total processed bytes. This includes bytes that are transferred from source VM to azure and matched bytes.", "readOnly": true }, "startTime": { "type": "string", "description": "The start time.", "readOnly": true }, "lastRefreshTime": { "type": "string", "description": "The last refresh time.", "readOnly": true }, "progressPercentage": { "type": "integer", "format": "int32", "description": "Progress in percentage. Progress percentage is calculated based on processed bytes.", "readOnly": true } } }, "InMageRcmTestFailoverInput": { "type": "object", "description": "InMageRcm provider specific input for test failover.", "properties": { "networkId": { "type": "string", "description": "The test network Id." }, "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed." }, "osUpgradeVersion": { "type": "string", "description": "A value indicating the inplace OS Upgrade version." } }, "allOf": [ { "$ref": "#/definitions/TestFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmUnProtectedDiskDetails": { "type": "object", "description": "InMageRcm un-protected disk details.", "properties": { "diskId": { "type": "string", "description": "The disk Id.", "readOnly": true }, "diskName": { "type": "string", "description": "The disk name.", "readOnly": true }, "capacityInBytes": { "type": "integer", "format": "int64", "description": "The disk capacity in bytes.", "readOnly": true } } }, "InMageRcmUnplannedFailoverInput": { "type": "object", "description": "InMageRcm provider specific input for unplanned failover.", "properties": { "performShutdown": { "type": "string", "description": "A value indicating whether VM is to be shutdown." }, "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed." }, "osUpgradeVersion": { "type": "string", "description": "A value indicating the inplace OS Upgrade version." }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "required": [ "performShutdown" ], "allOf": [ { "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmUpdateApplianceForReplicationProtectedItemInput": { "type": "object", "description": "InMageRcm provider specific input to update appliance for replication protected item.", "properties": { "runAsAccountId": { "type": "string", "description": "The run as account Id." } }, "allOf": [ { "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmUpdateContainerMappingInput": { "type": "object", "description": "InMageRcm update protection container mapping.", "properties": { "enableAgentAutoUpgrade": { "type": "string", "description": "A value indicating whether agent auto upgrade has to be enabled." } }, "required": [ "enableAgentAutoUpgrade" ], "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageRcmUpdateReplicationProtectedItemInput": { "type": "object", "description": "InMageRcm provider specific input to update replication protected item.", "properties": { "targetVmName": { "type": "string", "description": "The target VM name." }, "targetVmSize": { "type": "string", "description": "The target VM size." }, "targetResourceGroupId": { "type": "string", "description": "The target resource group ARM Id." }, "targetAvailabilitySetId": { "type": "string", "description": "The target availability set ARM Id." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The target proximity placement group Id." }, "targetBootDiagnosticsStorageAccountId": { "type": "string", "description": "The target boot diagnostics storage account ARM Id." }, "targetNetworkId": { "type": "string", "description": "The target network ARM Id." }, "testNetworkId": { "type": "string", "description": "The test network ARM Id." }, "vmNics": { "type": "array", "description": "The list of NIC details.", "items": { "$ref": "#/definitions/InMageRcmNicInput" } }, "licenseType": { "$ref": "#/definitions/LicenseType", "description": "The license type." }, "sqlServerLicenseType": { "$ref": "#/definitions/SqlServerLicenseType", "description": "The SQL Server license type." }, "linuxLicenseType": { "$ref": "#/definitions/LinuxLicenseType", "description": "The license type for Linux VM's." }, "userSelectedOSName": { "type": "string", "description": "The OS name selected by user." }, "targetVmTags": { "type": "array", "description": "The target VM tags.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "targetManagedDiskTags": { "type": "array", "description": "The tags for the target managed disks.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "targetNicTags": { "type": "array", "description": "The tags for the target NICs.", "items": { "$ref": "#/definitions/UserCreatedResourceTag" }, "x-ms-identifiers": [ "tagName" ] }, "vmDisks": { "type": "array", "description": "The list of disk update properties.", "items": { "$ref": "#/definitions/UpdateDiskInput" } }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "allOf": [ { "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "InMageReplicationDetails": { "type": "object", "description": "InMage provider specific settings.", "properties": { "activeSiteType": { "type": "string", "description": "The active location of the VM. If the VM is being protected from Azure, this field will take values from { Azure, OnPrem }. If the VM is being protected between two data-centers, this field will be OnPrem always." }, "sourceVmCpuCount": { "type": "integer", "format": "int32", "description": "The CPU count of the VM on the primary side." }, "sourceVmRamSizeInMB": { "type": "integer", "format": "int32", "description": "The RAM size of the VM on the primary side." }, "osDetails": { "$ref": "#/definitions/OSDiskDetails", "description": "The OS details." }, "protectionStage": { "type": "string", "description": "The protection stage." }, "vmId": { "type": "string", "description": "The virtual machine Id." }, "vmProtectionState": { "type": "string", "description": "The protection state for the vm." }, "vmProtectionStateDescription": { "type": "string", "description": "The protection state description for the vm." }, "resyncDetails": { "$ref": "#/definitions/InitialReplicationDetails", "description": "The resync details of the machine." }, "retentionWindowStart": { "type": "string", "format": "date-time", "description": "The retention window start time." }, "retentionWindowEnd": { "type": "string", "format": "date-time", "description": "The retention window end time." }, "compressedDataRateInMB": { "type": "number", "format": "double", "description": "The compressed data change rate in MB." }, "uncompressedDataRateInMB": { "type": "number", "format": "double", "description": "The uncompressed data change rate in MB." }, "rpoInSeconds": { "type": "integer", "format": "int64", "description": "The RPO in seconds." }, "protectedDisks": { "type": "array", "description": "The list of protected disks.", "items": { "$ref": "#/definitions/InMageProtectedDiskDetails" } }, "ipAddress": { "type": "string", "description": "The source IP address." }, "lastHeartbeat": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the source server." }, "processServerId": { "type": "string", "description": "The process server Id." }, "masterTargetId": { "type": "string", "description": "The master target Id." }, "consistencyPoints": { "type": "object", "description": "The collection of Consistency points.", "additionalProperties": { "format": "date-time", "type": "string" } }, "diskResized": { "type": "string", "description": "A value indicating whether any disk is resized for this VM." }, "rebootAfterUpdateStatus": { "type": "string", "description": "A value indicating whether the source server requires a restart after update." }, "multiVmGroupId": { "type": "string", "description": "The multi vm group Id, if any." }, "multiVmGroupName": { "type": "string", "description": "The multi vm group name, if any." }, "multiVmSyncStatus": { "type": "string", "description": "A value indicating whether the multi vm sync is enabled or disabled." }, "agentDetails": { "$ref": "#/definitions/InMageAgentDetails", "description": "The agent details." }, "vCenterInfrastructureId": { "type": "string", "description": "The vCenter infrastructure Id." }, "infrastructureVmId": { "type": "string", "description": "The infrastructure VM Id." }, "vmNics": { "type": "array", "description": "The PE Network details.", "items": { "$ref": "#/definitions/VMNicDetails" } }, "discoveryType": { "type": "string", "description": "A value indicating the discovery type of the machine." }, "azureStorageAccountId": { "type": "string", "description": "A value indicating the underlying Azure storage account. If the VM is not running in Azure, this value shall be set to null." }, "datastores": { "type": "array", "description": "The datastores of the on-premise machine Value can be list of strings that contain datastore names.", "items": { "type": "string" } }, "validationErrors": { "type": "array", "description": "The validation errors of the on-premise machine Value can be list of validation errors.", "items": { "$ref": "#/definitions/HealthError" } }, "lastRpoCalculatedTime": { "type": "string", "format": "date-time", "description": "The last RPO calculated time." }, "lastUpdateReceivedTime": { "type": "string", "format": "date-time", "description": "The last update time received from on-prem components." }, "replicaId": { "type": "string", "description": "The replica id of the protected item." }, "osVersion": { "type": "string", "description": "The OS Version of the protected item." }, "isAdditionalStatsAvailable": { "type": "boolean", "description": "A value indicating whether additional IR stats are available or not." }, "totalDataTransferred": { "type": "integer", "format": "int64", "description": "The total transferred data in bytes." }, "totalProgressHealth": { "type": "string", "description": "The progress health." } }, "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificSettings" } ], "x-ms-discriminator-value": "InMage" }, "InMageReprotectInput": { "type": "object", "description": "InMageAzureV2 specific provider input.", "properties": { "masterTargetId": { "type": "string", "description": "The Master Target Id." }, "processServerId": { "type": "string", "description": "The Process Server Id." }, "retentionDrive": { "type": "string", "description": "The retention drive to use on the MT." }, "runAsAccountId": { "type": "string", "description": "The CS account Id." }, "datastoreName": { "type": "string", "description": "The target datastore name." }, "diskExclusionInput": { "$ref": "#/definitions/InMageDiskExclusionInput", "description": "The enable disk exclusion input." }, "profileId": { "type": "string", "description": "The Policy Id." }, "disksToInclude": { "type": "array", "description": "The disks to include list.", "items": { "type": "string" } } }, "required": [ "masterTargetId", "processServerId", "retentionDrive", "profileId" ], "allOf": [ { "$ref": "#/definitions/ReverseReplicationProviderSpecificInput" } ], "x-ms-discriminator-value": "InMage" }, "InMageTestFailoverInput": { "type": "object", "description": "Provider specific input for InMage test failover.", "properties": { "recoveryPointType": { "$ref": "#/definitions/RecoveryPointType", "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored." }, "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed." } }, "allOf": [ { "$ref": "#/definitions/TestFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "InMage" }, "InMageUnplannedFailoverInput": { "type": "object", "description": "Provider specific input for InMage unplanned failover.", "properties": { "recoveryPointType": { "$ref": "#/definitions/RecoveryPointType", "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored." }, "recoveryPointId": { "type": "string", "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed." } }, "allOf": [ { "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" } ], "x-ms-discriminator-value": "InMage" }, "InMageV2RpRecoveryPointType": { "type": "string", "description": "The recovery point type.", "enum": [ "Latest", "LatestApplicationConsistent", "LatestCrashConsistent", "LatestProcessed" ], "x-ms-enum": { "name": "InMageV2RpRecoveryPointType", "modelAsString": true, "values": [ { "name": "Latest", "value": "Latest", "description": "Latest" }, { "name": "LatestApplicationConsistent", "value": "LatestApplicationConsistent", "description": "LatestApplicationConsistent" }, { "name": "LatestCrashConsistent", "value": "LatestCrashConsistent", "description": "LatestCrashConsistent" }, { "name": "LatestProcessed", "value": "LatestProcessed", "description": "LatestProcessed" } ] } }, "InMageVolumeExclusionOptions": { "type": "object", "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", "properties": { "volumeLabel": { "type": "string", "description": "The volume label. The disk having any volume with this label will be excluded from replication." }, "onlyExcludeIfSingleVolume": { "type": "string", "description": "The value indicating whether to exclude multi volume disk or not. If a disk has multiple volumes and one of the volume has label matching with VolumeLabel this disk will be excluded from replication if OnlyExcludeIfSingleVolume is false." } } }, "InconsistentVmDetails": { "type": "object", "description": "This class stores the monitoring details for consistency check of inconsistent Protected Entity.", "properties": { "vmName": { "type": "string", "description": "The Vm name." }, "cloudName": { "type": "string", "description": "The Cloud name." }, "details": { "type": "array", "description": "The list of details regarding state of the Protected Entity in SRS and On prem.", "items": { "type": "string" } }, "errorIds": { "type": "array", "description": "The list of error ids.", "items": { "type": "string" } } } }, "InitialReplicationDetails": { "type": "object", "description": "Initial replication details.", "properties": { "initialReplicationType": { "type": "string", "description": "Initial replication type." }, "initialReplicationProgressPercentage": { "type": "string", "description": "The initial replication progress percentage." } } }, "InlineWorkflowTaskDetails": { "type": "object", "description": "This class represents the inline workflow task details.", "properties": { "workflowIds": { "type": "array", "description": "The list of child workflow ids.", "items": { "type": "string" } } }, "allOf": [ { "$ref": "#/definitions/GroupTaskDetails" } ], "x-ms-discriminator-value": "InlineWorkflowTaskDetails" }, "InnerHealthError": { "type": "object", "description": "Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.", "properties": { "errorSource": { "type": "string", "description": "Source of error." }, "errorType": { "type": "string", "description": "Type of error." }, "errorLevel": { "type": "string", "description": "Level of error." }, "errorCategory": { "type": "string", "description": "Category of error." }, "errorCode": { "type": "string", "description": "Error code." }, "summaryMessage": { "type": "string", "description": "Summary message of the entity." }, "errorMessage": { "type": "string", "description": "Error message." }, "possibleCauses": { "type": "string", "description": "Possible causes of error." }, "recommendedAction": { "type": "string", "description": "Recommended action to resolve error." }, "creationTimeUtc": { "type": "string", "format": "date-time", "description": "Error creation time (UTC)." }, "recoveryProviderErrorMessage": { "type": "string", "description": "DRA error message." }, "entityId": { "type": "string", "description": "ID of the entity." }, "errorId": { "type": "string", "description": "The health error unique id." }, "customerResolvability": { "$ref": "#/definitions/HealthErrorCustomerResolvability", "description": "Value indicating whether the health error is customer resolvable." } } }, "InputEndpoint": { "type": "object", "properties": { "endpointName": { "type": "string" }, "privatePort": { "type": "integer", "format": "int32" }, "publicPort": { "type": "integer", "format": "int32" }, "protocol": { "type": "string" } } }, "Job": { "type": "object", "description": "Job details.", "properties": { "properties": { "$ref": "#/definitions/JobProperties", "description": "The custom data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "JobCollection": { "type": "object", "description": "Collection of jobs.", "properties": { "value": { "type": "array", "description": "The Job items on this page", "items": { "$ref": "#/definitions/Job" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "JobDetails": { "type": "object", "description": "Job details based on specific job type.", "properties": { "instanceType": { "type": "string", "description": "Gets the type of job details (see JobDetailsTypes enum for possible values)." }, "affectedObjectDetails": { "type": "object", "description": "The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details.", "additionalProperties": { "type": "string" } } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "JobEntity": { "type": "object", "description": "This class contains the minimal job details required to navigate to the desired drill down.", "properties": { "jobId": { "type": "string", "description": "The job id." }, "jobFriendlyName": { "type": "string", "description": "The job display name." }, "targetObjectId": { "type": "string", "description": "The object id." }, "targetObjectName": { "type": "string", "description": "The object name." }, "targetInstanceType": { "type": "string", "description": "The workflow affected object type." }, "jobScenarioName": { "type": "string", "description": "The job name. Enum type ScenarioName." } } }, "JobErrorDetails": { "type": "object", "description": "This class contains the error details per object.", "properties": { "serviceErrorDetails": { "$ref": "#/definitions/ServiceError", "description": "The Service error details." }, "providerErrorDetails": { "$ref": "#/definitions/ProviderError", "description": "The Provider error details." }, "errorLevel": { "type": "string", "description": "Error level of error." }, "creationTime": { "type": "string", "format": "date-time", "description": "The creation time of job error." }, "taskId": { "type": "string", "description": "The Id of the task." } } }, "JobProperties": { "type": "object", "description": "Job custom data details.", "properties": { "activityId": { "type": "string", "description": "The activity id." }, "scenarioName": { "type": "string", "description": "The ScenarioName." }, "friendlyName": { "type": "string", "description": "The DisplayName." }, "state": { "type": "string", "description": "The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other." }, "stateDescription": { "type": "string", "description": "The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped." }, "tasks": { "type": "array", "description": "The tasks.", "items": { "$ref": "#/definitions/ASRTask" } }, "errors": { "type": "array", "description": "The errors.", "items": { "$ref": "#/definitions/JobErrorDetails" } }, "startTime": { "type": "string", "format": "date-time", "description": "The start time." }, "endTime": { "type": "string", "format": "date-time", "description": "The end time." }, "allowedActions": { "type": "array", "description": "The Allowed action the job.", "items": { "type": "string" } }, "targetObjectId": { "type": "string", "description": "The affected Object Id." }, "targetObjectName": { "type": "string", "description": "The name of the affected object." }, "targetInstanceType": { "type": "string", "description": "The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class." }, "customDetails": { "$ref": "#/definitions/JobDetails", "description": "The custom job details like test failover job details." } } }, "JobQueryParameter": { "type": "object", "description": "Query parameter to enumerate jobs.", "properties": { "startTime": { "type": "string", "description": "Date time to get jobs from." }, "endTime": { "type": "string", "description": "Date time to get jobs upto." }, "fabricId": { "type": "string", "description": "The Id of the fabric to search jobs under." }, "affectedObjectTypes": { "type": "string", "description": "The type of objects." }, "jobStatus": { "type": "string", "description": "The states of the job to be filtered can be in." }, "jobOutputType": { "$ref": "#/definitions/ExportJobOutputSerializationType", "description": "The output type of the jobs." }, "jobName": { "type": "string", "description": "The job Name." }, "timezoneOffset": { "type": "number", "format": "double", "description": "The timezone offset for the location of the request (in minutes)." } } }, "JobStatusEventDetails": { "type": "object", "description": "Model class for event details of a job status event.", "properties": { "jobId": { "type": "string", "description": "Job arm id for the event." }, "jobFriendlyName": { "type": "string", "description": "JobName for the Event." }, "jobStatus": { "type": "string", "description": "JobStatus for the Event." }, "affectedObjectType": { "type": "string", "description": "AffectedObjectType for the event." } }, "allOf": [ { "$ref": "#/definitions/EventSpecificDetails" } ], "x-ms-discriminator-value": "JobStatus" }, "JobTaskDetails": { "type": "object", "description": "This class represents a task which is actually a workflow so that one can navigate to its individual drill down.", "properties": { "jobTask": { "$ref": "#/definitions/JobEntity", "description": "The job entity." } }, "allOf": [ { "$ref": "#/definitions/TaskTypeDetails" } ], "x-ms-discriminator-value": "JobTaskDetails" }, "KeyEncryptionKeyInfo": { "type": "object", "description": "Key Encryption Key (KEK) information.", "properties": { "keyIdentifier": { "type": "string", "description": "The key URL / identifier." }, "keyVaultResourceArmId": { "type": "string", "description": "The KeyVault resource ARM Id for key." } } }, "LicenseType": { "type": "string", "description": "License type.", "enum": [ "NotSpecified", "NoLicenseType", "WindowsServer" ], "x-ms-enum": { "name": "LicenseType", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified" }, { "name": "NoLicenseType", "value": "NoLicenseType", "description": "NoLicenseType" }, { "name": "WindowsServer", "value": "WindowsServer", "description": "WindowsServer" } ] } }, "LinuxLicenseType": { "type": "string", "description": "The license type for Linux VM's.", "enum": [ "NotSpecified", "NoLicenseType", "LinuxServer" ], "x-ms-enum": { "name": "LinuxLicenseType", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified" }, { "name": "NoLicenseType", "value": "NoLicenseType", "description": "NoLicenseType" }, { "name": "LinuxServer", "value": "LinuxServer", "description": "LinuxServer" } ] } }, "LogicalNetwork": { "type": "object", "description": "Logical network data model.", "properties": { "properties": { "$ref": "#/definitions/LogicalNetworkProperties", "description": "The Logical Network Properties." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "LogicalNetworkCollection": { "type": "object", "description": "List of logical networks.", "properties": { "value": { "type": "array", "description": "The LogicalNetwork items on this page", "items": { "$ref": "#/definitions/LogicalNetwork" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "LogicalNetworkProperties": { "type": "object", "description": "Logical Network Properties.", "properties": { "friendlyName": { "type": "string", "description": "The Friendly Name." }, "networkVirtualizationStatus": { "type": "string", "description": "A value indicating whether Network Virtualization is enabled for the logical network." }, "logicalNetworkUsage": { "type": "string", "description": "A value indicating whether logical network is used as private test network by test failover." }, "logicalNetworkDefinitionsStatus": { "type": "string", "description": "A value indicating whether logical network definitions are isolated." } } }, "ManagedRunCommandScriptInput": { "type": "object", "description": "Managed RunCommand script input", "properties": { "stepName": { "type": "string", "description": "The step name." }, "scriptUrl": { "type": "string", "description": "The script url." }, "scriptParameters": { "type": "string", "description": "The script parameters." } }, "required": [ "stepName", "scriptUrl", "scriptParameters" ] }, "ManualActionTaskDetails": { "type": "object", "description": "This class represents the manual action task details.", "properties": { "name": { "type": "string", "description": "The name." }, "instructions": { "type": "string", "description": "The instructions." }, "observation": { "type": "string", "description": "The observation." } }, "allOf": [ { "$ref": "#/definitions/TaskTypeDetails" } ], "x-ms-discriminator-value": "ManualActionTaskDetails" }, "MarsAgentDetails": { "type": "object", "description": "Mars agent details.", "properties": { "id": { "type": "string", "description": "The Mars agent Id.", "readOnly": true }, "name": { "type": "string", "description": "The Mars agent name.", "readOnly": true }, "biosId": { "type": "string", "description": "The Mars agent Bios Id.", "readOnly": true }, "fabricObjectId": { "type": "string", "description": "The fabric object Id.", "readOnly": true }, "fqdn": { "type": "string", "description": "The Mars agent Fqdn.", "readOnly": true }, "version": { "type": "string", "description": "The version.", "readOnly": true }, "lastHeartbeatUtc": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the Mars agent.", "readOnly": true }, "health": { "$ref": "#/definitions/ProtectionHealth", "description": "The health of the Mars agent.", "readOnly": true }, "healthErrors": { "type": "array", "description": "The health errors.", "items": { "$ref": "#/definitions/HealthError" }, "readOnly": true } } }, "MasterTargetServer": { "type": "object", "description": "Details of a Master Target Server.", "properties": { "id": { "type": "string", "description": "The server Id." }, "ipAddress": { "type": "string", "description": "The IP address of the server." }, "name": { "type": "string", "description": "The server name." }, "osType": { "type": "string", "description": "The OS type of the server." }, "agentVersion": { "type": "string", "description": "The version of the scout component on the server." }, "lastHeartbeat": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the server." }, "versionStatus": { "type": "string", "description": "Version status." }, "retentionVolumes": { "type": "array", "description": "The retention volumes of Master target Server.", "items": { "$ref": "#/definitions/RetentionVolume" } }, "dataStores": { "type": "array", "description": "The list of data stores in the fabric.", "items": { "$ref": "#/definitions/DataStore" } }, "validationErrors": { "type": "array", "description": "Validation errors.", "items": { "$ref": "#/definitions/HealthError" } }, "healthErrors": { "type": "array", "description": "Health errors.", "items": { "$ref": "#/definitions/HealthError" } }, "diskCount": { "type": "integer", "format": "int32", "description": "Disk count of the master target." }, "osVersion": { "type": "string", "description": "OS Version of the master target." }, "agentExpiryDate": { "type": "string", "format": "date-time", "description": "Agent expiry date." }, "marsAgentVersion": { "type": "string", "description": "MARS agent version." }, "marsAgentExpiryDate": { "type": "string", "format": "date-time", "description": "MARS agent expiry date." }, "agentVersionDetails": { "$ref": "#/definitions/VersionDetails", "description": "Agent version details." }, "marsAgentVersionDetails": { "$ref": "#/definitions/VersionDetails", "description": "Mars agent version details." } } }, "MigrateInput": { "type": "object", "description": "Input for migrate.", "properties": { "properties": { "$ref": "#/definitions/MigrateInputProperties", "description": "Migrate input properties." } }, "required": [ "properties" ] }, "MigrateInputProperties": { "type": "object", "description": "Migrate input properties.", "properties": { "providerSpecificDetails": { "$ref": "#/definitions/MigrateProviderSpecificInput", "description": "The provider specific details." } }, "required": [ "providerSpecificDetails" ] }, "MigrateProviderSpecificInput": { "type": "object", "description": "Migrate provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "MigrationItem": { "type": "object", "description": "Migration item.", "properties": { "properties": { "$ref": "#/definitions/MigrationItemProperties", "description": "The migration item properties." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "MigrationItemCollection": { "type": "object", "description": "Migration item collection.", "properties": { "value": { "type": "array", "description": "The MigrationItem items on this page", "items": { "$ref": "#/definitions/MigrationItem" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "MigrationItemOperation": { "type": "string", "description": "The allowed operations on the migration item based on the current migration state of the item.", "enum": [ "DisableMigration", "TestMigrate", "TestMigrateCleanup", "Migrate", "StartResync", "PauseReplication", "ResumeReplication" ], "x-ms-enum": { "name": "MigrationItemOperation", "modelAsString": true, "values": [ { "name": "DisableMigration", "value": "DisableMigration", "description": "DisableMigration" }, { "name": "TestMigrate", "value": "TestMigrate", "description": "TestMigrate" }, { "name": "TestMigrateCleanup", "value": "TestMigrateCleanup", "description": "TestMigrateCleanup" }, { "name": "Migrate", "value": "Migrate", "description": "Migrate" }, { "name": "StartResync", "value": "StartResync", "description": "StartResync" }, { "name": "PauseReplication", "value": "PauseReplication", "description": "PauseReplication" }, { "name": "ResumeReplication", "value": "ResumeReplication", "description": "ResumeReplication" } ] } }, "MigrationItemProperties": { "type": "object", "description": "Migration item properties.", "properties": { "machineName": { "type": "string", "description": "The on-premise virtual machine name.", "readOnly": true }, "policyId": { "type": "string", "description": "The ARM Id of policy governing this item.", "readOnly": true }, "policyFriendlyName": { "type": "string", "description": "The name of policy governing this item.", "readOnly": true }, "recoveryServicesProviderId": { "type": "string", "description": "The recovery services provider ARM Id.", "readOnly": true }, "replicationStatus": { "type": "string", "description": "The replication status.", "readOnly": true }, "migrationState": { "$ref": "#/definitions/MigrationState", "description": "The migration status.", "readOnly": true }, "migrationStateDescription": { "type": "string", "description": "The migration state description.", "readOnly": true }, "lastTestMigrationTime": { "type": "string", "format": "date-time", "description": "The last test migration time.", "readOnly": true }, "lastTestMigrationStatus": { "type": "string", "description": "The status of the last test migration.", "readOnly": true }, "lastMigrationTime": { "type": "string", "format": "date-time", "description": "The last migration time.", "readOnly": true }, "lastMigrationStatus": { "type": "string", "description": "The status of the last migration.", "readOnly": true }, "testMigrateState": { "$ref": "#/definitions/TestMigrationState", "description": "The test migrate state.", "readOnly": true }, "testMigrateStateDescription": { "type": "string", "description": "The test migrate state description.", "readOnly": true }, "health": { "$ref": "#/definitions/ProtectionHealth", "description": "The consolidated health.", "readOnly": true }, "healthErrors": { "type": "array", "description": "The list of health errors.", "items": { "$ref": "#/definitions/HealthError" }, "readOnly": true }, "allowedOperations": { "type": "array", "description": "The allowed operations on the migration item based on the current migration state of the item.", "items": { "$ref": "#/definitions/MigrationItemOperation" }, "readOnly": true }, "currentJob": { "$ref": "#/definitions/CurrentJobDetails", "description": "The current job details.", "readOnly": true }, "criticalJobHistory": { "type": "array", "description": "The critical past job details.", "items": { "$ref": "#/definitions/CriticalJobHistoryDetails" }, "readOnly": true, "x-ms-identifiers": [] }, "eventCorrelationId": { "type": "string", "description": "The correlation Id for events associated with this migration item.", "readOnly": true }, "providerSpecificDetails": { "$ref": "#/definitions/MigrationProviderSpecificSettings", "description": "The migration provider custom settings." } } }, "MigrationProviderSpecificSettings": { "type": "object", "description": "Migration provider specific settings.", "properties": { "instanceType": { "type": "string", "description": "Gets the instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "MigrationRecoveryPoint": { "type": "object", "description": "Recovery point for a migration item.", "properties": { "properties": { "$ref": "#/definitions/MigrationRecoveryPointProperties", "description": "Recovery point properties." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "MigrationRecoveryPointCollection": { "type": "object", "description": "Collection of migration recovery points.", "properties": { "value": { "type": "array", "description": "The MigrationRecoveryPoint items on this page", "items": { "$ref": "#/definitions/MigrationRecoveryPoint" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "MigrationRecoveryPointProperties": { "type": "object", "description": "Migration item recovery point properties.", "properties": { "recoveryPointTime": { "type": "string", "format": "date-time", "description": "The recovery point time.", "readOnly": true }, "recoveryPointType": { "$ref": "#/definitions/MigrationRecoveryPointType", "description": "The recovery point type.", "readOnly": true } } }, "MigrationRecoveryPointType": { "type": "string", "description": "The recovery point type.", "enum": [ "NotSpecified", "ApplicationConsistent", "CrashConsistent" ], "x-ms-enum": { "name": "MigrationRecoveryPointType", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified" }, { "name": "ApplicationConsistent", "value": "ApplicationConsistent", "description": "ApplicationConsistent" }, { "name": "CrashConsistent", "value": "CrashConsistent", "description": "CrashConsistent" } ] } }, "MigrationState": { "type": "string", "description": "The migration status.", "enum": [ "None", "EnableMigrationInProgress", "EnableMigrationFailed", "DisableMigrationInProgress", "DisableMigrationFailed", "InitialSeedingInProgress", "InitialSeedingFailed", "Replicating", "MigrationInProgress", "MigrationSucceeded", "MigrationFailed", "ResumeInProgress", "ResumeInitiated", "SuspendingProtection", "ProtectionSuspended", "MigrationCompletedWithInformation", "MigrationPartiallySucceeded" ], "x-ms-enum": { "name": "MigrationState", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "EnableMigrationInProgress", "value": "EnableMigrationInProgress", "description": "EnableMigrationInProgress" }, { "name": "EnableMigrationFailed", "value": "EnableMigrationFailed", "description": "EnableMigrationFailed" }, { "name": "DisableMigrationInProgress", "value": "DisableMigrationInProgress", "description": "DisableMigrationInProgress" }, { "name": "DisableMigrationFailed", "value": "DisableMigrationFailed", "description": "DisableMigrationFailed" }, { "name": "InitialSeedingInProgress", "value": "InitialSeedingInProgress", "description": "InitialSeedingInProgress" }, { "name": "InitialSeedingFailed", "value": "InitialSeedingFailed", "description": "InitialSeedingFailed" }, { "name": "Replicating", "value": "Replicating", "description": "Replicating" }, { "name": "MigrationInProgress", "value": "MigrationInProgress", "description": "MigrationInProgress" }, { "name": "MigrationSucceeded", "value": "MigrationSucceeded", "description": "MigrationSucceeded" }, { "name": "MigrationFailed", "value": "MigrationFailed", "description": "MigrationFailed" }, { "name": "ResumeInProgress", "value": "ResumeInProgress", "description": "ResumeInProgress" }, { "name": "ResumeInitiated", "value": "ResumeInitiated", "description": "ResumeInitiated" }, { "name": "SuspendingProtection", "value": "SuspendingProtection", "description": "SuspendingProtection" }, { "name": "ProtectionSuspended", "value": "ProtectionSuspended", "description": "ProtectionSuspended" }, { "name": "MigrationCompletedWithInformation", "value": "MigrationCompletedWithInformation", "description": "MigrationCompletedWithInformation" }, { "name": "MigrationPartiallySucceeded", "value": "MigrationPartiallySucceeded", "description": "MigrationPartiallySucceeded" } ] } }, "MobilityAgentReinstallType": { "type": "string", "enum": [ "UserTriggered", "AutoTriggered" ], "x-ms-enum": { "name": "MobilityAgentReinstallType", "modelAsString": true, "values": [ { "name": "UserTriggered", "value": "UserTriggered", "description": "UserTriggered" }, { "name": "AutoTriggered", "value": "AutoTriggered", "description": "AutoTriggered" } ] } }, "MobilityAgentUpgradeState": { "type": "string", "description": "The agent auto upgrade state.", "enum": [ "None", "Started", "Completed", "Commit" ], "x-ms-enum": { "name": "MobilityAgentUpgradeState", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Started", "value": "Started", "description": "Started" }, { "name": "Completed", "value": "Completed", "description": "Completed" }, { "name": "Commit", "value": "Commit", "description": "Commit" } ] } }, "MobilityServiceUpdate": { "type": "object", "description": "The Mobility Service update details.", "properties": { "version": { "type": "string", "description": "The version of the latest update." }, "rebootStatus": { "type": "string", "description": "The reboot status of the update - whether it is required or not." }, "osType": { "type": "string", "description": "The OS type." } } }, "MultiVmGroupCreateOption": { "type": "string", "description": "Whether Multi VM group is auto created or specified by user.", "enum": [ "AutoCreated", "UserSpecified" ], "x-ms-enum": { "name": "MultiVmGroupCreateOption", "modelAsString": true, "values": [ { "name": "AutoCreated", "value": "AutoCreated", "description": "AutoCreated" }, { "name": "UserSpecified", "value": "UserSpecified", "description": "UserSpecified" } ] } }, "MultiVmSyncPointOption": { "type": "string", "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", "enum": [ "UseMultiVmSyncRecoveryPoint", "UsePerVmRecoveryPoint" ], "x-ms-enum": { "name": "MultiVmSyncPointOption", "modelAsString": true, "values": [ { "name": "UseMultiVmSyncRecoveryPoint", "value": "UseMultiVmSyncRecoveryPoint", "description": "UseMultiVmSyncRecoveryPoint" }, { "name": "UsePerVmRecoveryPoint", "value": "UsePerVmRecoveryPoint", "description": "UsePerVmRecoveryPoint" } ] } }, "Network": { "type": "object", "description": "Network model.", "properties": { "properties": { "$ref": "#/definitions/NetworkProperties", "description": "The Network Properties." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "NetworkCollection": { "type": "object", "description": "List of networks.", "properties": { "value": { "type": "array", "description": "The Network items on this page", "items": { "$ref": "#/definitions/Network" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "NetworkMapping": { "type": "object", "description": "Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate extensions in subsequent versions.", "properties": { "properties": { "$ref": "#/definitions/NetworkMappingProperties", "description": "The Network Mapping Properties." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "NetworkMappingCollection": { "type": "object", "description": "List of network mappings. As with NetworkMapping, it should be possible to reuse a prev version of this class. It doesn't seem likely this class could be anything more than a slightly bespoke collection of NetworkMapping. Hence it makes sense to override Load with Base.NetworkMapping instead of existing CurrentVersion.NetworkMapping.", "properties": { "value": { "type": "array", "description": "The NetworkMapping items on this page", "items": { "$ref": "#/definitions/NetworkMapping" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "NetworkMappingFabricSpecificSettings": { "type": "object", "description": "Network Mapping fabric specific settings.", "properties": { "instanceType": { "type": "string", "description": "Gets the Instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "NetworkMappingProperties": { "type": "object", "description": "Network Mapping Properties.", "properties": { "state": { "type": "string", "description": "The pairing state for network mapping." }, "primaryNetworkFriendlyName": { "type": "string", "description": "The primary network friendly name." }, "primaryNetworkId": { "type": "string", "description": "The primary network id for network mapping." }, "primaryFabricFriendlyName": { "type": "string", "description": "The primary fabric friendly name." }, "recoveryNetworkFriendlyName": { "type": "string", "description": "The recovery network friendly name." }, "recoveryNetworkId": { "type": "string", "description": "The recovery network id for network mapping." }, "recoveryFabricArmId": { "type": "string", "description": "The recovery fabric ARM id." }, "recoveryFabricFriendlyName": { "type": "string", "description": "The recovery fabric friendly name." }, "fabricSpecificSettings": { "$ref": "#/definitions/NetworkMappingFabricSpecificSettings", "description": "The fabric specific settings." } } }, "NetworkProperties": { "type": "object", "description": "Network Properties.", "properties": { "fabricType": { "type": "string", "description": "The Fabric Type." }, "subnets": { "type": "array", "description": "The List of subnets.", "items": { "$ref": "#/definitions/Subnet" } }, "friendlyName": { "type": "string", "description": "The Friendly Name." }, "networkType": { "type": "string", "description": "The Network Type." } } }, "NewProtectionProfile": { "type": "object", "description": "New Protection profile input.", "properties": { "policyName": { "type": "string", "description": "The protection profile input." }, "recoveryPointHistory": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency (in minutes)." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency (in minutes)." }, "multiVmSyncStatus": { "$ref": "#/definitions/SetMultiVmSyncStatus", "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'." } }, "required": [ "policyName", "multiVmSyncStatus" ], "allOf": [ { "$ref": "#/definitions/ProtectionProfileCustomDetails" } ], "x-ms-discriminator-value": "New" }, "NewRecoveryVirtualNetwork": { "type": "object", "description": "Recovery virtual network input to create new virtual network from given source network.", "properties": { "recoveryVirtualNetworkResourceGroupName": { "type": "string", "description": "The name of the resource group to be used to create the recovery virtual network. If absent, target network would be created in the same resource group as target VM." }, "recoveryVirtualNetworkName": { "type": "string", "description": "The recovery virtual network name." } }, "allOf": [ { "$ref": "#/definitions/RecoveryVirtualNetworkCustomDetails" } ], "x-ms-discriminator-value": "New" }, "OSDetails": { "type": "object", "description": "Disk Details.", "properties": { "osType": { "type": "string", "description": "VM Disk details." }, "productType": { "type": "string", "description": "Product type." }, "osEdition": { "type": "string", "description": "The OSEdition." }, "oSVersion": { "type": "string", "description": "The OS Version." }, "oSMajorVersion": { "type": "string", "description": "The OS Major Version." }, "oSMinorVersion": { "type": "string", "description": "The OS Minor Version." }, "userSelectedOSName": { "type": "string", "description": "The OS name selected by user." } } }, "OSDiskDetails": { "type": "object", "description": "Details of the OS Disk.", "properties": { "osVhdId": { "type": "string", "description": "The id of the disk containing the OS." }, "osType": { "type": "string", "description": "The type of the OS on the VM." }, "vhdName": { "type": "string", "description": "The OS disk VHD name." } } }, "OSUpgradeSupportedVersions": { "type": "object", "description": "Supported OS upgrade versions.", "properties": { "supportedSourceOsVersion": { "type": "string", "description": "The source OS version name.", "readOnly": true }, "supportedTargetOsVersions": { "type": "array", "description": "The target OS version names.", "items": { "type": "string" }, "readOnly": true } } }, "OSVersionWrapper": { "type": "object", "description": "Wrapper model for OSVersion to include version and service pack info.", "properties": { "version": { "type": "string", "description": "The version." }, "servicePack": { "type": "string", "description": "The service pack." } } }, "OperationsDiscovery": { "type": "object", "description": "Operations discovery class.", "properties": { "name": { "type": "string", "description": "Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: * Microsoft.Compute/virtualMachine/capture/action * Microsoft.Compute/virtualMachine/restart/action * Microsoft.Compute/virtualMachine/write * Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the \"{Resource Provider Namespace}/register/action\" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release)." }, "display": { "$ref": "#/definitions/Display", "description": "Object type." }, "origin": { "type": "string", "description": "Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is \"user,system\"." }, "properties": { "description": "Properties. Reserved for future use." } } }, "OperationsDiscoveryCollection": { "type": "object", "description": "Collection of ClientDiscovery details.", "properties": { "value": { "type": "array", "description": "The OperationsDiscovery items on this page", "items": { "$ref": "#/definitions/OperationsDiscovery" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PauseReplicationInput": { "type": "object", "description": "Pause replication input.", "properties": { "properties": { "$ref": "#/definitions/PauseReplicationInputProperties", "description": "Pause replication input properties." } }, "required": [ "properties" ] }, "PauseReplicationInputProperties": { "type": "object", "description": "Pause replication input properties.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "required": [ "instanceType" ] }, "PlannedFailoverInput": { "type": "object", "description": "Input definition for planned failover.", "properties": { "properties": { "$ref": "#/definitions/PlannedFailoverInputProperties", "description": "Planned failover input properties." } } }, "PlannedFailoverInputProperties": { "type": "object", "description": "Input definition for planned failover input properties.", "properties": { "failoverDirection": { "type": "string", "description": "Failover direction." }, "providerSpecificDetails": { "$ref": "#/definitions/PlannedFailoverProviderSpecificFailoverInput", "description": "Provider specific settings." } } }, "PlannedFailoverProviderSpecificFailoverInput": { "type": "object", "description": "Provider specific failover input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "PlannedFailoverStatus": { "type": "string", "description": "The last planned failover status.", "enum": [ "Succeeded", "Failed", "Cancelled", "Unknown" ], "x-ms-enum": { "name": "PlannedFailoverStatus", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Cancelled", "value": "Cancelled", "description": "Cancelled" }, { "name": "Unknown", "value": "Unknown", "description": "Unknown" } ] } }, "Policy": { "type": "object", "description": "Protection profile details.", "properties": { "properties": { "$ref": "#/definitions/PolicyProperties", "description": "The custom data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "PolicyCollection": { "type": "object", "description": "Protection Profile Collection details.", "properties": { "value": { "type": "array", "description": "The Policy items on this page", "items": { "$ref": "#/definitions/Policy" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PolicyProperties": { "type": "object", "description": "Protection profile custom data details.", "properties": { "friendlyName": { "type": "string", "description": "The FriendlyName." }, "providerSpecificDetails": { "$ref": "#/definitions/PolicyProviderSpecificDetails", "description": "The ReplicationChannelSetting." } } }, "PolicyProviderSpecificDetails": { "type": "object", "description": "Base class for Provider specific details for policies.", "properties": { "instanceType": { "type": "string", "description": "Gets the class type. Overridden in derived classes." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "PolicyProviderSpecificInput": { "type": "object", "description": "Base class for provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "PossibleOperationsDirections": { "type": "string", "description": "The failover direction.", "enum": [ "PrimaryToRecovery", "RecoveryToPrimary" ], "x-ms-enum": { "name": "PossibleOperationsDirections", "modelAsString": true, "values": [ { "name": "PrimaryToRecovery", "value": "PrimaryToRecovery", "description": "PrimaryToRecovery" }, { "name": "RecoveryToPrimary", "value": "RecoveryToPrimary", "description": "RecoveryToPrimary" } ] } }, "PresenceStatus": { "type": "string", "description": "A value indicating whether the VM has a physical disk attached. String value of SrsDataContract.PresenceStatus enum.", "enum": [ "Unknown", "Present", "NotPresent" ], "x-ms-enum": { "name": "PresenceStatus", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "Unknown" }, { "name": "Present", "value": "Present", "description": "Present" }, { "name": "NotPresent", "value": "NotPresent", "description": "NotPresent" } ] } }, "ProcessServer": { "type": "object", "description": "Details of the Process Server.", "properties": { "friendlyName": { "type": "string", "description": "The Process Server's friendly name." }, "id": { "type": "string", "description": "The Process Server Id." }, "ipAddress": { "type": "string", "description": "The IP address of the server." }, "osType": { "type": "string", "description": "The OS type of the server." }, "agentVersion": { "type": "string", "description": "The version of the scout component on the server." }, "lastHeartbeat": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the server." }, "versionStatus": { "type": "string", "description": "Version status." }, "mobilityServiceUpdates": { "type": "array", "description": "The list of the mobility service updates available on the Process Server.", "items": { "$ref": "#/definitions/MobilityServiceUpdate" } }, "hostId": { "type": "string", "description": "The agent generated Id." }, "machineCount": { "type": "string", "description": "The servers configured with this PS." }, "replicationPairCount": { "type": "string", "description": "The number of replication pairs configured in this PS." }, "systemLoad": { "type": "string", "description": "The percentage of the system load." }, "systemLoadStatus": { "type": "string", "description": "The system load status." }, "cpuLoad": { "type": "string", "description": "The percentage of the CPU load." }, "cpuLoadStatus": { "type": "string", "description": "The CPU load status." }, "totalMemoryInBytes": { "type": "integer", "format": "int64", "description": "The total memory." }, "availableMemoryInBytes": { "type": "integer", "format": "int64", "description": "The available memory." }, "memoryUsageStatus": { "type": "string", "description": "The memory usage status." }, "totalSpaceInBytes": { "type": "integer", "format": "int64", "description": "The total space." }, "availableSpaceInBytes": { "type": "integer", "format": "int64", "description": "The available space." }, "spaceUsageStatus": { "type": "string", "description": "The space usage status." }, "psServiceStatus": { "type": "string", "description": "The PS service status." }, "sslCertExpiryDate": { "type": "string", "format": "date-time", "description": "The PS SSL cert expiry date." }, "sslCertExpiryRemainingDays": { "type": "integer", "format": "int32", "description": "CS SSL cert expiry date." }, "osVersion": { "type": "string", "description": "OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0." }, "healthErrors": { "type": "array", "description": "Health errors.", "items": { "$ref": "#/definitions/HealthError" } }, "agentExpiryDate": { "type": "string", "format": "date-time", "description": "Agent expiry date." }, "agentVersionDetails": { "$ref": "#/definitions/VersionDetails", "description": "The agent version details." }, "health": { "$ref": "#/definitions/ProtectionHealth", "description": "The health of Process Server.", "readOnly": true }, "psStatsRefreshTime": { "type": "string", "format": "date-time", "description": "The process server stats refresh time.", "readOnly": true }, "throughputUploadPendingDataInBytes": { "type": "integer", "format": "int64", "description": "The uploading pending data in bytes.", "readOnly": true }, "throughputInMBps": { "type": "integer", "format": "int64", "description": "The throughput in MBps.", "readOnly": true }, "throughputInBytes": { "type": "integer", "format": "int64", "description": "The throughput in bytes.", "readOnly": true }, "throughputStatus": { "type": "string", "description": "The throughput status.", "readOnly": true }, "marsCommunicationStatus": { "type": "string", "description": "The MARS communication status.", "readOnly": true }, "marsRegistrationStatus": { "type": "string", "description": "The MARS registration status.", "readOnly": true } } }, "ProcessServerDetails": { "type": "object", "description": "Process server details.", "properties": { "id": { "type": "string", "description": "The process server Id.", "readOnly": true }, "name": { "type": "string", "description": "The process server name.", "readOnly": true }, "biosId": { "type": "string", "description": "The process server Bios Id.", "readOnly": true }, "fabricObjectId": { "type": "string", "description": "The fabric object Id.", "readOnly": true }, "fqdn": { "type": "string", "description": "The process server Fqdn.", "readOnly": true }, "ipAddresses": { "type": "array", "description": "The list of IP addresses for communicating with the RCM component.", "items": { "type": "string" }, "readOnly": true }, "version": { "type": "string", "description": "The version.", "readOnly": true }, "lastHeartbeatUtc": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the process server.", "readOnly": true }, "totalMemoryInBytes": { "type": "integer", "format": "int64", "description": "The total memory.", "readOnly": true }, "availableMemoryInBytes": { "type": "integer", "format": "int64", "description": "The available memory.", "readOnly": true }, "usedMemoryInBytes": { "type": "integer", "format": "int64", "description": "The used memory.", "readOnly": true }, "memoryUsagePercentage": { "type": "number", "format": "double", "description": "The memory usage percentage.", "readOnly": true }, "totalSpaceInBytes": { "type": "integer", "format": "int64", "description": "The total disk space.", "readOnly": true }, "availableSpaceInBytes": { "type": "integer", "format": "int64", "description": "The available disk space.", "readOnly": true }, "usedSpaceInBytes": { "type": "integer", "format": "int64", "description": "The used disk space.", "readOnly": true }, "freeSpacePercentage": { "type": "number", "format": "double", "description": "The free disk space percentage.", "readOnly": true }, "throughputUploadPendingDataInBytes": { "type": "integer", "format": "int64", "description": "The uploading pending data in bytes.", "readOnly": true }, "throughputInBytes": { "type": "integer", "format": "int64", "description": "The throughput in bytes.", "readOnly": true }, "processorUsagePercentage": { "type": "number", "format": "double", "description": "The processor usage percentage.", "readOnly": true }, "throughputStatus": { "$ref": "#/definitions/RcmComponentStatus", "description": "The throughput status.", "readOnly": true }, "systemLoad": { "type": "integer", "format": "int64", "description": "The system load.", "readOnly": true }, "systemLoadStatus": { "$ref": "#/definitions/RcmComponentStatus", "description": "The system load status.", "readOnly": true }, "diskUsageStatus": { "$ref": "#/definitions/RcmComponentStatus", "description": "The disk usage status.", "readOnly": true }, "memoryUsageStatus": { "$ref": "#/definitions/RcmComponentStatus", "description": "The memory usage status.", "readOnly": true }, "processorUsageStatus": { "$ref": "#/definitions/RcmComponentStatus", "description": "The processor usage status.", "readOnly": true }, "health": { "$ref": "#/definitions/ProtectionHealth", "description": "The health of the process server.", "readOnly": true }, "healthErrors": { "type": "array", "description": "The health errors.", "items": { "$ref": "#/definitions/HealthError" }, "readOnly": true }, "protectedItemCount": { "type": "integer", "format": "int32", "description": "The protected item count.", "readOnly": true }, "historicHealth": { "$ref": "#/definitions/ProtectionHealth", "description": "The historic health of the process server based on the health in last 24 hours.", "readOnly": true } } }, "ProtectableItem": { "type": "object", "description": "Replication protected item.", "properties": { "properties": { "$ref": "#/definitions/ProtectableItemProperties", "description": "The custom data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ProtectableItemCollection": { "type": "object", "description": "Protectable item collection.", "properties": { "value": { "type": "array", "description": "The ProtectableItem items on this page", "items": { "$ref": "#/definitions/ProtectableItem" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ProtectableItemProperties": { "type": "object", "description": "Replication protected item custom data details.", "properties": { "friendlyName": { "type": "string", "description": "The name." }, "protectionStatus": { "type": "string", "description": "The protection status." }, "replicationProtectedItemId": { "type": "string", "description": "The ARM resource of protected items." }, "recoveryServicesProviderId": { "type": "string", "description": "The recovery provider ARM Id." }, "protectionReadinessErrors": { "type": "array", "description": "The Current protection readiness errors.", "items": { "type": "string" } }, "supportedReplicationProviders": { "type": "array", "description": "The list of replication providers supported for the protectable item.", "items": { "type": "string" } }, "customDetails": { "$ref": "#/definitions/ConfigurationSettings", "description": "The Replication provider custom settings." } } }, "ProtectionContainer": { "type": "object", "description": "Protection container details.", "properties": { "properties": { "$ref": "#/definitions/ProtectionContainerProperties", "description": "The custom data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ProtectionContainerCollection": { "type": "object", "description": "Protection Container collection.", "properties": { "value": { "type": "array", "description": "The ProtectionContainer items on this page", "items": { "$ref": "#/definitions/ProtectionContainer" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ProtectionContainerFabricSpecificDetails": { "type": "object", "description": "Base class for fabric specific details of container.", "properties": { "instanceType": { "type": "string", "description": "Gets the class type. Overridden in derived classes.", "readOnly": true } } }, "ProtectionContainerMapping": { "type": "object", "description": "Protection container mapping object.", "properties": { "properties": { "$ref": "#/definitions/ProtectionContainerMappingProperties", "description": "The custom data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ProtectionContainerMappingCollection": { "type": "object", "description": "Protection container mapping collection class.", "properties": { "value": { "type": "array", "description": "The ProtectionContainerMapping items on this page", "items": { "$ref": "#/definitions/ProtectionContainerMapping" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ProtectionContainerMappingProperties": { "type": "object", "description": "Protection container mapping properties.", "properties": { "targetProtectionContainerId": { "type": "string", "description": "Paired protection container ARM ID." }, "targetProtectionContainerFriendlyName": { "type": "string", "description": "Friendly name of paired container." }, "providerSpecificDetails": { "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails", "description": "Provider specific provider details." }, "health": { "type": "string", "description": "Health of pairing." }, "healthErrorDetails": { "type": "array", "description": "Health error.", "items": { "$ref": "#/definitions/HealthError" } }, "policyId": { "type": "string", "description": "Policy ARM Id." }, "state": { "type": "string", "description": "Association Status." }, "sourceProtectionContainerFriendlyName": { "type": "string", "description": "Friendly name of source protection container." }, "sourceFabricFriendlyName": { "type": "string", "description": "Friendly name of source fabric." }, "targetFabricFriendlyName": { "type": "string", "description": "Friendly name of target fabric." }, "policyFriendlyName": { "type": "string", "description": "Friendly name of replication policy." } } }, "ProtectionContainerMappingProviderSpecificDetails": { "type": "object", "description": "Container mapping provider specific details.", "properties": { "instanceType": { "type": "string", "description": "Gets the class type. Overridden in derived classes." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ProtectionContainerProperties": { "type": "object", "description": "Protection profile custom data details.", "properties": { "fabricFriendlyName": { "type": "string", "description": "Fabric friendly name." }, "friendlyName": { "type": "string", "description": "The name." }, "fabricType": { "type": "string", "description": "The fabric type." }, "protectedItemCount": { "type": "integer", "format": "int32", "description": "Number of protected PEs." }, "pairingStatus": { "type": "string", "description": "The pairing status of this cloud." }, "role": { "type": "string", "description": "The role of this cloud." }, "fabricSpecificDetails": { "$ref": "#/definitions/ProtectionContainerFabricSpecificDetails", "description": "Fabric specific details." } } }, "ProtectionHealth": { "type": "string", "description": "The health.", "enum": [ "None", "Normal", "Warning", "Critical" ], "x-ms-enum": { "name": "ProtectionHealth", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "Normal", "value": "Normal", "description": "Normal" }, { "name": "Warning", "value": "Warning", "description": "Warning" }, { "name": "Critical", "value": "Critical", "description": "Critical" } ] } }, "ProtectionProfileCustomDetails": { "type": "object", "description": "Protection Profile custom input.", "properties": { "resourceType": { "type": "string", "description": "The class type." } }, "discriminator": "resourceType", "required": [ "resourceType" ] }, "ProviderError": { "type": "object", "description": "This class contains the error details per object.", "properties": { "errorCode": { "type": "integer", "format": "int32", "description": "The Error code." }, "errorMessage": { "type": "string", "description": "The Error message." }, "errorId": { "type": "string", "description": "The Provider error Id." }, "possibleCauses": { "type": "string", "description": "The possible causes for the error." }, "recommendedAction": { "type": "string", "description": "The recommended action to resolve the error." } } }, "ProviderSpecificRecoveryPointDetails": { "type": "object", "description": "Replication provider specific recovery point details.", "properties": { "instanceType": { "type": "string", "description": "Gets the provider type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "PushInstallerDetails": { "type": "object", "description": "Push installer details.", "properties": { "id": { "type": "string", "description": "The push installer Id.", "readOnly": true }, "name": { "type": "string", "description": "The push installer name.", "readOnly": true }, "biosId": { "type": "string", "description": "The push installer Bios Id.", "readOnly": true }, "fabricObjectId": { "type": "string", "description": "The fabric object Id.", "readOnly": true }, "fqdn": { "type": "string", "description": "The push installer Fqdn.", "readOnly": true }, "version": { "type": "string", "description": "The version.", "readOnly": true }, "lastHeartbeatUtc": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the push installer.", "readOnly": true }, "health": { "$ref": "#/definitions/ProtectionHealth", "description": "The health of the push installer.", "readOnly": true }, "healthErrors": { "type": "array", "description": "The health errors.", "items": { "$ref": "#/definitions/HealthError" }, "readOnly": true } } }, "RcmComponentStatus": { "type": "string", "description": "The throughput status.", "enum": [ "Healthy", "Warning", "Critical", "Unknown" ], "x-ms-enum": { "name": "RcmComponentStatus", "modelAsString": true, "values": [ { "name": "Healthy", "value": "Healthy", "description": "Healthy" }, { "name": "Warning", "value": "Warning", "description": "Warning" }, { "name": "Critical", "value": "Critical", "description": "Critical" }, { "name": "Unknown", "value": "Unknown", "description": "Unknown" } ] } }, "RcmProxyDetails": { "type": "object", "description": "RCM proxy details.", "properties": { "id": { "type": "string", "description": "The RCM proxy Id.", "readOnly": true }, "name": { "type": "string", "description": "The RCM proxy name.", "readOnly": true }, "biosId": { "type": "string", "description": "The RCM proxy Bios Id.", "readOnly": true }, "fabricObjectId": { "type": "string", "description": "The fabric object Id.", "readOnly": true }, "fqdn": { "type": "string", "description": "The RCM proxy Fqdn.", "readOnly": true }, "clientAuthenticationType": { "type": "string", "description": "The client authentication type.", "readOnly": true }, "version": { "type": "string", "description": "The version.", "readOnly": true }, "lastHeartbeatUtc": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the RCM proxy.", "readOnly": true }, "health": { "$ref": "#/definitions/ProtectionHealth", "description": "The health of the RCM proxy.", "readOnly": true }, "healthErrors": { "type": "array", "description": "The health errors.", "items": { "$ref": "#/definitions/HealthError" }, "readOnly": true } } }, "RecoveryAvailabilitySetCustomDetails": { "type": "object", "description": "Recovery Availability Set custom input.", "properties": { "resourceType": { "type": "string", "description": "The class type." } }, "discriminator": "resourceType", "required": [ "resourceType" ] }, "RecoveryNetworkConfigAutoSyncPolicy": { "type": "string", "description": "The vault level policy controlling whether the A2A recovery network configuration is automatically kept in sync with the source virtual machine.", "enum": [ "Disabled", "Enabled" ], "x-ms-enum": { "name": "RecoveryNetworkConfigAutoSyncPolicy", "modelAsString": true, "values": [ { "name": "Disabled", "value": "Disabled", "description": "Automatic synchronization of the recovery network configuration is turned off. Recovery NIC settings are changed only through an explicit update operation." }, { "name": "Enabled", "value": "Enabled", "description": "Automatic synchronization of the recovery network configuration is turned on. Recovery NIC settings are refreshed from the source virtual machine as its network configuration changes." } ] } }, "RecoveryPlan": { "type": "object", "description": "Recovery plan details.", "properties": { "properties": { "$ref": "#/definitions/RecoveryPlanProperties", "description": "The custom details." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "RecoveryPlanA2ADetails": { "type": "object", "description": "Recovery plan A2A specific details.", "properties": { "primaryZone": { "type": "string", "description": "The primary zone." }, "recoveryZone": { "type": "string", "description": "The recovery zone." }, "primaryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The primary extended location." }, "recoveryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The recovery extended location." } }, "allOf": [ { "$ref": "#/definitions/RecoveryPlanProviderSpecificDetails" } ], "x-ms-discriminator-value": "A2A" }, "RecoveryPlanA2AFailoverInput": { "type": "object", "description": "Recovery plan A2A failover input.", "properties": { "recoveryPointType": { "$ref": "#/definitions/A2ARpRecoveryPointType", "description": "The recovery point type." }, "cloudServiceCreationOption": { "type": "string", "description": "A value indicating whether to use recovery cloud service for TFO or not." }, "multiVmSyncPointOption": { "$ref": "#/definitions/MultiVmSyncPointOption", "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover." } }, "required": [ "recoveryPointType" ], "allOf": [ { "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" } ], "x-ms-discriminator-value": "A2A" }, "RecoveryPlanA2AInput": { "type": "object", "description": "Recovery plan A2A input.", "properties": { "primaryZone": { "type": "string", "description": "The primary zone." }, "recoveryZone": { "type": "string", "description": "The recovery zone." }, "primaryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The primary extended location." }, "recoveryExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", "description": "The recovery extended location." } }, "allOf": [ { "$ref": "#/definitions/RecoveryPlanProviderSpecificInput" } ], "x-ms-discriminator-value": "A2A" }, "RecoveryPlanAction": { "type": "object", "description": "Recovery plan action details.", "properties": { "actionName": { "type": "string", "description": "The action name." }, "failoverTypes": { "type": "array", "description": "The list of failover types.", "items": { "$ref": "#/definitions/ReplicationProtectedItemOperation" } }, "failoverDirections": { "type": "array", "description": "The list of failover directions.", "items": { "$ref": "#/definitions/PossibleOperationsDirections" } }, "customDetails": { "$ref": "#/definitions/RecoveryPlanActionDetails", "description": "The custom details." } }, "required": [ "actionName", "failoverTypes", "failoverDirections", "customDetails" ] }, "RecoveryPlanActionDetails": { "type": "object", "description": "Recovery plan action custom details.", "properties": { "instanceType": { "type": "string", "description": "Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values)." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "RecoveryPlanActionLocation": { "type": "string", "description": "The fabric location.", "enum": [ "Primary", "Recovery" ], "x-ms-enum": { "name": "RecoveryPlanActionLocation", "modelAsString": true, "values": [ { "name": "Primary", "value": "Primary", "description": "Primary" }, { "name": "Recovery", "value": "Recovery", "description": "Recovery" } ] } }, "RecoveryPlanAutomationRunbookActionDetails": { "type": "object", "description": "Recovery plan Automation runbook action details.", "properties": { "runbookId": { "type": "string", "description": "The runbook ARM Id." }, "timeout": { "type": "string", "description": "The runbook timeout." }, "fabricLocation": { "$ref": "#/definitions/RecoveryPlanActionLocation", "description": "The fabric location." } }, "required": [ "fabricLocation" ], "allOf": [ { "$ref": "#/definitions/RecoveryPlanActionDetails" } ], "x-ms-discriminator-value": "AutomationRunbookActionDetails" }, "RecoveryPlanCollection": { "type": "object", "description": "Recovery plan collection details.", "properties": { "value": { "type": "array", "description": "The RecoveryPlan items on this page", "items": { "$ref": "#/definitions/RecoveryPlan" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RecoveryPlanGroup": { "type": "object", "description": "Recovery plan group details.", "properties": { "groupType": { "$ref": "#/definitions/RecoveryPlanGroupType", "description": "The group type." }, "replicationProtectedItems": { "type": "array", "description": "The list of protected items.", "items": { "$ref": "#/definitions/RecoveryPlanProtectedItem" } }, "startGroupActions": { "type": "array", "description": "The start group actions.", "items": { "$ref": "#/definitions/RecoveryPlanAction" } }, "endGroupActions": { "type": "array", "description": "The end group actions.", "items": { "$ref": "#/definitions/RecoveryPlanAction" } } }, "required": [ "groupType" ] }, "RecoveryPlanGroupTaskDetails": { "type": "object", "description": "This class represents the recovery plan group task.", "properties": { "name": { "type": "string", "description": "The name." }, "groupId": { "type": "string", "description": "The group identifier." }, "rpGroupType": { "type": "string", "description": "The group type." } }, "allOf": [ { "$ref": "#/definitions/GroupTaskDetails" } ], "x-ms-discriminator-value": "RecoveryPlanGroupTaskDetails" }, "RecoveryPlanGroupType": { "type": "string", "description": "The group type.", "enum": [ "Shutdown", "Boot", "Failover" ], "x-ms-enum": { "name": "RecoveryPlanGroupType", "modelAsString": true, "values": [ { "name": "Shutdown", "value": "Shutdown", "description": "Shutdown" }, { "name": "Boot", "value": "Boot", "description": "Boot" }, { "name": "Failover", "value": "Failover", "description": "Failover" } ] } }, "RecoveryPlanHyperVReplicaAzureFailbackInput": { "type": "object", "description": "Recovery plan HVR Azure failback input.", "properties": { "dataSyncOption": { "$ref": "#/definitions/DataSyncStatus", "description": "The data sync option." }, "recoveryVmCreationOption": { "$ref": "#/definitions/AlternateLocationRecoveryOption", "description": "The ALR option." } }, "required": [ "dataSyncOption", "recoveryVmCreationOption" ], "allOf": [ { "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzureFailback" }, "RecoveryPlanHyperVReplicaAzureFailoverInput": { "type": "object", "description": "Recovery plan HVR Azure failover input.", "properties": { "primaryKekCertificatePfx": { "$ref": "#/definitions/SecretString", "description": "The primary KEK certificate PFX." }, "secondaryKekCertificatePfx": { "$ref": "#/definitions/SecretString", "description": "The secondary KEK certificate PFX." }, "recoveryPointType": { "$ref": "#/definitions/HyperVReplicaAzureRpRecoveryPointType", "description": "The recovery point type." } }, "allOf": [ { "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" } ], "x-ms-discriminator-value": "HyperVReplicaAzure" }, "RecoveryPlanInMageAzureV2FailoverInput": { "type": "object", "description": "Recovery plan InMageAzureV2 failover input.", "properties": { "recoveryPointType": { "$ref": "#/definitions/InMageV2RpRecoveryPointType", "description": "The recovery point type." }, "useMultiVmSyncPoint": { "type": "string", "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover." } }, "required": [ "recoveryPointType" ], "allOf": [ { "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" } ], "x-ms-discriminator-value": "InMageAzureV2" }, "RecoveryPlanInMageFailoverInput": { "type": "object", "description": "Recovery plan InMage failover input.", "properties": { "recoveryPointType": { "$ref": "#/definitions/RpInMageRecoveryPointType", "description": "The recovery point type." } }, "required": [ "recoveryPointType" ], "allOf": [ { "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" } ], "x-ms-discriminator-value": "InMage" }, "RecoveryPlanInMageRcmFailbackFailoverInput": { "type": "object", "description": "Recovery plan InMageRcmFailback failover input.", "properties": { "recoveryPointType": { "$ref": "#/definitions/InMageRcmFailbackRecoveryPointType", "description": "The recovery point type." }, "useMultiVmSyncPoint": { "type": "string", "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover." } }, "required": [ "recoveryPointType" ], "allOf": [ { "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" } ], "x-ms-discriminator-value": "InMageRcmFailback" }, "RecoveryPlanInMageRcmFailoverInput": { "type": "object", "description": "Recovery plan InMageRcm failover input.", "properties": { "recoveryPointType": { "$ref": "#/definitions/RecoveryPlanPointType", "description": "The recovery point type." }, "useMultiVmSyncPoint": { "type": "string", "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover." } }, "required": [ "recoveryPointType" ], "allOf": [ { "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" } ], "x-ms-discriminator-value": "InMageRcm" }, "RecoveryPlanManualActionDetails": { "type": "object", "description": "Recovery plan manual action details.", "properties": { "description": { "type": "string", "description": "The manual action description." } }, "allOf": [ { "$ref": "#/definitions/RecoveryPlanActionDetails" } ], "x-ms-discriminator-value": "ManualActionDetails" }, "RecoveryPlanPlannedFailoverInput": { "type": "object", "description": "Recovery plan planned failover input.", "properties": { "properties": { "$ref": "#/definitions/RecoveryPlanPlannedFailoverInputProperties", "description": "The recovery plan planned failover input properties." } }, "required": [ "properties" ] }, "RecoveryPlanPlannedFailoverInputProperties": { "type": "object", "description": "Recovery plan planned failover input properties.", "properties": { "failoverDirection": { "$ref": "#/definitions/PossibleOperationsDirections", "description": "The failover direction." }, "providerSpecificDetails": { "type": "array", "description": "The provider specific properties.", "items": { "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" } } }, "required": [ "failoverDirection" ] }, "RecoveryPlanPointType": { "type": "string", "description": "The recovery point type.", "enum": [ "Latest", "LatestApplicationConsistent", "LatestCrashConsistent", "LatestProcessed" ], "x-ms-enum": { "name": "RecoveryPlanPointType", "modelAsString": true, "values": [ { "name": "Latest", "value": "Latest", "description": "Latest" }, { "name": "LatestApplicationConsistent", "value": "LatestApplicationConsistent", "description": "LatestApplicationConsistent" }, { "name": "LatestCrashConsistent", "value": "LatestCrashConsistent", "description": "LatestCrashConsistent" }, { "name": "LatestProcessed", "value": "LatestProcessed", "description": "LatestProcessed" } ] } }, "RecoveryPlanProperties": { "type": "object", "description": "Recovery plan properties.", "properties": { "friendlyName": { "type": "string", "description": "The friendly name." }, "primaryFabricId": { "type": "string", "description": "The primary fabric Id." }, "primaryFabricFriendlyName": { "type": "string", "description": "The primary fabric friendly name." }, "recoveryFabricId": { "type": "string", "description": "The recovery fabric Id." }, "recoveryFabricFriendlyName": { "type": "string", "description": "The recovery fabric friendly name." }, "failoverDeploymentModel": { "type": "string", "description": "The failover deployment model." }, "replicationProviders": { "type": "array", "description": "The list of replication providers.", "items": { "type": "string" } }, "allowedOperations": { "type": "array", "description": "The list of allowed operations.", "items": { "type": "string" } }, "lastPlannedFailoverTime": { "type": "string", "format": "date-time", "description": "The start time of the last planned failover." }, "lastUnplannedFailoverTime": { "type": "string", "format": "date-time", "description": "The start time of the last unplanned failover." }, "lastTestFailoverTime": { "type": "string", "format": "date-time", "description": "The start time of the last test failover." }, "currentScenario": { "$ref": "#/definitions/CurrentScenarioDetails", "description": "The current scenario details." }, "currentScenarioStatus": { "type": "string", "description": "The recovery plan status." }, "currentScenarioStatusDescription": { "type": "string", "description": "The recovery plan status description." }, "groups": { "type": "array", "description": "The recovery plan groups.", "items": { "$ref": "#/definitions/RecoveryPlanGroup" } }, "providerSpecificDetails": { "type": "array", "description": "The provider id and provider specific details.", "items": { "$ref": "#/definitions/RecoveryPlanProviderSpecificDetails" } } } }, "RecoveryPlanProtectedItem": { "type": "object", "description": "Recovery plan protected item.", "properties": { "id": { "type": "string", "description": "The ARM Id of the recovery plan protected item." }, "virtualMachineId": { "type": "string", "description": "The virtual machine Id." } } }, "RecoveryPlanProviderSpecificDetails": { "type": "object", "description": "Recovery plan provider specific details.", "properties": { "instanceType": { "type": "string", "description": "Gets the Instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "RecoveryPlanProviderSpecificFailoverInput": { "type": "object", "description": "Recovery plan provider specific failover input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "RecoveryPlanProviderSpecificInput": { "type": "object", "description": "Recovery plan provider specific input base class.", "properties": { "instanceType": { "type": "string", "description": "Gets the Instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "RecoveryPlanScriptActionDetails": { "type": "object", "description": "Recovery plan script action details.", "properties": { "path": { "type": "string", "description": "The script path." }, "timeout": { "type": "string", "description": "The script timeout." }, "fabricLocation": { "$ref": "#/definitions/RecoveryPlanActionLocation", "description": "The fabric location." } }, "required": [ "path", "fabricLocation" ], "allOf": [ { "$ref": "#/definitions/RecoveryPlanActionDetails" } ], "x-ms-discriminator-value": "ScriptActionDetails" }, "RecoveryPlanShutdownGroupTaskDetails": { "type": "object", "description": "This class represents the recovery plan shutdown group task details.", "allOf": [ { "$ref": "#/definitions/RecoveryPlanGroupTaskDetails" } ], "x-ms-discriminator-value": "RecoveryPlanShutdownGroupTaskDetails" }, "RecoveryPlanTestFailoverCleanupInput": { "type": "object", "description": "Recovery plan test failover cleanup input.", "properties": { "properties": { "$ref": "#/definitions/RecoveryPlanTestFailoverCleanupInputProperties", "description": "The recovery plan test failover cleanup input properties." } }, "required": [ "properties" ] }, "RecoveryPlanTestFailoverCleanupInputProperties": { "type": "object", "description": "Recovery plan test failover cleanup input properties.", "properties": { "comments": { "type": "string", "description": "The test failover cleanup comments.", "maxLength": 1024 } } }, "RecoveryPlanTestFailoverInput": { "type": "object", "description": "Recovery plan test failover input.", "properties": { "properties": { "$ref": "#/definitions/RecoveryPlanTestFailoverInputProperties", "description": "The recovery plan test failover input properties." } }, "required": [ "properties" ] }, "RecoveryPlanTestFailoverInputProperties": { "type": "object", "description": "Recovery plan test failover input properties.", "properties": { "failoverDirection": { "$ref": "#/definitions/PossibleOperationsDirections", "description": "The failover direction." }, "networkType": { "type": "string", "description": "The network type to be used for test failover." }, "networkId": { "type": "string", "description": "The Id of the network to be used for test failover." }, "providerSpecificDetails": { "type": "array", "description": "The provider specific properties.", "items": { "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" } } }, "required": [ "failoverDirection", "networkType" ] }, "RecoveryPlanUnplannedFailoverInput": { "type": "object", "description": "Recovery plan unplanned failover input.", "properties": { "properties": { "$ref": "#/definitions/RecoveryPlanUnplannedFailoverInputProperties", "description": "The recovery plan unplanned failover input properties." } }, "required": [ "properties" ] }, "RecoveryPlanUnplannedFailoverInputProperties": { "type": "object", "description": "Recovery plan unplanned failover input properties.", "properties": { "failoverDirection": { "$ref": "#/definitions/PossibleOperationsDirections", "description": "The failover direction." }, "sourceSiteOperations": { "$ref": "#/definitions/SourceSiteOperations", "description": "A value indicating whether source site operations are required." }, "providerSpecificDetails": { "type": "array", "description": "The provider specific properties.", "items": { "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" } } }, "required": [ "failoverDirection", "sourceSiteOperations" ] }, "RecoveryPoint": { "type": "object", "description": "Recovery point.", "properties": { "properties": { "$ref": "#/definitions/RecoveryPointProperties", "description": "The recovery point properties." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "RecoveryPointCollection": { "type": "object", "description": "Collection of recovery point details.", "properties": { "value": { "type": "array", "description": "The RecoveryPoint items on this page", "items": { "$ref": "#/definitions/RecoveryPoint" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RecoveryPointProperties": { "type": "object", "description": "Recovery point properties.", "properties": { "recoveryPointTime": { "type": "string", "format": "date-time", "description": "The recovery point time." }, "recoveryPointType": { "type": "string", "description": "The recovery point type: ApplicationConsistent, CrashConsistent." }, "providerSpecificDetails": { "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails", "description": "The provider specific details for the recovery point." } } }, "RecoveryPointSyncType": { "type": "string", "description": "A value indicating whether the recovery point is multi VM consistent.", "enum": [ "MultiVmSyncRecoveryPoint", "PerVmRecoveryPoint" ], "x-ms-enum": { "name": "RecoveryPointSyncType", "modelAsString": true, "values": [ { "name": "MultiVmSyncRecoveryPoint", "value": "MultiVmSyncRecoveryPoint", "description": "MultiVmSyncRecoveryPoint" }, { "name": "PerVmRecoveryPoint", "value": "PerVmRecoveryPoint", "description": "PerVmRecoveryPoint" } ] } }, "RecoveryPointType": { "type": "string", "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", "enum": [ "LatestTime", "LatestTag", "Custom" ], "x-ms-enum": { "name": "RecoveryPointType", "modelAsString": true, "values": [ { "name": "LatestTime", "value": "LatestTime", "description": "LatestTime" }, { "name": "LatestTag", "value": "LatestTag", "description": "LatestTag" }, { "name": "Custom", "value": "Custom", "description": "Custom" } ] } }, "RecoveryProximityPlacementGroupCustomDetails": { "type": "object", "description": "Recovery Proximity placement group custom input.", "properties": { "resourceType": { "type": "string", "description": "The class type." } }, "discriminator": "resourceType", "required": [ "resourceType" ] }, "RecoveryResourceGroupCustomDetails": { "type": "object", "description": "Recovery Resource Group custom input.", "properties": { "resourceType": { "type": "string", "description": "The class type." } }, "discriminator": "resourceType", "required": [ "resourceType" ] }, "RecoveryServicesProvider": { "type": "object", "description": "Provider details.", "properties": { "properties": { "$ref": "#/definitions/RecoveryServicesProviderProperties", "description": "Provider properties." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "RecoveryServicesProviderCollection": { "type": "object", "description": "Collection of providers.", "properties": { "value": { "type": "array", "description": "The RecoveryServicesProvider items on this page", "items": { "$ref": "#/definitions/RecoveryServicesProvider" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RecoveryServicesProviderProperties": { "type": "object", "description": "Recovery services provider properties.", "properties": { "fabricType": { "type": "string", "description": "Type of the site." }, "friendlyName": { "type": "string", "description": "Friendly name of the DRA." }, "providerVersion": { "type": "string", "description": "The provider version." }, "serverVersion": { "type": "string", "description": "The fabric provider." }, "providerVersionState": { "type": "string", "description": "DRA version status." }, "providerVersionExpiryDate": { "type": "string", "format": "date-time", "description": "Expiry date of the version." }, "fabricFriendlyName": { "type": "string", "description": "The fabric friendly name." }, "lastHeartBeat": { "type": "string", "format": "date-time", "description": "Time when last heartbeat was sent by the DRA." }, "connectionStatus": { "type": "string", "description": "A value indicating whether DRA is responsive." }, "protectedItemCount": { "type": "integer", "format": "int32", "description": "Number of protected VMs currently managed by the DRA." }, "allowedScenarios": { "type": "array", "description": "The scenarios allowed on this provider.", "items": { "type": "string" } }, "healthErrorDetails": { "type": "array", "description": "The recovery services provider health error details.", "items": { "$ref": "#/definitions/HealthError" } }, "draIdentifier": { "type": "string", "description": "The DRA Id." }, "machineId": { "type": "string", "description": "The machine Id." }, "machineName": { "type": "string", "description": "The machine name." }, "biosId": { "type": "string", "description": "The Bios Id." }, "authenticationIdentityDetails": { "$ref": "#/definitions/IdentityProviderDetails", "description": "The authentication identity details." }, "resourceAccessIdentityDetails": { "$ref": "#/definitions/IdentityProviderDetails", "description": "The resource access identity details." }, "dataPlaneAuthenticationIdentityDetails": { "$ref": "#/definitions/IdentityProviderDetails", "description": "The data plane authentication identity details." }, "providerVersionDetails": { "$ref": "#/definitions/VersionDetails", "description": "The provider version details." } } }, "RecoveryVirtualNetworkCustomDetails": { "type": "object", "description": "Recovery Virtual network custom input.", "properties": { "resourceType": { "type": "string", "description": "The class type." } }, "discriminator": "resourceType", "required": [ "resourceType" ] }, "RegisteredClusterNodes": { "type": "object", "description": "Extended location of the resource.", "properties": { "clusterNodeFqdn": { "type": "string", "description": "The cluster node name." }, "machineId": { "type": "string", "description": "The machine ID." }, "biosId": { "type": "string", "description": "The BIOS ID." }, "isSharedDiskVirtualNode": { "type": "boolean", "description": "A value indicating whether this represents virtual entity hosting all the shared disks." } } }, "ReinstallMobilityServiceRequest": { "type": "object", "description": "Request to Reinstall the mobility service on a protected item.", "properties": { "properties": { "$ref": "#/definitions/ReinstallMobilityServiceRequestProperties", "description": "The properties of the reinstall mobility service request" } } }, "ReinstallMobilityServiceRequestProperties": { "type": "object", "description": "The properties of an update mobility service request.", "properties": { "runAsAccountId": { "type": "string", "description": "The CS run as account Id." } } }, "RemoveDisksInput": { "type": "object", "description": "Input for remove disk(s) operation.", "properties": { "properties": { "$ref": "#/definitions/RemoveDisksInputProperties", "description": "Remove disk input properties." } } }, "RemoveDisksInputProperties": { "type": "object", "description": "Remove Disk input properties.", "properties": { "providerSpecificDetails": { "$ref": "#/definitions/RemoveDisksProviderSpecificInput", "description": "The ReplicationProviderInput. For HyperVReplicaAzure provider, it will be AzureEnableProtectionInput object. For San provider, it will be SanEnableProtectionInput object. For HyperVReplicaAzure provider, it can be null." } } }, "RemoveDisksProviderSpecificInput": { "type": "object", "description": "Remove Disk provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "RemoveProtectionContainerMappingInput": { "type": "object", "description": "Container unpairing input.", "properties": { "properties": { "$ref": "#/definitions/RemoveProtectionContainerMappingInputProperties", "description": "Configure protection input properties." } } }, "RemoveProtectionContainerMappingInputProperties": { "type": "object", "description": "Unpairing input properties.", "properties": { "providerSpecificInput": { "$ref": "#/definitions/ReplicationProviderContainerUnmappingInput", "description": "Provider specific input for unpairing." } } }, "RenewCertificateInput": { "type": "object", "description": "Certificate renewal input.", "properties": { "properties": { "$ref": "#/definitions/RenewCertificateInputProperties", "description": "Renew certificate input properties." } } }, "RenewCertificateInputProperties": { "type": "object", "description": "Renew Certificate input properties.", "properties": { "renewCertificateType": { "type": "string", "description": "Renew certificate type." } } }, "ReplicationAgentDetails": { "type": "object", "description": "Replication agent details.", "properties": { "id": { "type": "string", "description": "The replication agent Id.", "readOnly": true }, "name": { "type": "string", "description": "The replication agent name.", "readOnly": true }, "biosId": { "type": "string", "description": "The replication agent Bios Id.", "readOnly": true }, "fabricObjectId": { "type": "string", "description": "The fabric object Id.", "readOnly": true }, "fqdn": { "type": "string", "description": "The replication agent Fqdn.", "readOnly": true }, "version": { "type": "string", "description": "The version.", "readOnly": true }, "lastHeartbeatUtc": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the replication agent.", "readOnly": true }, "health": { "$ref": "#/definitions/ProtectionHealth", "description": "The health of the replication agent.", "readOnly": true }, "healthErrors": { "type": "array", "description": "The health errors.", "items": { "$ref": "#/definitions/HealthError" }, "readOnly": true } } }, "ReplicationAppliance": { "type": "object", "description": "Replication appliance definition.", "properties": { "properties": { "$ref": "#/definitions/ReplicationApplianceProperties", "description": "Appliance related data." } } }, "ReplicationApplianceProperties": { "type": "object", "description": "Replication appliance properties.", "properties": { "providerSpecificDetails": { "$ref": "#/definitions/ApplianceSpecificDetails", "description": "Provider specific settings." } } }, "ReplicationClusterProviderSpecificSettings": { "type": "object", "description": "Replication cluster provider specific settings.", "properties": { "instanceType": { "type": "string", "description": "Gets the Instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ReplicationEligibilityResults": { "type": "object", "description": "Replication eligibility results response model.", "properties": { "properties": { "$ref": "#/definitions/ReplicationEligibilityResultsProperties", "description": "Gets properties model for replication eligibility results API." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ReplicationEligibilityResultsCollection": { "type": "object", "description": "Replication eligibility results collection response model.", "properties": { "value": { "type": "array", "description": "The replication eligibility results details.", "items": { "$ref": "#/definitions/ReplicationEligibilityResults" } } } }, "ReplicationEligibilityResultsErrorInfo": { "type": "object", "description": "Error model that can be exposed to the user.", "properties": { "code": { "type": "string", "description": "The error code." }, "message": { "type": "string", "description": "The error message." }, "possibleCauses": { "type": "string", "description": "The possible causes." }, "recommendedAction": { "type": "string", "description": "The recommended action." }, "status": { "type": "string", "description": "The error status.", "readOnly": true } } }, "ReplicationEligibilityResultsProperties": { "type": "object", "description": "Properties model for replication eligibility results API.", "properties": { "clientRequestId": { "type": "string", "description": "The client request Id.", "readOnly": true }, "errors": { "type": "array", "description": "The error details.", "items": { "$ref": "#/definitions/ReplicationEligibilityResultsErrorInfo" } } } }, "ReplicationGroupDetails": { "type": "object", "description": "Replication group details. This will be used in case of San.", "allOf": [ { "$ref": "#/definitions/ConfigurationSettings" } ], "x-ms-discriminator-value": "ReplicationGroupDetails" }, "ReplicationProtectedItem": { "type": "object", "description": "Replication protected item.", "properties": { "properties": { "$ref": "#/definitions/ReplicationProtectedItemProperties", "description": "The custom data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ReplicationProtectedItemCollection": { "type": "object", "description": "Replication protected item collection.", "properties": { "value": { "type": "array", "description": "The ReplicationProtectedItem items on this page", "items": { "$ref": "#/definitions/ReplicationProtectedItem" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ReplicationProtectedItemOperation": { "type": "string", "description": "The list of failover types.", "enum": [ "ReverseReplicate", "Commit", "PlannedFailover", "UnplannedFailover", "DisableProtection", "TestFailover", "TestFailoverCleanup", "Failback", "FinalizeFailback", "CancelFailover", "ChangePit", "RepairReplication", "SwitchProtection", "CompleteMigration" ], "x-ms-enum": { "name": "ReplicationProtectedItemOperation", "modelAsString": true, "values": [ { "name": "ReverseReplicate", "value": "ReverseReplicate", "description": "ReverseReplicate" }, { "name": "Commit", "value": "Commit", "description": "Commit" }, { "name": "PlannedFailover", "value": "PlannedFailover", "description": "PlannedFailover" }, { "name": "UnplannedFailover", "value": "UnplannedFailover", "description": "UnplannedFailover" }, { "name": "DisableProtection", "value": "DisableProtection", "description": "DisableProtection" }, { "name": "TestFailover", "value": "TestFailover", "description": "TestFailover" }, { "name": "TestFailoverCleanup", "value": "TestFailoverCleanup", "description": "TestFailoverCleanup" }, { "name": "Failback", "value": "Failback", "description": "Failback" }, { "name": "FinalizeFailback", "value": "FinalizeFailback", "description": "FinalizeFailback" }, { "name": "CancelFailover", "value": "CancelFailover", "description": "CancelFailover" }, { "name": "ChangePit", "value": "ChangePit", "description": "ChangePit" }, { "name": "RepairReplication", "value": "RepairReplication", "description": "RepairReplication" }, { "name": "SwitchProtection", "value": "SwitchProtection", "description": "SwitchProtection" }, { "name": "CompleteMigration", "value": "CompleteMigration", "description": "CompleteMigration" } ] } }, "ReplicationProtectedItemProperties": { "type": "object", "description": "Replication protected item custom data details.", "properties": { "friendlyName": { "type": "string", "description": "The name." }, "protectedItemType": { "type": "string", "description": "The type of protected item type." }, "protectableItemId": { "type": "string", "description": "The protected item ARM Id." }, "recoveryServicesProviderId": { "type": "string", "description": "The recovery provider ARM Id." }, "primaryFabricFriendlyName": { "type": "string", "description": "The friendly name of the primary fabric." }, "primaryFabricProvider": { "type": "string", "description": "The fabric provider of the primary fabric." }, "recoveryFabricFriendlyName": { "type": "string", "description": "The friendly name of recovery fabric." }, "recoveryFabricId": { "type": "string", "description": "The Arm Id of recovery fabric." }, "primaryProtectionContainerFriendlyName": { "type": "string", "description": "The name of primary protection container friendly name." }, "recoveryProtectionContainerFriendlyName": { "type": "string", "description": "The name of recovery container friendly name." }, "protectionState": { "type": "string", "description": "The protection status." }, "protectionStateDescription": { "type": "string", "description": "The protection state description." }, "activeLocation": { "type": "string", "description": "The Current active location of the PE." }, "testFailoverState": { "type": "string", "description": "The Test failover state." }, "testFailoverStateDescription": { "type": "string", "description": "The Test failover state description." }, "switchProviderState": { "type": "string", "description": "The switch provider state." }, "switchProviderStateDescription": { "type": "string", "description": "The switch provider state description." }, "allowedOperations": { "type": "array", "description": "The allowed operations on the Replication protected item.", "items": { "type": "string" } }, "replicationHealth": { "type": "string", "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration." }, "failoverHealth": { "type": "string", "description": "The consolidated failover health for the VM." }, "healthErrors": { "type": "array", "description": "List of health errors.", "items": { "$ref": "#/definitions/HealthError" } }, "policyId": { "type": "string", "description": "The ID of Policy governing this PE." }, "policyFriendlyName": { "type": "string", "description": "The name of Policy governing this PE." }, "lastSuccessfulFailoverTime": { "type": "string", "format": "date-time", "description": "The Last successful failover time." }, "lastSuccessfulTestFailoverTime": { "type": "string", "format": "date-time", "description": "The Last successful test failover time." }, "currentScenario": { "$ref": "#/definitions/CurrentScenarioDetails", "description": "The current scenario." }, "failoverRecoveryPointId": { "type": "string", "description": "The recovery point ARM Id to which the Vm was failed over." }, "providerSpecificDetails": { "$ref": "#/definitions/ReplicationProviderSpecificSettings", "description": "The Replication provider custom settings." }, "recoveryContainerId": { "type": "string", "description": "The recovery container Id." }, "eventCorrelationId": { "type": "string", "description": "The correlation Id for events associated with this protected item." } } }, "ReplicationProtectionCluster": { "type": "object", "description": "Replication protection Cluster.", "properties": { "properties": { "$ref": "#/definitions/ReplicationProtectionClusterProperties", "description": "The custom data." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ReplicationProtectionClusterCollection": { "type": "object", "description": "Replication protected item collection.", "properties": { "value": { "type": "array", "description": "The ReplicationProtectionCluster items on this page", "items": { "$ref": "#/definitions/ReplicationProtectionCluster" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ReplicationProtectionClusterProperties": { "type": "object", "description": "Replication protection cluster custom data details.", "properties": { "protectionClusterType": { "type": "string", "description": "The type of protection cluster type." }, "primaryFabricFriendlyName": { "type": "string", "description": "The friendly name of the primary fabric." }, "primaryFabricProvider": { "type": "string", "description": "The fabric provider of the primary fabric." }, "recoveryFabricFriendlyName": { "type": "string", "description": "The friendly name of recovery fabric." }, "recoveryFabricId": { "type": "string", "format": "arm-id", "description": "The Arm Id of recovery fabric.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.RecoveryServices/vaults/replicationFabrics" } ] } }, "primaryProtectionContainerFriendlyName": { "type": "string", "description": "The name of primary protection container friendly name." }, "recoveryProtectionContainerFriendlyName": { "type": "string", "description": "The name of recovery container friendly name." }, "protectionState": { "type": "string", "description": "The protection status." }, "protectionStateDescription": { "type": "string", "description": "The protection state description." }, "activeLocation": { "type": "string", "description": "The Current active location of the Protection cluster." }, "testFailoverState": { "type": "string", "description": "The Test failover state." }, "testFailoverStateDescription": { "type": "string", "description": "The Test failover state description." }, "allowedOperations": { "type": "array", "description": "The allowed operations on the Replication protection cluster.", "items": { "type": "string" } }, "replicationHealth": { "type": "string", "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration." }, "healthErrors": { "type": "array", "description": "List of health errors.", "items": { "$ref": "#/definitions/HealthError" }, "x-ms-identifiers": [] }, "lastSuccessfulFailoverTime": { "type": "string", "format": "date-time", "description": "The last successful failover time." }, "lastSuccessfulTestFailoverTime": { "type": "string", "format": "date-time", "description": "The last successful test failover time." }, "policyFriendlyName": { "type": "string", "description": "The name of Policy governing this PE." }, "currentScenario": { "$ref": "#/definitions/CurrentScenarioDetails", "description": "The current scenario." }, "recoveryContainerId": { "type": "string", "format": "arm-id", "description": "The recovery container Id.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers" } ] } }, "agentClusterId": { "type": "string", "description": "The Agent cluster Id." }, "clusterFqdn": { "type": "string", "description": "The cluster FQDN." }, "clusterNodeFqdns": { "type": "array", "description": "The List of cluster Node FQDNs.", "items": { "type": "string" } }, "clusterProtectedItemIds": { "type": "array", "description": "The List of Protected Item Id's.", "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.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectedItems" } ] } } }, "provisioningState": { "type": "string", "description": "The provisioning state of the cluster.", "readOnly": true }, "areAllClusterNodesRegistered": { "type": "boolean", "description": "A value indicating whether all nodes of the cluster are registered or not." }, "clusterRegisteredNodes": { "type": "array", "description": "The registered node details.", "items": { "$ref": "#/definitions/RegisteredClusterNodes" }, "x-ms-identifiers": [ "clusterNodeFqdn" ] }, "providerSpecificDetails": { "$ref": "#/definitions/ReplicationClusterProviderSpecificSettings", "description": "The Replication cluster provider custom settings." }, "sharedDiskProperties": { "$ref": "#/definitions/SharedDiskReplicationItemProperties", "description": "The shared disk properties." }, "policyId": { "type": "string", "format": "arm-id", "description": "The Policy Id.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.RecoveryServices/vaults/replicationPolicies" } ] } } } }, "ReplicationProtectionIntent": { "type": "object", "description": "Replication protection intent.", "properties": { "properties": { "$ref": "#/definitions/ReplicationProtectionIntentProperties", "description": "The custom data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "ReplicationProtectionIntentCollection": { "type": "object", "description": "Replication protection intent objects collection.", "properties": { "value": { "type": "array", "description": "The ReplicationProtectionIntent items on this page", "items": { "$ref": "#/definitions/ReplicationProtectionIntent" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ReplicationProtectionIntentProperties": { "type": "object", "description": "Replication protection intent custom data details.", "properties": { "friendlyName": { "type": "string", "description": "The name." }, "jobId": { "type": "string", "description": "The job Id.", "readOnly": true }, "jobState": { "type": "string", "description": "The job state.", "readOnly": true }, "isActive": { "type": "boolean", "description": "A value indicating whether the intent object is active.", "readOnly": true }, "creationTimeUTC": { "type": "string", "description": "The creation time in UTC.", "readOnly": true }, "providerSpecificDetails": { "$ref": "#/definitions/ReplicationProtectionIntentProviderSpecificSettings", "description": "The Replication provider custom settings." } } }, "ReplicationProtectionIntentProviderSpecificSettings": { "type": "object", "description": "Replication provider specific settings.", "properties": { "instanceType": { "type": "string", "description": "Gets the Instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ReplicationProviderContainerUnmappingInput": { "type": "object", "description": "Provider specific input for unpairing operations.", "properties": { "instanceType": { "type": "string", "description": "The class type." } } }, "ReplicationProviderSpecificContainerCreationInput": { "type": "object", "description": "Provider specific input for container creation operation.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ReplicationProviderSpecificContainerMappingInput": { "type": "object", "description": "Provider specific input for pairing operations.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ReplicationProviderSpecificSettings": { "type": "object", "description": "Replication provider specific settings.", "properties": { "instanceType": { "type": "string", "description": "Gets the Instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ReplicationProviderSpecificUpdateContainerMappingInput": { "type": "object", "description": "Provider specific input for update pairing operations.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ReprotectAgentDetails": { "type": "object", "description": "Reprotect agent details.", "properties": { "id": { "type": "string", "description": "The reprotect agent Id.", "readOnly": true }, "name": { "type": "string", "description": "The reprotect agent name.", "readOnly": true }, "biosId": { "type": "string", "description": "The reprotect agent Bios Id.", "readOnly": true }, "fabricObjectId": { "type": "string", "description": "The fabric object Id.", "readOnly": true }, "fqdn": { "type": "string", "description": "The reprotect agent Fqdn.", "readOnly": true }, "version": { "type": "string", "description": "The version.", "readOnly": true }, "lastHeartbeatUtc": { "type": "string", "format": "date-time", "description": "The last heartbeat received from the reprotect agent.", "readOnly": true }, "health": { "$ref": "#/definitions/ProtectionHealth", "description": "The health of the reprotect agent.", "readOnly": true }, "healthErrors": { "type": "array", "description": "The health errors.", "items": { "$ref": "#/definitions/HealthError" }, "readOnly": true, "x-ms-identifiers": [ "errorCode" ] }, "protectedItemCount": { "type": "integer", "format": "int32", "description": "The protected item count.", "readOnly": true }, "accessibleDatastores": { "type": "array", "description": "The list of accessible datastores fetched from discovery.", "items": { "type": "string" }, "readOnly": true }, "vcenterId": { "type": "string", "description": "The Vcenter Id.", "readOnly": true }, "lastDiscoveryInUtc": { "type": "string", "format": "date-time", "description": "The last time when SDS information discovered in SRS.", "readOnly": true } } }, "ResolveHealthError": { "type": "object", "description": "Resolve health errors input properties.", "properties": { "healthErrorId": { "type": "string", "description": "Health error id." } } }, "ResolveHealthInput": { "type": "object", "description": "Resolve health input.", "properties": { "properties": { "$ref": "#/definitions/ResolveHealthInputProperties", "description": "Disable resolve health input properties." } } }, "ResolveHealthInputProperties": { "type": "object", "description": "Resolve health input properties.", "properties": { "healthErrors": { "type": "array", "description": "Health errors.", "items": { "$ref": "#/definitions/ResolveHealthError" } } } }, "ResourceHealthSummary": { "type": "object", "description": "Base class to define the health summary of the resources contained under an Arm resource.", "properties": { "resourceCount": { "type": "integer", "format": "int32", "description": "The count of total resources under the container." }, "issues": { "type": "array", "description": "The list of summary of health errors across the resources under the container.", "items": { "$ref": "#/definitions/HealthErrorSummary" } }, "categorizedResourceCounts": { "type": "object", "description": "The categorized resource counts.", "additionalProperties": { "format": "int32", "type": "integer" } } } }, "ResumeJobParams": { "type": "object", "description": "Resume job params.", "properties": { "properties": { "$ref": "#/definitions/ResumeJobParamsProperties", "description": "Resume job properties." } } }, "ResumeJobParamsProperties": { "type": "object", "description": "Resume job properties.", "properties": { "comments": { "type": "string", "description": "Resume job comments." } } }, "ResumeReplicationInput": { "type": "object", "description": "Resume replication input.", "properties": { "properties": { "$ref": "#/definitions/ResumeReplicationInputProperties", "description": "Resume replication input properties." } }, "required": [ "properties" ] }, "ResumeReplicationInputProperties": { "type": "object", "description": "Resume replication input properties.", "properties": { "providerSpecificDetails": { "$ref": "#/definitions/ResumeReplicationProviderSpecificInput", "description": "The provider specific input for resume replication." } }, "required": [ "providerSpecificDetails" ] }, "ResumeReplicationProviderSpecificInput": { "type": "object", "description": "Resume replication provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ResyncInput": { "type": "object", "description": "Resync input.", "properties": { "properties": { "$ref": "#/definitions/ResyncInputProperties", "description": "Resync input properties." } }, "required": [ "properties" ] }, "ResyncInputProperties": { "type": "object", "description": "Resync input properties.", "properties": { "providerSpecificDetails": { "$ref": "#/definitions/ResyncProviderSpecificInput", "description": "The provider specific details." } }, "required": [ "providerSpecificDetails" ] }, "ResyncProviderSpecificInput": { "type": "object", "description": "Resync provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "ResyncState": { "type": "string", "description": "The resync state.", "enum": [ "None", "PreparedForResynchronization", "StartedResynchronization" ], "x-ms-enum": { "name": "ResyncState", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "PreparedForResynchronization", "value": "PreparedForResynchronization", "description": "PreparedForResynchronization" }, { "name": "StartedResynchronization", "value": "StartedResynchronization", "description": "StartedResynchronization" } ] } }, "RetentionVolume": { "type": "object", "description": "The retention details of the MT.", "properties": { "volumeName": { "type": "string", "description": "The volume name." }, "capacityInBytes": { "type": "integer", "format": "int64", "description": "The volume capacity." }, "freeSpaceInBytes": { "type": "integer", "format": "int64", "description": "The free space available in this volume." }, "thresholdPercentage": { "type": "integer", "format": "int32", "description": "The threshold percentage." } } }, "ReverseReplicationInput": { "type": "object", "description": "Reverse replication input.", "properties": { "properties": { "$ref": "#/definitions/ReverseReplicationInputProperties", "description": "Reverse replication properties." } } }, "ReverseReplicationInputProperties": { "type": "object", "description": "Reverse replication input properties.", "properties": { "failoverDirection": { "type": "string", "description": "Failover direction." }, "providerSpecificDetails": { "$ref": "#/definitions/ReverseReplicationProviderSpecificInput", "description": "Provider specific reverse replication input." } } }, "ReverseReplicationProviderSpecificInput": { "type": "object", "description": "Provider specific reverse replication input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "RpInMageRecoveryPointType": { "type": "string", "description": "The recovery point type.", "enum": [ "LatestTime", "LatestTag", "Custom" ], "x-ms-enum": { "name": "RpInMageRecoveryPointType", "modelAsString": true, "values": [ { "name": "LatestTime", "value": "LatestTime", "description": "LatestTime" }, { "name": "LatestTag", "value": "LatestTag", "description": "LatestTag" }, { "name": "Custom", "value": "Custom", "description": "Custom" } ] } }, "RunAsAccount": { "type": "object", "description": "CS Accounts Details.", "properties": { "accountId": { "type": "string", "description": "The CS RunAs account Id." }, "accountName": { "type": "string", "description": "The CS RunAs account name." } } }, "ScriptActionTaskDetails": { "type": "object", "description": "This class represents the script action task details.", "properties": { "name": { "type": "string", "description": "The name." }, "path": { "type": "string", "description": "The path." }, "output": { "type": "string", "description": "The output." }, "isPrimarySideScript": { "type": "boolean", "description": "A value indicating whether it is a primary side script or not." } }, "allOf": [ { "$ref": "#/definitions/TaskTypeDetails" } ], "x-ms-discriminator-value": "ScriptActionTaskDetails" }, "SecretString": { "type": "string", "format": "password", "description": "A string value that contains secret material.", "x-ms-secret": true }, "SecurityConfiguration": { "type": "string", "description": "Security configuration state.", "enum": [ "Disabled", "Enabled" ], "x-ms-enum": { "name": "SecurityConfiguration", "modelAsString": true, "values": [ { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Enabled", "value": "Enabled", "description": "Enabled" } ] } }, "SecurityProfileProperties": { "type": "object", "description": "Security profile input.", "properties": { "targetVmSecurityType": { "$ref": "#/definitions/SecurityType", "description": "The target VM security type." }, "targetVmSecureBoot": { "$ref": "#/definitions/SecurityConfiguration", "description": "A value indicating whether secure boot to be enabled." }, "targetVmTpm": { "$ref": "#/definitions/SecurityConfiguration", "description": "A value indicating whether trusted platform module to be enabled." }, "targetVmMonitoring": { "$ref": "#/definitions/SecurityConfiguration", "description": "A value indicating whether integrity monitoring to be enabled." }, "targetVmConfidentialEncryption": { "$ref": "#/definitions/SecurityConfiguration", "description": "A value indicating whether confidential compute encryption to be enabled." } } }, "SecurityType": { "type": "string", "description": "The target VM security type.", "enum": [ "None", "TrustedLaunch", "ConfidentialVM" ], "x-ms-enum": { "name": "SecurityType", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "TrustedLaunch", "value": "TrustedLaunch", "description": "TrustedLaunch" }, { "name": "ConfidentialVM", "value": "ConfidentialVM", "description": "ConfidentialVM" } ] } }, "ServiceError": { "type": "object", "description": "ASR error model.", "properties": { "code": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "Error message." }, "possibleCauses": { "type": "string", "description": "Possible causes of error." }, "recommendedAction": { "type": "string", "description": "Recommended action to resolve error." }, "activityId": { "type": "string", "description": "Activity Id." } } }, "SetMultiVmSyncStatus": { "type": "string", "description": "A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'.", "enum": [ "Enable", "Disable" ], "x-ms-enum": { "name": "SetMultiVmSyncStatus", "modelAsString": true, "values": [ { "name": "Enable", "value": "Enable", "description": "Enable" }, { "name": "Disable", "value": "Disable", "description": "Disable" } ] } }, "Severity": { "type": "string", "description": "Severity of error.", "enum": [ "NONE", "Warning", "Error", "Info" ], "x-ms-enum": { "name": "Severity", "modelAsString": true, "values": [ { "name": "NONE", "value": "NONE", "description": "NONE" }, { "name": "Warning", "value": "Warning", "description": "Warning" }, { "name": "Error", "value": "Error", "description": "Error" }, { "name": "Info", "value": "Info", "description": "Info" } ] } }, "SharedDiskReplicationItemProperties": { "type": "object", "description": "Shared Disk Replication item custom data details.", "properties": { "protectionState": { "type": "string", "description": "The protection state of shared disk." }, "testFailoverState": { "type": "string", "description": "The tfo state of shared disk." }, "activeLocation": { "type": "string", "description": "The Current active location of the PE." }, "allowedOperations": { "type": "array", "description": "The allowed operations on the Replication protected item.", "items": { "type": "string" } }, "replicationHealth": { "type": "string", "description": "The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration." }, "healthErrors": { "type": "array", "description": "List of health errors.", "items": { "$ref": "#/definitions/HealthError" }, "x-ms-identifiers": [ "errorCode" ] }, "currentScenario": { "$ref": "#/definitions/CurrentScenarioDetails", "description": "The current scenario." }, "sharedDiskProviderSpecificDetails": { "$ref": "#/definitions/SharedDiskReplicationProviderSpecificSettings", "description": "The Replication provider custom settings." } } }, "SharedDiskReplicationProviderSpecificSettings": { "type": "object", "description": "Replication provider specific settings.", "properties": { "instanceType": { "type": "string", "description": "Gets the Instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "SourceSiteOperations": { "type": "string", "description": "A value indicating whether source site operations are required.", "enum": [ "Required", "NotRequired" ], "x-ms-enum": { "name": "SourceSiteOperations", "modelAsString": true, "values": [ { "name": "Required", "value": "Required", "description": "Required" }, { "name": "NotRequired", "value": "NotRequired", "description": "NotRequired" } ] } }, "SqlServerLicenseType": { "type": "string", "description": "The SQL Server license type.", "enum": [ "NotSpecified", "NoLicenseType", "PAYG", "AHUB" ], "x-ms-enum": { "name": "SqlServerLicenseType", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified" }, { "name": "NoLicenseType", "value": "NoLicenseType", "description": "NoLicenseType" }, { "name": "PAYG", "value": "PAYG", "description": "PAYG" }, { "name": "AHUB", "value": "AHUB", "description": "AHUB" } ] } }, "StorageAccountCustomDetails": { "type": "object", "description": "Storage account custom input.", "properties": { "resourceType": { "type": "string", "description": "The class type." } }, "discriminator": "resourceType", "required": [ "resourceType" ] }, "StorageClassification": { "type": "object", "description": "Storage object definition.", "properties": { "properties": { "$ref": "#/definitions/StorageClassificationProperties", "description": "Properties of the storage object." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "StorageClassificationCollection": { "type": "object", "description": "Collection of storage details.", "properties": { "value": { "type": "array", "description": "The StorageClassification items on this page", "items": { "$ref": "#/definitions/StorageClassification" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "StorageClassificationMapping": { "type": "object", "description": "Storage mapping object.", "properties": { "properties": { "$ref": "#/definitions/StorageClassificationMappingProperties", "description": "Properties of the storage mapping object." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "StorageClassificationMappingCollection": { "type": "object", "description": "Collection of storage mapping details.", "properties": { "value": { "type": "array", "description": "The StorageClassificationMapping items on this page", "items": { "$ref": "#/definitions/StorageClassificationMapping" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "StorageClassificationMappingInput": { "type": "object", "description": "Storage mapping input.", "properties": { "properties": { "$ref": "#/definitions/StorageMappingInputProperties", "description": "Storage mapping input properties." } } }, "StorageClassificationMappingProperties": { "type": "object", "description": "Storage mapping properties.", "properties": { "targetStorageClassificationId": { "type": "string", "description": "Target storage object Id." } } }, "StorageClassificationProperties": { "type": "object", "description": "Storage object properties.", "properties": { "friendlyName": { "type": "string", "description": "Friendly name of the Storage classification." } } }, "StorageMappingInputProperties": { "type": "object", "description": "Storage mapping input properties.", "properties": { "targetStorageClassificationId": { "type": "string", "description": "The ID of the storage object." } } }, "Subnet": { "type": "object", "description": "Subnets of the network.", "properties": { "name": { "type": "string", "description": "The subnet name." }, "friendlyName": { "type": "string", "description": "The subnet friendly name." }, "addressList": { "type": "array", "description": "The list of addresses for the subnet.", "items": { "type": "string" } } } }, "SupportedOSDetails": { "type": "object", "description": "Supported operating system details.", "properties": { "osName": { "type": "string", "description": "The name." }, "osType": { "type": "string", "description": "The type." }, "osVersions": { "type": "array", "description": "The list of version for operating system.", "items": { "$ref": "#/definitions/OSVersionWrapper" } } } }, "SupportedOSProperties": { "type": "object", "description": "Supported operating systems properties.", "properties": { "supportedOsList": { "type": "array", "description": "The supported operating systems property list.", "items": { "$ref": "#/definitions/SupportedOSProperty" } } } }, "SupportedOSProperty": { "type": "object", "description": "Supported operating systems property.", "properties": { "instanceType": { "type": "string", "description": "The replication provider type." }, "supportedOs": { "type": "array", "description": "The list of supported operating systems.", "items": { "$ref": "#/definitions/SupportedOSDetails" } } } }, "SupportedOperatingSystems": { "type": "object", "description": "Supported operating systems.", "properties": { "properties": { "$ref": "#/definitions/SupportedOSProperties", "description": "The supported operating systems properties." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ] }, "SwitchClusterProtectionInput": { "type": "object", "description": "Switch cluster protection input.", "properties": { "properties": { "$ref": "#/definitions/SwitchClusterProtectionInputProperties", "description": "Switch cluster protection properties." } } }, "SwitchClusterProtectionInputProperties": { "type": "object", "description": "Switch cluster protection input properties.", "properties": { "replicationProtectionClusterName": { "type": "string", "description": "The unique replication protection cluster name." }, "providerSpecificDetails": { "$ref": "#/definitions/SwitchClusterProtectionProviderSpecificInput", "description": "Provider specific switch protection input." } } }, "SwitchClusterProtectionProviderSpecificInput": { "type": "object", "description": "Provider specific switch cluster protection input.", "properties": { "instanceType": { "type": "string", "description": "Gets the Instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "SwitchProtectionInput": { "type": "object", "description": "Switch protection input.", "properties": { "properties": { "$ref": "#/definitions/SwitchProtectionInputProperties", "description": "Switch protection properties." } } }, "SwitchProtectionInputProperties": { "type": "object", "description": "Switch protection input properties.", "properties": { "replicationProtectedItemName": { "type": "string", "description": "The unique replication protected item name." }, "providerSpecificDetails": { "$ref": "#/definitions/SwitchProtectionProviderSpecificInput", "description": "Provider specific switch protection input." } } }, "SwitchProtectionJobDetails": { "type": "object", "description": "This class represents details for switch protection job.", "properties": { "newReplicationProtectedItemId": { "type": "string", "description": "ARM Id of the new replication protected item." } }, "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "x-ms-discriminator-value": "SwitchProtectionJobDetails" }, "SwitchProtectionProviderSpecificInput": { "type": "object", "description": "Provider specific switch protection input.", "properties": { "instanceType": { "type": "string", "description": "Gets the Instance type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "SwitchProviderInput": { "type": "object", "description": "Input definition for switch provider.", "properties": { "properties": { "$ref": "#/definitions/SwitchProviderInputProperties", "description": "Switch provider input properties." } } }, "SwitchProviderInputProperties": { "type": "object", "description": "Input definition for switch provider input properties.", "properties": { "targetInstanceType": { "type": "string", "description": "Target provider type." }, "providerSpecificDetails": { "$ref": "#/definitions/SwitchProviderProviderSpecificInput", "description": "Provider specific settings." } } }, "SwitchProviderProviderSpecificInput": { "type": "object", "description": "Provider specific switch provider input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "TargetComputeSize": { "type": "object", "description": "Represents applicable recovery vm sizes.", "properties": { "id": { "type": "string", "description": "The Id." }, "name": { "type": "string", "description": "The name." }, "type": { "type": "string", "description": "The Type of the object." }, "properties": { "$ref": "#/definitions/TargetComputeSizeProperties", "description": "The custom data." } } }, "TargetComputeSizeCollection": { "type": "object", "description": "Target compute size collection.", "properties": { "value": { "type": "array", "description": "The TargetComputeSize items on this page", "items": { "$ref": "#/definitions/TargetComputeSize" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "TargetComputeSizeProperties": { "type": "object", "description": "Represents applicable recovery vm sizes properties.", "properties": { "name": { "type": "string", "description": "Target compute size name." }, "friendlyName": { "type": "string", "description": "Target compute size display name." }, "cpuCoresCount": { "type": "integer", "format": "int32", "description": "The maximum cpu cores count supported by target compute size." }, "vCPUsAvailable": { "type": "integer", "format": "int32", "description": "The Available vCPUs supported by target compute size.", "readOnly": true }, "memoryInGB": { "type": "number", "format": "double", "description": "The maximum memory in GB supported by target compute size." }, "maxDataDiskCount": { "type": "integer", "format": "int32", "description": "The maximum data disks count supported by target compute size." }, "maxNicsCount": { "type": "integer", "format": "int32", "description": "The maximum Nics count supported by target compute size." }, "errors": { "type": "array", "description": "The reasons why the target compute size is not applicable for the protected item.", "items": { "$ref": "#/definitions/ComputeSizeErrorDetails" } }, "highIopsSupported": { "type": "string", "description": "The value indicating whether the target compute size supports high Iops." }, "hyperVGenerations": { "type": "array", "description": "The supported HyperV Generations.", "items": { "type": "string" } } } }, "TaskTypeDetails": { "type": "object", "description": "Task details based on specific task type.", "properties": { "instanceType": { "type": "string", "description": "The type of task details." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "TestFailoverCleanupInput": { "type": "object", "description": "Input definition for test failover cleanup.", "properties": { "properties": { "$ref": "#/definitions/TestFailoverCleanupInputProperties", "description": "Test failover cleanup input properties." } }, "required": [ "properties" ] }, "TestFailoverCleanupInputProperties": { "type": "object", "description": "Input definition for test failover cleanup input properties.", "properties": { "comments": { "type": "string", "description": "Test failover cleanup comments.", "maxLength": 1024 } } }, "TestFailoverInput": { "type": "object", "description": "Input definition for test failover.", "properties": { "properties": { "$ref": "#/definitions/TestFailoverInputProperties", "description": "Test failover input properties." } }, "required": [ "properties" ] }, "TestFailoverInputProperties": { "type": "object", "description": "Input definition for test failover input properties.", "properties": { "failoverDirection": { "type": "string", "description": "Test failover direction." }, "networkType": { "type": "string", "description": "Network type to be used for test failover." }, "networkId": { "type": "string", "description": "The id of the network to be used for test failover." }, "providerSpecificDetails": { "$ref": "#/definitions/TestFailoverProviderSpecificInput", "description": "Provider specific settings." } } }, "TestFailoverJobDetails": { "type": "object", "description": "This class represents the details for a test failover job.", "properties": { "testFailoverStatus": { "type": "string", "description": "The test failover status." }, "comments": { "type": "string", "description": "The test failover comments." }, "networkName": { "type": "string", "description": "The test network name." }, "networkFriendlyName": { "type": "string", "description": "The test network friendly name." }, "networkType": { "type": "string", "description": "The test network type (see TestFailoverInput enum for possible values)." }, "protectedItemDetails": { "type": "array", "description": "The test VM details.", "items": { "$ref": "#/definitions/FailoverReplicationProtectedItemDetails" } } }, "allOf": [ { "$ref": "#/definitions/JobDetails" } ], "x-ms-discriminator-value": "TestFailoverJobDetails" }, "TestFailoverProviderSpecificInput": { "type": "object", "description": "Provider specific test failover input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "TestMigrateCleanupInput": { "type": "object", "description": "Input for test migrate cleanup.", "properties": { "properties": { "$ref": "#/definitions/TestMigrateCleanupInputProperties", "description": "Test migrate cleanup input properties." } }, "required": [ "properties" ] }, "TestMigrateCleanupInputProperties": { "type": "object", "description": "Test migrate cleanup input properties.", "properties": { "comments": { "type": "string", "description": "Test migrate cleanup comments.", "maxLength": 1024 } } }, "TestMigrateInput": { "type": "object", "description": "Input for test migrate.", "properties": { "properties": { "$ref": "#/definitions/TestMigrateInputProperties", "description": "Test migrate input properties." } }, "required": [ "properties" ] }, "TestMigrateInputProperties": { "type": "object", "description": "Test migrate input properties.", "properties": { "providerSpecificDetails": { "$ref": "#/definitions/TestMigrateProviderSpecificInput", "description": "The provider specific details." } }, "required": [ "providerSpecificDetails" ] }, "TestMigrateProviderSpecificInput": { "type": "object", "description": "Test migrate provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "TestMigrationState": { "type": "string", "description": "The test migrate state.", "enum": [ "None", "TestMigrationInProgress", "TestMigrationSucceeded", "TestMigrationFailed", "TestMigrationCleanupInProgress", "TestMigrationCompletedWithInformation", "TestMigrationPartiallySucceeded" ], "x-ms-enum": { "name": "TestMigrationState", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "TestMigrationInProgress", "value": "TestMigrationInProgress", "description": "TestMigrationInProgress" }, { "name": "TestMigrationSucceeded", "value": "TestMigrationSucceeded", "description": "TestMigrationSucceeded" }, { "name": "TestMigrationFailed", "value": "TestMigrationFailed", "description": "TestMigrationFailed" }, { "name": "TestMigrationCleanupInProgress", "value": "TestMigrationCleanupInProgress", "description": "TestMigrationCleanupInProgress" }, { "name": "TestMigrationCompletedWithInformation", "value": "TestMigrationCompletedWithInformation", "description": "TestMigrationCompletedWithInformation" }, { "name": "TestMigrationPartiallySucceeded", "value": "TestMigrationPartiallySucceeded", "description": "TestMigrationPartiallySucceeded" } ] } }, "UnplannedFailoverInput": { "type": "object", "description": "Input definition for unplanned failover.", "properties": { "properties": { "$ref": "#/definitions/UnplannedFailoverInputProperties", "description": "Unplanned failover input properties." } }, "required": [ "properties" ] }, "UnplannedFailoverInputProperties": { "type": "object", "description": "Input definition for unplanned failover input properties.", "properties": { "failoverDirection": { "type": "string", "description": "Failover direction." }, "sourceSiteOperations": { "type": "string", "description": "Source site operations status." }, "providerSpecificDetails": { "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput", "description": "Provider specific settings." } } }, "UnplannedFailoverProviderSpecificInput": { "type": "object", "description": "Provider specific unplanned failover input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "UpdateApplianceForReplicationProtectedItemInput": { "type": "object", "description": "Update appliance for replication protected item input.", "properties": { "properties": { "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemInputProperties", "description": "Update appliance replication protected item properties." } }, "required": [ "properties" ] }, "UpdateApplianceForReplicationProtectedItemInputProperties": { "type": "object", "description": "Update appliance for protected item input properties.", "properties": { "targetApplianceId": { "type": "string", "description": "The target appliance Id." }, "providerSpecificDetails": { "$ref": "#/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput", "description": "The provider specific input to update replication protected item." } }, "required": [ "targetApplianceId", "providerSpecificDetails" ] }, "UpdateApplianceForReplicationProtectedItemProviderSpecificInput": { "type": "object", "description": "Update replication protected item provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "UpdateConfidentialDiskEncryptionInfo": { "type": "object", "description": "Confidential disk encryption info used while updating replication of a CMK confidential VM managed disk.", "properties": { "recoveryTargetConfidentialDiskEncryptionSetId": { "type": "string", "format": "arm-id", "description": "The Azure resource ID of the confidential disk encryption set used for the target disk after failover. Applicable to CMK confidential VMs.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Compute/diskEncryptionSets" } ] } } } }, "UpdateDiskInput": { "type": "object", "description": "Disk input for update.", "properties": { "diskId": { "type": "string", "description": "The disk Id." }, "targetDiskName": { "type": "string", "description": "The target disk name." }, "iops": { "type": "integer", "format": "int64", "description": "The number of IOPS allowed for Premium V2 and Ultra disks." }, "throughputInMbps": { "type": "integer", "format": "int64", "description": "The total throughput in Mbps for Premium V2 and Ultra disks." }, "diskSizeInGB": { "type": "integer", "format": "int64", "description": "The target disk size in GB." } }, "required": [ "diskId" ] }, "UpdateMigrationItemInput": { "type": "object", "description": "Update migration item input.", "properties": { "properties": { "$ref": "#/definitions/UpdateMigrationItemInputProperties", "description": "Update migration item input properties." } } }, "UpdateMigrationItemInputProperties": { "type": "object", "description": "Update migration item input properties.", "properties": { "providerSpecificDetails": { "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput", "description": "The provider specific input to update migration item." } }, "required": [ "providerSpecificDetails" ] }, "UpdateMigrationItemProviderSpecificInput": { "type": "object", "description": "Update migration item provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "UpdateMobilityServiceRequest": { "type": "object", "description": "Request to update the mobility service on a protected item.", "properties": { "properties": { "$ref": "#/definitions/UpdateMobilityServiceRequestProperties", "description": "The properties of the update mobility service request." } } }, "UpdateMobilityServiceRequestProperties": { "type": "object", "description": "The properties of an update mobility service request.", "properties": { "runAsAccountId": { "type": "string", "description": "The CS run as account Id." } } }, "UpdateNetworkMappingInput": { "type": "object", "description": "Update network mapping input.", "properties": { "properties": { "$ref": "#/definitions/UpdateNetworkMappingInputProperties", "description": "The input properties needed to update network mapping." } } }, "UpdateNetworkMappingInputProperties": { "type": "object", "description": "Common input details for network mapping operation.", "properties": { "recoveryFabricName": { "type": "string", "description": "Recovery fabric name." }, "recoveryNetworkId": { "type": "string", "description": "Recovery network Id." }, "fabricSpecificDetails": { "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput", "description": "Fabrics specific input network Id." } } }, "UpdatePolicyInput": { "type": "object", "description": "Update policy input.", "properties": { "properties": { "$ref": "#/definitions/UpdatePolicyInputProperties", "description": "The ReplicationProviderSettings." } } }, "UpdatePolicyInputProperties": { "type": "object", "description": "Policy update properties.", "properties": { "replicationProviderSettings": { "$ref": "#/definitions/PolicyProviderSpecificInput", "description": "The ReplicationProviderSettings." } } }, "UpdateProtectionContainerMappingInput": { "type": "object", "description": "Container pairing update input.", "properties": { "properties": { "$ref": "#/definitions/UpdateProtectionContainerMappingInputProperties", "description": "Update protection container mapping input properties." } } }, "UpdateProtectionContainerMappingInputProperties": { "type": "object", "description": "Container pairing update input.", "properties": { "providerSpecificInput": { "$ref": "#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput", "description": "Provider specific input for updating protection container mapping." } } }, "UpdateRecoveryPlanInput": { "type": "object", "description": "Update recovery plan input class.", "properties": { "properties": { "$ref": "#/definitions/UpdateRecoveryPlanInputProperties", "description": "Recovery plan update properties." } } }, "UpdateRecoveryPlanInputProperties": { "type": "object", "description": "Recovery plan update properties.", "properties": { "groups": { "type": "array", "description": "The recovery plan groups.", "items": { "$ref": "#/definitions/RecoveryPlanGroup" } } } }, "UpdateReplicationProtectedItemInput": { "type": "object", "description": "Update replication protected item input.", "properties": { "properties": { "$ref": "#/definitions/UpdateReplicationProtectedItemInputProperties", "description": "Update replication protected item properties." } } }, "UpdateReplicationProtectedItemInputProperties": { "type": "object", "description": "Update protected item input properties.", "properties": { "recoveryAzureVMName": { "type": "string", "description": "Target Azure VM name given by the user." }, "recoveryAzureVMSize": { "type": "string", "description": "Target Azure VM size." }, "selectedRecoveryAzureNetworkId": { "type": "string", "description": "Target Azure Network Id." }, "selectedTfoAzureNetworkId": { "type": "string", "description": "The Azure Network Id for test failover." }, "selectedSourceNicId": { "type": "string", "description": "The selected source nic Id which will be used as the primary nic during failover." }, "enableRdpOnTargetOption": { "type": "string", "description": "The selected option to enable RDP\\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum." }, "vmNics": { "type": "array", "description": "The list of VM nic details.", "items": { "$ref": "#/definitions/VMNicInputDetails" } }, "licenseType": { "$ref": "#/definitions/LicenseType", "description": "License type." }, "recoveryAvailabilitySetId": { "type": "string", "description": "The target availability set Id." }, "providerSpecificDetails": { "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput", "description": "The provider specific input to update replication protected item." } } }, "UpdateReplicationProtectedItemProviderInput": { "type": "object", "description": "Update replication protected item provider specific input.", "properties": { "instanceType": { "type": "string", "description": "The class type." } }, "discriminator": "instanceType", "required": [ "instanceType" ] }, "UpdateVCenterRequest": { "type": "object", "description": "Input required to update vCenter.", "properties": { "properties": { "$ref": "#/definitions/UpdateVCenterRequestProperties", "description": "The update VCenter Request Properties." } } }, "UpdateVCenterRequestProperties": { "type": "object", "description": "The properties of an update vCenter request.", "properties": { "friendlyName": { "type": "string", "description": "The friendly name of the vCenter." }, "ipAddress": { "type": "string", "description": "The IP address of the vCenter to be discovered." }, "processServerId": { "type": "string", "description": "The process server Id from where the update can be orchestrated." }, "port": { "type": "string", "description": "The port number for discovery." }, "runAsAccountId": { "type": "string", "description": "The CS account Id which has privileges to update the vCenter." } } }, "UserCreatedResourceTag": { "type": "object", "description": "Resource tag input.", "properties": { "tagName": { "type": "string", "description": "The tag name. Please read for more information: https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources#limitations", "maxLength": 512 }, "tagValue": { "type": "string", "description": "The tag value. Please read her for more information: https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources#limitations", "maxLength": 256 } } }, "VCenter": { "type": "object", "description": "vCenter definition.", "properties": { "properties": { "$ref": "#/definitions/VCenterProperties", "description": "VCenter related data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "VCenterCollection": { "type": "object", "description": "Collection of vCenter details.", "properties": { "value": { "type": "array", "description": "The VCenter items on this page", "items": { "$ref": "#/definitions/VCenter" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "VCenterProperties": { "type": "object", "description": "vCenter properties.", "properties": { "friendlyName": { "type": "string", "description": "Friendly name of the vCenter." }, "internalId": { "type": "string", "description": "VCenter internal ID." }, "lastHeartbeat": { "type": "string", "format": "date-time", "description": "The time when the last heartbeat was received by vCenter." }, "discoveryStatus": { "type": "string", "description": "The VCenter discovery status." }, "processServerId": { "type": "string", "description": "The process server Id." }, "ipAddress": { "type": "string", "description": "The IP address of the vCenter." }, "infrastructureId": { "type": "string", "description": "The infrastructure Id of vCenter." }, "port": { "type": "string", "description": "The port number for discovery." }, "runAsAccountId": { "type": "string", "description": "The account Id which has privileges to discover the vCenter." }, "fabricArmResourceName": { "type": "string", "description": "The ARM resource name of the fabric containing this VCenter." }, "healthErrors": { "type": "array", "description": "The health errors for this VCenter.", "items": { "$ref": "#/definitions/HealthError" } } } }, "VMNicDetails": { "type": "object", "description": "Hyper V VM network details.", "properties": { "nicId": { "type": "string", "description": "The nic Id." }, "replicaNicId": { "type": "string", "description": "The replica nic Id." }, "sourceNicArmId": { "type": "string", "description": "The source nic ARM Id." }, "vMNetworkName": { "type": "string", "description": "VM network name." }, "recoveryVMNetworkId": { "type": "string", "description": "Recovery VM network Id." }, "ipConfigs": { "type": "array", "description": "The IP configurations of the NIC.", "items": { "$ref": "#/definitions/IPConfigDetails" } }, "selectionType": { "type": "string", "description": "Selection type for failover." }, "recoveryNetworkSecurityGroupId": { "type": "string", "description": "The id of the NSG associated with the NIC." }, "enableAcceleratedNetworkingOnRecovery": { "type": "boolean", "description": "A value indicating whether the NIC has accelerated networking enabled." }, "tfoVMNetworkId": { "type": "string", "description": "The network to be used by NIC during test failover." }, "tfoNetworkSecurityGroupId": { "type": "string", "description": "The NSG to be used by NIC during test failover." }, "enableAcceleratedNetworkingOnTfo": { "type": "boolean", "description": "Whether the TFO NIC has accelerated networking enabled." }, "recoveryNicName": { "type": "string", "description": "The name of the NIC to be used when creating target NICs." }, "recoveryNicResourceGroupName": { "type": "string", "description": "The resource group of the NIC to be used when creating target NICs." }, "reuseExistingNic": { "type": "boolean", "description": "A value indicating whether an existing NIC is allowed to be reused during failover subject to availability.", "default": false }, "tfoRecoveryNicName": { "type": "string", "description": "The name of the NIC to be used when creating target NICs in TFO." }, "tfoRecoveryNicResourceGroupName": { "type": "string", "description": "The resource group of the NIC to be used when creating target NICs in TFO." }, "tfoReuseExistingNic": { "type": "boolean", "description": "A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability.", "default": false }, "targetNicName": { "type": "string", "description": "Target NIC name." } } }, "VMNicInputDetails": { "type": "object", "description": "Hyper V VM network input details.", "properties": { "nicId": { "type": "string", "description": "The nic Id." }, "ipConfigs": { "type": "array", "description": "The IP configurations to be used by NIC during test failover and failover.", "items": { "$ref": "#/definitions/IPConfigInputDetails" } }, "selectionType": { "type": "string", "description": "Selection type for failover." }, "recoveryNetworkSecurityGroupId": { "type": "string", "description": "The id of the NSG associated with the NIC." }, "enableAcceleratedNetworkingOnRecovery": { "type": "boolean", "description": "Whether the NIC has accelerated networking enabled." }, "tfoNetworkSecurityGroupId": { "type": "string", "description": "The NSG to be used by NIC during test failover." }, "enableAcceleratedNetworkingOnTfo": { "type": "boolean", "description": "Whether the test NIC has accelerated networking enabled." }, "recoveryNicName": { "type": "string", "description": "The name of the NIC to be used when creating target NICs." }, "recoveryNicResourceGroupName": { "type": "string", "description": "The resource group of the NIC to be used when creating target NICs." }, "reuseExistingNic": { "type": "boolean", "description": "A value indicating whether an existing NIC is allowed to be reused during failover subject to availability." }, "tfoNicName": { "type": "string", "description": "The name of the NIC to be used when creating target NICs in TFO." }, "tfoNicResourceGroupName": { "type": "string", "description": "The resource group of the NIC to be used when creating target NICs in TFO." }, "tfoReuseExistingNic": { "type": "boolean", "description": "A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability." }, "targetNicName": { "type": "string", "description": "Target NIC name." } } }, "VMwareCbtContainerCreationInput": { "type": "object", "description": "VMwareCbt container creation input.", "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtContainerMappingInput": { "type": "object", "description": "VMwareCbt container mapping input.", "properties": { "keyVaultId": { "type": "string", "description": "The target key vault ARM Id." }, "keyVaultUri": { "type": "string", "description": "The target key vault URL." }, "storageAccountId": { "type": "string", "description": "The storage account ARM Id." }, "storageAccountSasSecretName": { "type": "string", "description": "The secret name of the storage account." }, "serviceBusConnectionStringSecretName": { "type": "string", "description": "The secret name of the service bus connection string." }, "targetLocation": { "type": "string", "description": "The target location." } }, "required": [ "storageAccountId", "targetLocation" ], "allOf": [ { "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtDiskInput": { "type": "object", "description": "VMwareCbt disk input.", "properties": { "diskId": { "type": "string", "description": "The disk Id." }, "diskType": { "$ref": "#/definitions/DiskAccountType", "description": "The disk type." }, "isOSDisk": { "type": "string", "description": "A value indicating whether the disk is the OS disk." }, "logStorageAccountId": { "type": "string", "description": "The log storage account ARM Id." }, "logStorageAccountSasSecretName": { "type": "string", "description": "The key vault secret name of the log storage account." }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM Id." }, "confidentialDiskEncryptionSetId": { "type": "string", "description": "The ConfidentialDiskEncryptionSet ARM Id." }, "sectorSizeInBytes": { "type": "integer", "format": "int32", "description": "The logical sector size (in bytes), 512 by default." }, "iops": { "type": "integer", "format": "int64", "description": "The number of IOPS allowed for Premium V2 and Ultra disks." }, "throughputInMbps": { "type": "integer", "format": "int64", "description": "The total throughput in Mbps for Premium V2 and Ultra disks." }, "diskSizeInGB": { "type": "integer", "format": "int64", "description": "The target disk size in GB." } }, "required": [ "diskId", "isOSDisk", "logStorageAccountId", "logStorageAccountSasSecretName" ] }, "VMwareCbtEnableMigrationInput": { "type": "object", "description": "VMwareCbt specific enable migration input.", "properties": { "vmwareMachineId": { "type": "string", "description": "The ARM Id of the VM discovered in VMware." }, "disksToInclude": { "type": "array", "description": "The disks to include list.", "items": { "$ref": "#/definitions/VMwareCbtDiskInput" } }, "licenseType": { "$ref": "#/definitions/LicenseType", "description": "License type." }, "sqlServerLicenseType": { "$ref": "#/definitions/SqlServerLicenseType", "description": "The SQL Server license type." }, "linuxLicenseType": { "$ref": "#/definitions/LinuxLicenseType", "description": "The license type for Linux VM's." }, "performSqlBulkRegistration": { "type": "string", "description": "A value indicating whether bulk SQL RP registration to be done." }, "dataMoverRunAsAccountId": { "type": "string", "description": "The data mover run as account Id." }, "snapshotRunAsAccountId": { "type": "string", "description": "The snapshot run as account Id." }, "targetVmName": { "type": "string", "description": "The target VM name." }, "targetVmSize": { "type": "string", "description": "The target VM size." }, "targetResourceGroupId": { "type": "string", "description": "The target resource group ARM Id." }, "targetNetworkId": { "type": "string", "description": "The target network ARM Id." }, "testNetworkId": { "type": "string", "description": "The selected test network ARM Id." }, "targetSubnetName": { "type": "string", "description": "The target subnet name." }, "testSubnetName": { "type": "string", "description": "The selected test subnet name." }, "targetAvailabilitySetId": { "type": "string", "description": "The target availability set ARM Id." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The target proximity placement group ARM Id." }, "confidentialVmKeyVaultId": { "type": "string", "description": "The confidential VM key vault Id for ADE installation." }, "targetVmSecurityProfile": { "$ref": "#/definitions/VMwareCbtSecurityProfileProperties", "description": "The target VM security profile." }, "targetBootDiagnosticsStorageAccountId": { "type": "string", "description": "The target boot diagnostics storage account ARM Id." }, "performAutoResync": { "type": "string", "description": "A value indicating whether auto resync is to be done." }, "targetVmTags": { "type": "object", "description": "The target VM tags.", "additionalProperties": { "type": "string" } }, "seedDiskTags": { "type": "object", "description": "The tags for the seed disks.", "additionalProperties": { "type": "string" } }, "targetDiskTags": { "type": "object", "description": "The tags for the target disks.", "additionalProperties": { "type": "string" } }, "targetNicTags": { "type": "object", "description": "The tags for the target NICs.", "additionalProperties": { "type": "string" } }, "userSelectedOSName": { "type": "string", "description": "The OS name selected by user." }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "required": [ "vmwareMachineId", "disksToInclude", "dataMoverRunAsAccountId", "snapshotRunAsAccountId", "targetResourceGroupId", "targetNetworkId" ], "allOf": [ { "$ref": "#/definitions/EnableMigrationProviderSpecificInput" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtEventDetails": { "type": "object", "description": "Event details for VMwareCbt provider.", "properties": { "migrationItemName": { "type": "string", "description": "The migration item name.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/EventProviderSpecificDetails" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtMigrateInput": { "type": "object", "description": "VMwareCbt specific migrate input.", "properties": { "performShutdown": { "type": "string", "description": "A value indicating whether VM is to be shutdown." }, "osUpgradeVersion": { "type": "string", "description": "A value indicating the inplace OS Upgrade version." }, "postMigrationSteps": { "type": "array", "description": "The managed run command script input.", "items": { "$ref": "#/definitions/ManagedRunCommandScriptInput" }, "x-ms-identifiers": [ "stepName" ] }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "required": [ "performShutdown" ], "allOf": [ { "$ref": "#/definitions/MigrateProviderSpecificInput" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtMigrationDetails": { "type": "object", "description": "VMwareCbt provider specific settings.", "properties": { "vmwareMachineId": { "type": "string", "description": "The ARM Id of the VM discovered in VMware.", "readOnly": true }, "osType": { "type": "string", "description": "The type of the OS on the VM.", "readOnly": true }, "osName": { "type": "string", "description": "The name of the OS on the VM.", "readOnly": true }, "firmwareType": { "type": "string", "description": "The firmware type.", "readOnly": true }, "targetGeneration": { "type": "string", "description": "The target generation.", "readOnly": true }, "licenseType": { "type": "string", "description": "License Type of the VM to be used." }, "sqlServerLicenseType": { "type": "string", "description": "The SQL Server license type." }, "linuxLicenseType": { "$ref": "#/definitions/LinuxLicenseType", "description": "The license type for Linux VM's." }, "dataMoverRunAsAccountId": { "type": "string", "description": "The data mover run as account Id.", "readOnly": true }, "snapshotRunAsAccountId": { "type": "string", "description": "The snapshot run as account Id.", "readOnly": true }, "storageAccountId": { "type": "string", "description": "The replication storage account ARM Id. This is applicable only for the blob based replication test hook.", "readOnly": true }, "targetVmName": { "type": "string", "description": "Target VM name." }, "targetVmSize": { "type": "string", "description": "The target VM size." }, "targetLocation": { "type": "string", "description": "The target location.", "readOnly": true }, "targetResourceGroupId": { "type": "string", "description": "The target resource group Id." }, "targetAvailabilitySetId": { "type": "string", "description": "The target availability set Id." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The target proximity placement group Id." }, "confidentialVmKeyVaultId": { "type": "string", "description": "The confidential VM key vault Id for ADE installation." }, "targetVmSecurityProfile": { "$ref": "#/definitions/VMwareCbtSecurityProfileProperties", "description": "The target VM security profile." }, "targetBootDiagnosticsStorageAccountId": { "type": "string", "description": "The target boot diagnostics storage account ARM Id." }, "targetVmTags": { "type": "object", "description": "The target VM tags.", "additionalProperties": { "type": "string" } }, "protectedDisks": { "type": "array", "description": "The list of protected disks.", "items": { "$ref": "#/definitions/VMwareCbtProtectedDiskDetails" } }, "targetNetworkId": { "type": "string", "description": "The target network Id." }, "testNetworkId": { "type": "string", "description": "The test network Id." }, "vmNics": { "type": "array", "description": "The network details.", "items": { "$ref": "#/definitions/VMwareCbtNicDetails" } }, "targetNicTags": { "type": "object", "description": "The tags for the target NICs.", "additionalProperties": { "type": "string" } }, "migrationRecoveryPointId": { "type": "string", "description": "The recovery point Id to which the VM was migrated.", "readOnly": true }, "lastRecoveryPointReceived": { "type": "string", "format": "date-time", "description": "The last recovery point received time.", "readOnly": true }, "lastRecoveryPointId": { "type": "string", "description": "The last recovery point Id.", "readOnly": true }, "initialSeedingProgressPercentage": { "type": "integer", "format": "int32", "description": "The initial seeding progress percentage.", "readOnly": true }, "migrationProgressPercentage": { "type": "integer", "format": "int32", "description": "The migration progress percentage.", "readOnly": true }, "resyncProgressPercentage": { "type": "integer", "format": "int32", "description": "The resync progress percentage.", "readOnly": true }, "resumeProgressPercentage": { "type": "integer", "format": "int32", "description": "The resume progress percentage.", "readOnly": true }, "deltaSyncProgressPercentage": { "type": "integer", "format": "int32", "description": "The delta sync progress percentage.", "readOnly": true }, "isCheckSumResyncCycle": { "type": "string", "description": "A value indicating whether checksum resync cycle is in progress.", "readOnly": true }, "initialSeedingRetryCount": { "type": "integer", "format": "int64", "description": "The initial seeding retry count.", "readOnly": true }, "resyncRetryCount": { "type": "integer", "format": "int64", "description": "The resync retry count.", "readOnly": true }, "resumeRetryCount": { "type": "integer", "format": "int64", "description": "The resume retry count.", "readOnly": true }, "deltaSyncRetryCount": { "type": "integer", "format": "int64", "description": "The delta sync retry count.", "readOnly": true }, "resyncRequired": { "type": "string", "description": "A value indicating whether resync is required.", "readOnly": true }, "resyncState": { "$ref": "#/definitions/ResyncState", "description": "The resync state.", "readOnly": true }, "performAutoResync": { "type": "string", "description": "A value indicating whether auto resync is to be done." }, "seedDiskTags": { "type": "object", "description": "The tags for the seed disks.", "additionalProperties": { "type": "string" } }, "targetDiskTags": { "type": "object", "description": "The tags for the target disks.", "additionalProperties": { "type": "string" } }, "supportedOSVersions": { "type": "array", "description": "A value indicating the inplace OS Upgrade version.", "items": { "type": "string" } }, "applianceMonitoringDetails": { "$ref": "#/definitions/ApplianceMonitoringDetails", "description": "A value indicating the appliance monitoring details.", "readOnly": true }, "gatewayOperationDetails": { "$ref": "#/definitions/GatewayOperationDetails", "description": "A value indicating the gateway operation details.", "readOnly": true }, "operationName": { "type": "string", "description": "A value indicating the SRS operation name.", "readOnly": true }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "allOf": [ { "$ref": "#/definitions/MigrationProviderSpecificSettings" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtNicDetails": { "type": "object", "description": "VMwareCbt NIC details.", "properties": { "nicId": { "type": "string", "description": "The NIC Id.", "readOnly": true }, "isPrimaryNic": { "type": "string", "description": "A value indicating whether this is the primary NIC." }, "sourceIPAddress": { "type": "string", "description": "The source IP address.", "readOnly": true }, "sourceIPAddressType": { "$ref": "#/definitions/EthernetAddressType", "description": "The source IP address type.", "readOnly": true }, "sourceNetworkId": { "type": "string", "description": "Source network Id.", "readOnly": true }, "targetIPAddress": { "type": "string", "description": "The target IP address." }, "targetIPAddressType": { "$ref": "#/definitions/EthernetAddressType", "description": "The target IP address type." }, "targetSubnetName": { "type": "string", "description": "Target subnet name." }, "testNetworkId": { "type": "string", "description": "Source network Id." }, "testSubnetName": { "type": "string", "description": "Test subnet name." }, "testIPAddress": { "type": "string", "description": "The test IP address." }, "testIPAddressType": { "$ref": "#/definitions/EthernetAddressType", "description": "The test IP address type." }, "targetNicName": { "type": "string", "description": "Target NIC name." }, "isSelectedForMigration": { "type": "string", "description": "A value indicating whether this NIC is selected for migration." } } }, "VMwareCbtNicInput": { "type": "object", "description": "VMwareCbt NIC input.", "properties": { "nicId": { "type": "string", "description": "The NIC Id." }, "isPrimaryNic": { "type": "string", "description": "A value indicating whether this is the primary NIC." }, "targetSubnetName": { "type": "string", "description": "Target subnet name." }, "targetStaticIPAddress": { "type": "string", "description": "The static IP address." }, "isSelectedForMigration": { "type": "string", "description": "A value indicating whether this NIC is selected for migration." }, "targetNicName": { "type": "string", "description": "Target NIC name." }, "testSubnetName": { "type": "string", "description": "The test subnet name." }, "testStaticIPAddress": { "type": "string", "description": "The test static IP address." } }, "required": [ "nicId", "isPrimaryNic" ] }, "VMwareCbtPolicyCreationInput": { "type": "object", "description": "VMware Cbt policy creation input.", "properties": { "recoveryPointHistoryInMinutes": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency (in minutes)." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency (in minutes)." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificInput" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtProtectedDiskDetails": { "type": "object", "description": "VMwareCbt protected disk details.", "properties": { "diskId": { "type": "string", "description": "The disk id.", "readOnly": true }, "diskName": { "type": "string", "description": "The disk name.", "readOnly": true }, "diskType": { "$ref": "#/definitions/DiskAccountType", "description": "The disk type." }, "diskPath": { "type": "string", "description": "The disk path.", "readOnly": true }, "isOSDisk": { "type": "string", "description": "A value indicating whether the disk is the OS disk.", "readOnly": true }, "capacityInBytes": { "type": "integer", "format": "int64", "description": "The disk capacity in bytes.", "readOnly": true }, "logStorageAccountId": { "type": "string", "description": "The log storage account ARM Id.", "readOnly": true }, "logStorageAccountSasSecretName": { "type": "string", "description": "The key vault secret name of the log storage account.", "readOnly": true }, "diskEncryptionSetId": { "type": "string", "description": "The DiskEncryptionSet ARM Id.", "readOnly": true }, "confidentialDiskEncryptionSetId": { "type": "string", "description": "The ConfidentialDiskEncryptionSet ARM Id.", "readOnly": true }, "seedManagedDiskId": { "type": "string", "description": "The ARM Id of the seed managed disk.", "readOnly": true }, "seedBlobUri": { "type": "string", "description": "The uri of the seed blob.", "readOnly": true }, "targetManagedDiskId": { "type": "string", "description": "The ARM Id of the target managed disk.", "readOnly": true }, "targetBlobUri": { "type": "string", "description": "The uri of the target blob.", "readOnly": true }, "targetDiskName": { "type": "string", "description": "The name for the target managed disk." }, "gatewayOperationDetails": { "$ref": "#/definitions/GatewayOperationDetails", "description": "A value indicating the gateway operation details.", "readOnly": true }, "sectorSizeInBytes": { "type": "integer", "format": "int32", "description": "The logical sector size (in bytes), 512 by default." }, "iops": { "type": "integer", "format": "int64", "description": "The number of IOPS allowed for Premium V2 and Ultra disks." }, "throughputInMbps": { "type": "integer", "format": "int64", "description": "The total throughput in Mbps for Premium V2 and Ultra disks." }, "diskSizeInGB": { "type": "integer", "format": "int64", "description": "The target disk size in GB." } } }, "VMwareCbtProtectionContainerMappingDetails": { "type": "object", "description": "VMwareCbt provider specific container mapping details.", "properties": { "keyVaultId": { "type": "string", "description": "The target key vault ARM Id.", "readOnly": true }, "keyVaultUri": { "type": "string", "description": "The target key vault URI.", "readOnly": true }, "storageAccountId": { "type": "string", "description": "The storage account ARM Id.", "readOnly": true }, "storageAccountSasSecretName": { "type": "string", "description": "The secret name of the storage account.", "readOnly": true }, "serviceBusConnectionStringSecretName": { "type": "string", "description": "The secret name of the service bus connection string.", "readOnly": true }, "targetLocation": { "type": "string", "description": "The target location.", "readOnly": true }, "roleSizeToNicCountMap": { "type": "object", "description": "The role size to NIC count map.", "additionalProperties": { "format": "int32", "type": "integer" }, "readOnly": true }, "excludedSkus": { "type": "array", "description": "The SKUs to be excluded.", "items": { "type": "string" } } }, "allOf": [ { "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtResumeReplicationInput": { "type": "object", "description": "VMwareCbt specific resume replication input.", "properties": { "deleteMigrationResources": { "type": "string", "description": "A value indicating whether Migration resources to be deleted." } }, "allOf": [ { "$ref": "#/definitions/ResumeReplicationProviderSpecificInput" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtResyncInput": { "type": "object", "description": "VMwareCbt specific resync input.", "properties": { "skipCbtReset": { "type": "string", "description": "A value indicating whether CBT is to be reset." } }, "required": [ "skipCbtReset" ], "allOf": [ { "$ref": "#/definitions/ResyncProviderSpecificInput" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtSecurityProfileProperties": { "type": "object", "description": "VMwareCbt security profile input.", "properties": { "targetVmSecurityType": { "$ref": "#/definitions/SecurityType", "description": "The target VM security type." }, "isTargetVmSecureBootEnabled": { "type": "string", "description": "A value indicating whether secure boot to be enabled." }, "isTargetVmTpmEnabled": { "type": "string", "description": "A value indicating whether trusted platform module to be enabled." }, "isTargetVmIntegrityMonitoringEnabled": { "type": "string", "description": "A value indicating whether integrity monitoring to be enabled." }, "isTargetVmConfidentialEncryptionEnabled": { "type": "string", "description": "A value indicating whether confidential compute encryption to be enabled." } } }, "VMwareCbtTestMigrateInput": { "type": "object", "description": "VMwareCbt specific test migrate input.", "properties": { "recoveryPointId": { "type": "string", "description": "The recovery point Id." }, "networkId": { "type": "string", "description": "The test network Id." }, "vmNics": { "type": "array", "description": "The list of NIC details.", "items": { "$ref": "#/definitions/VMwareCbtNicInput" }, "x-ms-identifiers": [] }, "osUpgradeVersion": { "type": "string", "description": "A value indicating the inplace OS Upgrade version." }, "postMigrationSteps": { "type": "array", "description": "The managed run command script input.", "items": { "$ref": "#/definitions/ManagedRunCommandScriptInput" }, "x-ms-identifiers": [ "stepName" ] } }, "required": [ "recoveryPointId", "networkId" ], "allOf": [ { "$ref": "#/definitions/TestMigrateProviderSpecificInput" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareCbtUpdateDiskInput": { "type": "object", "description": "VMwareCbt disk input for update.", "properties": { "diskId": { "type": "string", "description": "The disk Id." }, "targetDiskName": { "type": "string", "description": "The target disk name." }, "isOSDisk": { "type": "string", "description": "A value indicating whether the disk is the OS disk." }, "iops": { "type": "integer", "format": "int64", "description": "The number of IOPS allowed for Premium V2 and Ultra disks." }, "throughputInMbps": { "type": "integer", "format": "int64", "description": "The total throughput in Mbps for Premium V2 and Ultra disks." }, "diskSizeInGB": { "type": "integer", "format": "int64", "description": "The target disk size in GB." } }, "required": [ "diskId" ] }, "VMwareCbtUpdateMigrationItemInput": { "type": "object", "description": "VMwareCbt specific update migration item input.", "properties": { "targetVmName": { "type": "string", "description": "The target VM name." }, "targetVmSize": { "type": "string", "description": "The target VM size." }, "targetResourceGroupId": { "type": "string", "description": "The target resource group ARM Id." }, "targetAvailabilitySetId": { "type": "string", "description": "The target availability set ARM Id." }, "targetAvailabilityZone": { "type": "string", "description": "The target availability zone." }, "targetProximityPlacementGroupId": { "type": "string", "description": "The target proximity placement group ARM Id." }, "targetBootDiagnosticsStorageAccountId": { "type": "string", "description": "The target boot diagnostics storage account ARM Id." }, "targetNetworkId": { "type": "string", "description": "The target network ARM Id." }, "testNetworkId": { "type": "string", "description": "The test network ARM Id." }, "vmNics": { "type": "array", "description": "The list of NIC details.", "items": { "$ref": "#/definitions/VMwareCbtNicInput" } }, "vmDisks": { "type": "array", "description": "The list of disk update properties.", "items": { "$ref": "#/definitions/VMwareCbtUpdateDiskInput" } }, "licenseType": { "$ref": "#/definitions/LicenseType", "description": "The license type." }, "sqlServerLicenseType": { "$ref": "#/definitions/SqlServerLicenseType", "description": "The SQL Server license type." }, "linuxLicenseType": { "$ref": "#/definitions/LinuxLicenseType", "description": "The license type for Linux VM's." }, "userSelectedOSName": { "type": "string", "description": "The OS name selected by user." }, "performAutoResync": { "type": "string", "description": "A value indicating whether auto resync is to be done." }, "targetVmTags": { "type": "object", "description": "The target VM tags.", "additionalProperties": { "type": "string" } }, "targetDiskTags": { "type": "object", "description": "The tags for the target disks.", "additionalProperties": { "type": "string" } }, "targetNicTags": { "type": "object", "description": "The tags for the target NICs.", "additionalProperties": { "type": "string" } }, "targetCapacityReservationGroupId": { "type": "string", "description": "The target capacity reservation group ARM Id." } }, "allOf": [ { "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput" } ], "x-ms-discriminator-value": "VMwareCbt" }, "VMwareDetails": { "type": "object", "description": "Store the fabric details specific to the VMware fabric.", "properties": { "processServers": { "type": "array", "description": "The list of Process Servers associated with the fabric.", "items": { "$ref": "#/definitions/ProcessServer" } }, "masterTargetServers": { "type": "array", "description": "The list of Master Target servers associated with the fabric.", "items": { "$ref": "#/definitions/MasterTargetServer" } }, "runAsAccounts": { "type": "array", "description": "The list of run as accounts created on the server.", "items": { "$ref": "#/definitions/RunAsAccount" } }, "replicationPairCount": { "type": "string", "description": "The number of replication pairs configured in this CS." }, "processServerCount": { "type": "string", "description": "The number of process servers." }, "agentCount": { "type": "string", "description": "The number of source and target servers configured to talk to this CS." }, "protectedServers": { "type": "string", "description": "The number of protected servers." }, "systemLoad": { "type": "string", "description": "The percentage of the system load." }, "systemLoadStatus": { "type": "string", "description": "The system load status." }, "cpuLoad": { "type": "string", "description": "The percentage of the CPU load." }, "cpuLoadStatus": { "type": "string", "description": "The CPU load status." }, "totalMemoryInBytes": { "type": "integer", "format": "int64", "description": "The total memory." }, "availableMemoryInBytes": { "type": "integer", "format": "int64", "description": "The available memory." }, "memoryUsageStatus": { "type": "string", "description": "The memory usage status." }, "totalSpaceInBytes": { "type": "integer", "format": "int64", "description": "The total space." }, "availableSpaceInBytes": { "type": "integer", "format": "int64", "description": "The available space." }, "spaceUsageStatus": { "type": "string", "description": "The space usage status." }, "webLoad": { "type": "string", "description": "The web load." }, "webLoadStatus": { "type": "string", "description": "The web load status." }, "databaseServerLoad": { "type": "string", "description": "The database server load." }, "databaseServerLoadStatus": { "type": "string", "description": "The database server load status." }, "csServiceStatus": { "type": "string", "description": "The CS service status." }, "ipAddress": { "type": "string", "description": "The IP address." }, "agentVersion": { "type": "string", "description": "The agent Version." }, "hostName": { "type": "string", "description": "The host name." }, "lastHeartbeat": { "type": "string", "format": "date-time", "description": "The last heartbeat received from CS server." }, "versionStatus": { "type": "string", "description": "Version status." }, "sslCertExpiryDate": { "type": "string", "format": "date-time", "description": "CS SSL cert expiry date." }, "sslCertExpiryRemainingDays": { "type": "integer", "format": "int32", "description": "CS SSL cert expiry date." }, "psTemplateVersion": { "type": "string", "description": "PS template version." }, "agentExpiryDate": { "type": "string", "format": "date-time", "description": "Agent expiry date." }, "agentVersionDetails": { "$ref": "#/definitions/VersionDetails", "description": "The agent version details." }, "switchProviderBlockingErrorDetails": { "type": "array", "description": "The switch provider blocking error information.", "items": { "$ref": "#/definitions/InMageFabricSwitchProviderBlockingErrorDetails" } } }, "allOf": [ { "$ref": "#/definitions/FabricSpecificDetails" } ], "x-ms-discriminator-value": "VMware" }, "VMwareV2FabricCreationInput": { "type": "object", "description": "VMwareV2 fabric provider specific settings.", "properties": { "vmwareSiteId": { "type": "string", "description": "The ARM Id of the VMware site." }, "physicalSiteId": { "type": "string", "description": "The ARM Id of the physical site." }, "migrationSolutionId": { "type": "string", "description": "The ARM Id of the migration solution." } }, "required": [ "migrationSolutionId" ], "allOf": [ { "$ref": "#/definitions/FabricSpecificCreationInput" } ], "x-ms-discriminator-value": "VMwareV2" }, "VMwareV2FabricSpecificDetails": { "type": "object", "description": "VMwareV2 fabric specific details.", "properties": { "vmwareSiteId": { "type": "string", "description": "The ARM Id of the VMware site.", "readOnly": true }, "physicalSiteId": { "type": "string", "description": "The ARM Id of the physical site.", "readOnly": true }, "migrationSolutionId": { "type": "string", "description": "The Migration solution ARM Id.", "readOnly": true }, "serviceEndpoint": { "type": "string", "description": "The service endpoint.", "readOnly": true }, "serviceResourceId": { "type": "string", "description": "The service resource Id.", "readOnly": true }, "serviceContainerId": { "type": "string", "description": "The service container Id.", "readOnly": true }, "processServers": { "type": "array", "description": "The list of process servers.", "items": { "$ref": "#/definitions/ProcessServerDetails" }, "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/FabricSpecificDetails" } ], "x-ms-discriminator-value": "VMwareV2" }, "VMwareVirtualMachineDetails": { "type": "object", "description": "VMware provider specific settings.", "properties": { "agentGeneratedId": { "type": "string", "description": "The ID generated by the InMage agent after it gets installed on guest. This is the ID to be used during InMage CreateProtection." }, "agentInstalled": { "type": "string", "description": "The value indicating if InMage scout agent is installed on guest." }, "osType": { "type": "string", "description": "The OsType installed on VM." }, "agentVersion": { "type": "string", "description": "The agent version." }, "ipAddress": { "type": "string", "description": "The IP address." }, "poweredOn": { "type": "string", "description": "The value indicating whether VM is powered on." }, "vCenterInfrastructureId": { "type": "string", "description": "The VCenter infrastructure Id." }, "discoveryType": { "type": "string", "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical." }, "diskDetails": { "type": "array", "description": "The disk details.", "items": { "$ref": "#/definitions/InMageDiskDetails" } }, "validationErrors": { "type": "array", "description": "The validation errors.", "items": { "$ref": "#/definitions/HealthError" } } }, "allOf": [ { "$ref": "#/definitions/ConfigurationSettings" } ], "x-ms-discriminator-value": "VMwareVirtualMachine" }, "VaultHealthDetails": { "type": "object", "description": "Vault health details definition.", "properties": { "properties": { "$ref": "#/definitions/VaultHealthProperties", "description": "The vault health related data." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ] }, "VaultHealthProperties": { "type": "object", "description": "class to define the health summary of the Vault.", "properties": { "vaultErrors": { "type": "array", "description": "The list of errors on the vault.", "items": { "$ref": "#/definitions/HealthError" } }, "protectedItemsHealth": { "$ref": "#/definitions/ResourceHealthSummary", "description": "The list of the health detail of the protected items in the vault." }, "fabricsHealth": { "$ref": "#/definitions/ResourceHealthSummary", "description": "The list of the health detail of the fabrics in the vault." }, "containersHealth": { "$ref": "#/definitions/ResourceHealthSummary", "description": "The list of the health detail of the containers in the vault." } } }, "VaultSetting": { "type": "object", "description": "Vault setting.", "properties": { "properties": { "$ref": "#/definitions/VaultSettingProperties", "description": "The vault setting properties." }, "location": { "type": "string", "description": "Resource Location" } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "VaultSettingCollection": { "type": "object", "description": "Vault setting collection.", "properties": { "value": { "type": "array", "description": "The VaultSetting items on this page", "items": { "$ref": "#/definitions/VaultSetting" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "VaultSettingCreationInput": { "type": "object", "description": "Input to create vault setting.", "properties": { "properties": { "$ref": "#/definitions/VaultSettingCreationInputProperties", "description": "Vault setting creation input properties." } }, "required": [ "properties" ] }, "VaultSettingCreationInputProperties": { "type": "object", "description": "Input to create vault setting.", "properties": { "migrationSolutionId": { "type": "string", "description": "The migration solution Id." }, "vmwareToAzureProviderType": { "type": "string", "description": "VMware to Azure provider type." }, "recoveryNetworkConfigAutoSync": { "$ref": "#/definitions/RecoveryNetworkConfigAutoSyncPolicy", "description": "The vault level policy controlling whether the A2A recovery network configuration is automatically kept in sync with the source virtual machine. If the property is omitted from the request body, the policy is set to `Disabled`." } } }, "VaultSettingProperties": { "type": "object", "description": "Vault setting properties.", "properties": { "migrationSolutionId": { "type": "string", "description": "The migration solution ARM Id." }, "vmwareToAzureProviderType": { "type": "string", "description": "VMware to Azure provider type." }, "recoveryNetworkConfigAutoSync": { "$ref": "#/definitions/RecoveryNetworkConfigAutoSyncPolicy", "description": "The vault level policy controlling whether the A2A recovery network configuration is automatically kept in sync with the source virtual machine." } } }, "VersionDetails": { "type": "object", "description": "Version related details.", "properties": { "version": { "type": "string", "description": "The agent version." }, "expiryDate": { "type": "string", "format": "date-time", "description": "Version expiry date." }, "status": { "$ref": "#/definitions/AgentVersionStatus", "description": "A value indicating whether security update required." } } }, "VirtualMachineTaskDetails": { "type": "object", "description": "This class represents the virtual machine task details.", "properties": { "skippedReason": { "type": "string", "description": "The skipped reason." }, "skippedReasonString": { "type": "string", "description": "The skipped reason string." } }, "allOf": [ { "$ref": "#/definitions/JobTaskDetails" } ], "x-ms-discriminator-value": "VirtualMachineTaskDetails" }, "VmEncryptionType": { "type": "string", "description": "The encryption type of the VM.", "enum": [ "NotEncrypted", "OnePassEncrypted", "TwoPassEncrypted" ], "x-ms-enum": { "name": "VmEncryptionType", "modelAsString": true, "values": [ { "name": "NotEncrypted", "value": "NotEncrypted", "description": "NotEncrypted" }, { "name": "OnePassEncrypted", "value": "OnePassEncrypted", "description": "OnePassEncrypted" }, { "name": "TwoPassEncrypted", "value": "TwoPassEncrypted", "description": "TwoPassEncrypted" } ] } }, "VmNicUpdatesTaskDetails": { "type": "object", "description": "This class represents the vm NicUpdates task details.", "properties": { "vmId": { "type": "string", "description": "Virtual machine Id." }, "nicId": { "type": "string", "description": "Nic Id." }, "name": { "type": "string", "description": "Name of the Nic." } }, "allOf": [ { "$ref": "#/definitions/TaskTypeDetails" } ], "x-ms-discriminator-value": "VmNicUpdatesTaskDetails" }, "VmReplicationProgressHealth": { "type": "string", "description": "The initial replication progress health.", "enum": [ "None", "InProgress", "SlowProgress", "NoProgress" ], "x-ms-enum": { "name": "VmReplicationProgressHealth", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "InProgress", "value": "InProgress", "description": "InProgress" }, { "name": "SlowProgress", "value": "SlowProgress", "description": "SlowProgress" }, { "name": "NoProgress", "value": "NoProgress", "description": "NoProgress" } ] } }, "VmmDetails": { "type": "object", "description": "VMM fabric specific details.", "allOf": [ { "$ref": "#/definitions/FabricSpecificDetails" } ], "x-ms-discriminator-value": "VMM" }, "VmmToAzureCreateNetworkMappingInput": { "type": "object", "description": "Create network mappings input properties/behavior specific to Vmm to Azure Network mapping.", "allOf": [ { "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" } ], "x-ms-discriminator-value": "VmmToAzure" }, "VmmToAzureNetworkMappingSettings": { "type": "object", "description": "E2A Network Mapping fabric specific settings.", "allOf": [ { "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" } ], "x-ms-discriminator-value": "VmmToAzure" }, "VmmToAzureUpdateNetworkMappingInput": { "type": "object", "description": "Update network mappings input properties/behavior specific to vmm to azure.", "allOf": [ { "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" } ], "x-ms-discriminator-value": "VmmToAzure" }, "VmmToVmmCreateNetworkMappingInput": { "type": "object", "description": "Create network mappings input properties/behavior specific to vmm to vmm Network mapping.", "allOf": [ { "$ref": "#/definitions/FabricSpecificCreateNetworkMappingInput" } ], "x-ms-discriminator-value": "VmmToVmm" }, "VmmToVmmNetworkMappingSettings": { "type": "object", "description": "E2E Network Mapping fabric specific settings.", "allOf": [ { "$ref": "#/definitions/NetworkMappingFabricSpecificSettings" } ], "x-ms-discriminator-value": "VmmToVmm" }, "VmmToVmmUpdateNetworkMappingInput": { "type": "object", "description": "Update network mappings input properties/behavior specific to vmm to vmm.", "allOf": [ { "$ref": "#/definitions/FabricSpecificUpdateNetworkMappingInput" } ], "x-ms-discriminator-value": "VmmToVmm" }, "VmmVirtualMachineDetails": { "type": "object", "description": "VMM fabric provider specific VM settings.", "allOf": [ { "$ref": "#/definitions/HyperVVirtualMachineDetails" } ], "x-ms-discriminator-value": "VmmVirtualMachine" }, "VmwareCbtPolicyDetails": { "type": "object", "description": "VMware Cbt specific policy details.", "properties": { "recoveryPointHistoryInMinutes": { "type": "integer", "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored." }, "appConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The app consistent snapshot frequency in minutes." }, "crashConsistentFrequencyInMinutes": { "type": "integer", "format": "int32", "description": "The crash consistent snapshot frequency in minutes." } }, "allOf": [ { "$ref": "#/definitions/PolicyProviderSpecificDetails" } ], "x-ms-discriminator-value": "VMwareCbt" } }, "parameters": { "ReplicationEligibilityResultsParentParam.virtualMachineName": { "name": "virtualMachineName", "in": "path", "description": "Virtual Machine name.", "required": true, "type": "string", "x-ms-parameter-location": "method" } } }