swagger: '2.0' info: version: '2023-06-01' title: Microsoft Azure SiteRecoveryManagementClient x-ms-code-generation-settings: header: MICROSOFT_MIT_NO_VERSION host: management.azure.com schemes: - https consumes: - application/json produces: - application/json paths: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/operations: get: tags: - Operations summary: 'Microsoft Azure Returns The List Of Available Operations' description: Operation to return the list of available operations. operationId: microsoftAzureOperationsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/OperationsDiscoveryCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Returns the list of available operations.: $ref: ./examples/Operations_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings : get: tags: - ReplicationAlertSettings summary: 'Microsoft Azure Gets The List Of Configured Email Notification Alert Configurations' description: Gets the list of email notification(alert) configurations for the vault. operationId: microsoftAzureReplicationalertsettingsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/AlertCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of configured email notification(alert) configurations.: $ref: ./examples/ReplicationAlertSettings_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationAlertSettings/{alertSettingName} : get: tags: - ReplicationAlertSettings summary: 'Microsoft Azure Gets An Email Notification Alert Configuration' description: >- Gets the details of the specified email notification(alert) configuration. operationId: microsoftAzureReplicationalertsettingsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: alertSettingName in: path description: The name of the email notification configuration. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/Alert' x-ms-examples: Gets an email notification(alert) configuration.: $ref: ./examples/ReplicationAlertSettings_Get.json put: tags: - ReplicationAlertSettings summary: 'Microsoft Azure Configures Email Notifications For This Vault' description: Create or update an email notification(alert) configuration. operationId: microsoftAzureReplicationalertsettingsCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: alertSettingName in: path description: The name of the email notification(alert) 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: OK 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: tags: - ReplicationAppliances summary: 'Microsoft Azure Gets The List Of Appliances' description: Gets the list of Azure Site Recovery appliances for the vault. operationId: microsoftAzureReplicationappliancesList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: $filter in: query description: OData filter options. required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/ApplianceCollection' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/ApplianceQueryParameter' x-ms-examples: Gets the list of appliances.: $ref: ./examples/ReplicationAppliances_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.RecoveryServices/replicationEligibilityResults : get: tags: - ReplicationEligibilityResults summary: 'Microsoft Azure 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. operationId: microsoftAzureReplicationeligibilityresultsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: virtualMachineName in: path description: Virtual Machine name. required: true type: string responses: '200': description: OK 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: tags: - ReplicationEligibilityResults summary: 'Microsoft Azure 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. operationId: microsoftAzureReplicationeligibilityresultsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: virtualMachineName in: path description: Virtual Machine name. required: true type: string responses: '200': description: OK 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/vaults/{resourceName}/replicationEvents : get: tags: - ReplicationEvents summary: 'Microsoft Azure Gets The List Of Azure Site Recovery Events' description: Gets the list of Azure Site Recovery events for the vault. operationId: microsoftAzureReplicationeventsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: $filter in: query description: OData filter options. required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/EventCollection' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/EventQueryParameter' x-ms-examples: Gets the list of Azure Site Recovery events.: $ref: ./examples/ReplicationEvents_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents/{eventName} : get: tags: - ReplicationEvents summary: 'Microsoft Azure Get The Details Of An Azure Site Recovery Event' description: The operation to get the details of an Azure Site recovery event. operationId: microsoftAzureReplicationeventsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: eventName in: path description: The name of the Azure Site Recovery event. required: true type: string responses: '200': description: OK 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: tags: - ReplicationFabrics summary: 'Microsoft Azure Gets The List Of Asr Fabrics' description: Gets a list of the Azure Site Recovery fabrics in the vault. operationId: microsoftAzureReplicationfabricsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/FabricCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of ASR fabrics.: $ref: ./examples/ReplicationFabrics_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName} : get: tags: - ReplicationFabrics summary: 'Microsoft Azure Gets The Details Of An Asr Fabric' description: Gets the details of an Azure Site Recovery fabric. operationId: microsoftAzureReplicationfabricsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/Fabric' x-ms-odata: '#/definitions/FabricQueryParameter' x-ms-examples: Gets the details of an ASR fabric.: $ref: ./examples/ReplicationFabrics_Get.json put: tags: - ReplicationFabrics summary: 'Microsoft Azure Creates An Azure Site Recovery Fabric' description: >- The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site). operationId: microsoftAzureReplicationfabricsCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Name of the ASR fabric. required: true type: string - name: input in: body description: Fabric creation input. required: true schema: $ref: '#/definitions/FabricCreationInput' responses: '200': description: OK schema: $ref: '#/definitions/Fabric' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Creates an Azure Site Recovery fabric.: $ref: ./examples/ReplicationFabrics_Create.json delete: tags: - ReplicationFabrics summary: 'Microsoft Azure Purges The Site' description: The operation to purge(force delete) an Azure Site Recovery fabric. operationId: microsoftAzureReplicationfabricsPurge parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: ASR fabric to purge. required: true type: string responses: '202': description: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Purges the site.: $ref: ./examples/ReplicationFabrics_Purge.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/checkConsistency : post: tags: - ReplicationFabrics summary: 'Microsoft Azure Checks The Consistency Of The Asr Fabric' description: The operation to perform a consistency check on the fabric. operationId: microsoftAzureReplicationfabricsCheckconsistency produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Fabric name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/Fabric' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Checks the consistency of the ASR fabric.: $ref: ./examples/ReplicationFabrics_CheckConsistency.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/migratetoaad : post: tags: - ReplicationFabrics summary: 'Microsoft Azure Migrates The Site To Aad' description: The operation to migrate an Azure Site Recovery fabric to AAD. operationId: microsoftAzureReplicationfabricsMigratetoaad parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: ASR fabric to migrate. required: true type: string responses: '202': description: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Migrates the site to AAD.: $ref: ./examples/ReplicationFabrics_MigrateToAad.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/reassociateGateway : post: tags: - ReplicationFabrics summary: 'Microsoft Azure Perform Failover Of The Process Server' description: >- The operation to move replications from a process server to another process server. operationId: microsoftAzureReplicationfabricsReassociategateway consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: The name of the fabric containing the process server. 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: OK schema: $ref: '#/definitions/Fabric' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Perform failover of the process server.: $ref: ./examples/ReplicationFabrics_ReassociateGateway.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/remove : post: tags: - ReplicationFabrics summary: 'Microsoft Azure Deletes The Site' description: The operation to delete or remove an Azure Site Recovery fabric. operationId: microsoftAzureReplicationfabricsDelete parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: ASR fabric to delete. required: true type: string responses: '202': description: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Deletes the site.: $ref: ./examples/ReplicationFabrics_Delete.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/renewCertificate : post: tags: - ReplicationFabrics summary: 'Microsoft Azure Renews Certificate For The Fabric' description: Renews the connection certificate for the ASR replication fabric. operationId: microsoftAzureReplicationfabricsRenewcertificate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: fabric name to renew certs for. required: true type: string - name: renewCertificate in: body description: Renew certificate input. required: true schema: $ref: '#/definitions/RenewCertificateInput' responses: '200': description: OK schema: $ref: '#/definitions/Fabric' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Renews certificate for the fabric.: $ref: ./examples/ReplicationFabrics_RenewCertificate.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks : get: tags: - ReplicationLogicalNetworks summary: 'Microsoft Azure Gets The List Of Logical Networks Under A Fabric' description: Lists all the logical networks of the Azure Site Recovery fabric. operationId: microsoftAzureReplicationlogicalnetworksListbyreplicationfabrics produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Server Id. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/LogicalNetworkCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of logical networks under a fabric.: $ref: ./examples/ReplicationLogicalNetworks_ListByReplicationFabrics.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationLogicalNetworks/{logicalNetworkName} : get: tags: - ReplicationLogicalNetworks summary: >- Microsoft Azure Gets A Logical Network With Specified Server Id And Logical Network Name description: Gets the details of a logical network. operationId: microsoftAzureReplicationlogicalnetworksGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Server Id. required: true type: string - name: logicalNetworkName in: path description: Logical network name. required: true type: string responses: '200': description: OK 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: tags: - ReplicationNetworks summary: 'Microsoft Azure Gets The List Of Networks Under A Fabric' description: Lists the networks available for a fabric. operationId: microsoftAzureReplicationnetworksListbyreplicationfabrics produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Fabric name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/NetworkCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of networks under a fabric.: $ref: ./examples/ReplicationNetworks_ListByReplicationFabrics.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName} : get: tags: - ReplicationNetworks summary: 'Microsoft Azure Gets A Network With Specified Server Id And Network Name' description: Gets the details of a network. operationId: microsoftAzureReplicationnetworksGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Server Id. required: true type: string - name: networkName in: path description: Primary network name. required: true type: string responses: '200': description: OK 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: tags: - ReplicationNetworkMappings summary: 'Microsoft Azure Gets All The Network Mappings Under A Network' description: Lists all ASR network mappings for the specified network. operationId: microsoftAzureReplicationnetworkmappingsListbyreplicationnetworks produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Primary fabric name. required: true type: string - name: networkName in: path description: Primary network name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/NetworkMappingCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets all the network mappings under a network.: $ref: ./examples/ReplicationNetworkMappings_ListByReplicationNetworks.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationNetworks/{networkName}/replicationNetworkMappings/{networkMappingName} : get: tags: - ReplicationNetworkMappings summary: 'Microsoft Azure Gets Network Mapping By Name' description: Gets the details of an ASR network mapping. operationId: microsoftAzureReplicationnetworkmappingsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Primary 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: OK schema: $ref: '#/definitions/NetworkMapping' x-ms-examples: Gets network mapping by name.: $ref: ./examples/ReplicationNetworkMappings_Get.json put: tags: - ReplicationNetworkMappings summary: 'Microsoft Azure Creates Network Mapping' description: The operation to create an ASR network mapping. operationId: microsoftAzureReplicationnetworkmappingsCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Primary 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: OK schema: $ref: '#/definitions/NetworkMapping' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Creates network mapping.: $ref: ./examples/ReplicationNetworkMappings_Create.json delete: tags: - ReplicationNetworkMappings summary: 'Microsoft Azure Delete Network Mapping' description: The operation to delete a network mapping. operationId: microsoftAzureReplicationnetworkmappingsDelete parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Primary fabric name. required: true type: string - name: networkName in: path description: Primary network name. required: true type: string - name: networkMappingName in: path description: ARM Resource Name for network mapping. required: true type: string responses: '202': description: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Delete network mapping.: $ref: ./examples/ReplicationNetworkMappings_Delete.json patch: tags: - ReplicationNetworkMappings summary: 'Microsoft Azure Updates Network Mapping' description: The operation to update an ASR network mapping. operationId: microsoftAzureReplicationnetworkmappingsUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Primary 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: OK schema: $ref: '#/definitions/NetworkMapping' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Updates network mapping.: $ref: ./examples/ReplicationNetworkMappings_Update.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers : get: tags: - ReplicationProtectionContainers summary: 'Microsoft Azure Gets The List Of Protection Container For A Fabric' description: Lists the protection containers in the specified fabric. operationId: microsoftAzureReplicationprotectioncontainersListbyreplicationfabrics produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Fabric name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/ProtectionContainerCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of protection container for a fabric.: $ref: >- ./examples/ReplicationProtectionContainers_ListByReplicationFabrics.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName} : get: tags: - ReplicationProtectionContainers summary: 'Microsoft Azure Gets The Protection Container Details' description: Gets the details of a protection container. operationId: microsoftAzureReplicationprotectioncontainersGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ProtectionContainer' x-ms-examples: Gets the protection container details.: $ref: ./examples/ReplicationProtectionContainers_Get.json put: tags: - ReplicationProtectionContainers summary: 'Microsoft Azure Create A Protection Container' description: Operation to create a protection container. operationId: microsoftAzureReplicationprotectioncontainersCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique fabric ARM name. required: true type: string - name: protectionContainerName in: path description: Unique protection container ARM name. required: true type: string - name: creationInput in: body description: Creation input. required: true schema: $ref: '#/definitions/CreateProtectionContainerInput' responses: '200': description: OK schema: $ref: '#/definitions/ProtectionContainer' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Create a protection container.: $ref: ./examples/ReplicationProtectionContainers_Create.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/discoverProtectableItem : post: tags: - ReplicationProtectionContainers summary: 'Microsoft Azure 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). operationId: microsoftAzureReplicationprotectioncontainersDiscoverprotectableitem consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: The name of the fabric. required: true type: string - name: protectionContainerName in: path description: The name of the protection container. 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: OK schema: $ref: '#/definitions/ProtectionContainer' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Adds a protectable item to the replication protection container.: $ref: >- ./examples/ReplicationProtectionContainers_DiscoverProtectableItem.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/remove : post: tags: - ReplicationProtectionContainers summary: 'Microsoft Azure Removes A Protection Container' description: Operation to remove a protection container. operationId: microsoftAzureReplicationprotectioncontainersDelete parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique fabric ARM name. required: true type: string - name: protectionContainerName in: path description: Unique protection container ARM name. required: true type: string responses: '202': description: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Removes a protection container.: $ref: ./examples/ReplicationProtectionContainers_Delete.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems : get: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Gets The List Of Migration Items In The Protection Container' description: Gets the list of ASR migration items in the protection container. operationId: >- microsoftAzureReplicationmigrationitemsListbyreplicationprotectioncontainers produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/MigrationItemCollection' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/MigrationItemsQueryParameter' x-ms-examples: Gets the list of migration items in the protection container.: $ref: >- ./examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName} : get: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Gets The Details Of A Migration Item' operationId: microsoftAzureReplicationmigrationitemsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Fabric unique 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: OK schema: $ref: '#/definitions/MigrationItem' x-ms-examples: Gets the details of a migration item.: $ref: ./examples/ReplicationMigrationItems_Get.json description: Needs a more full description created. put: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Enables Migration' description: The operation to create an ASR migration item (enable migration). operationId: microsoftAzureReplicationmigrationitemsCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/MigrationItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Enables migration.: $ref: ./examples/ReplicationMigrationItems_Create.json delete: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Delete The Migration Item' description: The operation to delete an ASR migration item. operationId: microsoftAzureReplicationmigrationitemsDelete parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Delete the migration item.: $ref: ./examples/ReplicationMigrationItems_Delete.json patch: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Updates Migration Item' description: The operation to update the recovery settings of an ASR migration item. operationId: microsoftAzureReplicationmigrationitemsUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/MigrationItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Updates migration item.: $ref: ./examples/ReplicationMigrationItems_Update.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrate : post: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Migrate Item' description: The operation to initiate migration of the item. operationId: microsoftAzureReplicationmigrationitemsMigrate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/MigrationItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Migrate item.: $ref: ./examples/ReplicationMigrationItems_Migrate.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints : get: tags: - MigrationRecoveryPoints summary: 'Microsoft Azure Gets The Recovery Points For A Migration Item' operationId: microsoftAzureMigrationrecoverypointsListbyreplicationmigrationitems produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Fabric unique 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: OK schema: $ref: '#/definitions/MigrationRecoveryPointCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the recovery points for a migration item.: $ref: >- ./examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints/{migrationRecoveryPointName} : get: tags: - MigrationRecoveryPoints summary: 'Microsoft Azure Gets A Recovery Point For A Migration Item' operationId: microsoftAzureMigrationrecoverypointsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Fabric unique 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: OK schema: $ref: '#/definitions/MigrationRecoveryPoint' x-ms-examples: Gets a recovery point for a migration item.: $ref: ./examples/MigrationRecoveryPoints_Get.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/pauseReplication : post: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Pause Replication' description: The operation to initiate pause replication of the item. operationId: microsoftAzureReplicationmigrationitemsPausereplication consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/MigrationItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Pause replication.: $ref: ./examples/ReplicationMigrationItems_PauseReplication.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resumeReplication : post: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Resume Replication' description: The operation to initiate resume replication of the item. operationId: microsoftAzureReplicationmigrationitemsResumereplication consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/MigrationItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Resume replication.: $ref: ./examples/ReplicationMigrationItems_ResumeReplication.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/resync : post: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Resynchronizes Replication' description: The operation to resynchronize replication of an ASR migration item. operationId: microsoftAzureReplicationmigrationitemsResync consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/MigrationItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Resynchronizes replication.: $ref: ./examples/ReplicationMigrationItems_Resync.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrate : post: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Test Migrate Item' description: The operation to initiate test migration of the item. operationId: microsoftAzureReplicationmigrationitemsTestmigrate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/MigrationItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Test migrate item.: $ref: ./examples/ReplicationMigrationItems_TestMigrate.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrateCleanup : post: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Test Migrate Cleanup' description: The operation to initiate test migrate cleanup. operationId: microsoftAzureReplicationmigrationitemsTestmigratecleanup consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/MigrationItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Test migrate cleanup.: $ref: ./examples/ReplicationMigrationItems_TestMigrateCleanup.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems : get: tags: - ReplicationProtectableItems summary: 'Microsoft Azure Gets The List Of Protectable Items' description: Lists the protectable items in a protection container. operationId: >- microsoftAzureReplicationprotectableitemsListbyreplicationprotectioncontainers produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ProtectableItemCollection' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/ProtectableItemQueryParameter' x-ms-examples: Gets the list of protectable items.: $ref: >- ./examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems/{protectableItemName} : get: tags: - ReplicationProtectableItems summary: 'Microsoft Azure Gets The Details Of A Protectable Item' description: The operation to get the details of a protectable item. operationId: microsoftAzureReplicationprotectableitemsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK 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: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Gets The List Of Replication Protected Items' description: >- Gets the list of ASR replication protected items in the protection container. operationId: >- microsoftAzureReplicationprotecteditemsListbyreplicationprotectioncontainers produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ReplicationProtectedItemCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of Replication protected items.: $ref: >- ./examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName} : get: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Gets The Details Of A Replication Protected Item' description: Gets the details of an ASR replication protected item. operationId: microsoftAzureReplicationprotecteditemsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Fabric unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' x-ms-examples: Gets the details of a Replication protected item.: $ref: ./examples/ReplicationProtectedItems_Get.json put: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Enables Protection' description: >- The operation to create an ASR replication protected item (Enable replication). operationId: microsoftAzureReplicationprotecteditemsCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Name of the fabric. required: true type: string - name: protectionContainerName in: path description: Protection container name. required: true type: string - name: replicatedProtectedItemName in: path description: A name for the replication protected item. required: true type: string - name: input in: body description: Enable Protection Input. required: true schema: $ref: '#/definitions/EnableProtectionInput' responses: '200': description: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Enables protection.: $ref: ./examples/ReplicationProtectedItems_Create.json delete: tags: - ReplicationProtectedItems summary: 'Microsoft Azure 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. operationId: microsoftAzureReplicationprotecteditemsPurge parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Purges protection.: $ref: ./examples/ReplicationProtectedItems_Purge.json patch: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Updates The Replication Protected Item Settings' description: >- The operation to update the recovery settings of an ASR replication protected item. operationId: microsoftAzureReplicationprotecteditemsUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Updates the replication protected Item settings.: $ref: ./examples/ReplicationProtectedItems_Update.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Add Disk S For Protection' description: Operation to add disks(s) to the replication protected item. operationId: microsoftAzureReplicationprotecteditemsAdddisks consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Add disk(s) for protection.: $ref: ./examples/ReplicationProtectedItems_AddDisks.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Change Or Apply Recovery Point' description: >- The operation to change the recovery point of a failed over replication protected item. operationId: microsoftAzureReplicationprotecteditemsApplyrecoverypoint consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: The ARM fabric name. required: true type: string - name: protectionContainerName in: path description: The protection container name. required: true type: string - name: replicatedProtectedItemName in: path description: The replicated protected item name. required: true type: string - name: applyRecoveryPointInput in: body description: The ApplyRecoveryPointInput. required: true schema: $ref: '#/definitions/ApplyRecoveryPointInput' responses: '200': description: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Change or apply recovery point.: $ref: ./examples/ReplicationProtectedItems_ApplyRecoveryPoint.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Execute Cancel Failover' description: Operation to cancel the failover of the replication protected item. operationId: microsoftAzureReplicationprotecteditemsFailovercancel produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute cancel failover.: $ref: ./examples/ReplicationProtectedItems_FailoverCancel.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Execute Commit Failover' description: Operation to commit the failover of the replication protected item. operationId: microsoftAzureReplicationprotecteditemsFailovercommit produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute commit failover.: $ref: ./examples/ReplicationProtectedItems_FailoverCommit.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Execute Planned Failover' description: >- Operation to initiate a planned failover of the replication protected item. operationId: microsoftAzureReplicationprotecteditemsPlannedfailover consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute planned failover.: $ref: ./examples/ReplicationProtectedItems_PlannedFailover.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints : get: tags: - RecoveryPoints summary: 'Microsoft Azure Gets The List Of Recovery Points For A Replication Protected Item' description: Lists the available recovery points for a replication protected item. operationId: microsoftAzureRecoverypointsListbyreplicationprotecteditems produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: The fabric name. required: true type: string - name: protectionContainerName in: path description: The protection container name. required: true type: string - name: replicatedProtectedItemName in: path description: The replication protected item name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPointCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of recovery points for a replication protected item.: $ref: ./examples/RecoveryPoints_ListByReplicationProtectedItems.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName} : get: tags: - RecoveryPoints summary: 'Microsoft Azure Gets A Recovery Point' description: Get the details of specified recovery point. operationId: microsoftAzureRecoverypointsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: The fabric name. required: true type: string - name: protectionContainerName in: path description: The protection container name. required: true type: string - name: replicatedProtectedItemName in: path description: The replication protected item name. required: true type: string - name: recoveryPointName in: path description: The recovery point name. required: true type: string responses: '200': description: OK 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}/remove : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Disables Protection' description: >- The operation to disable replication on a replication protected item. This will also remove the item. operationId: microsoftAzureReplicationprotecteditemsDelete consumes: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Disables protection.: $ref: ./examples/ReplicationProtectedItems_Delete.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Removes Disk S' description: Operation to remove disk(s) from the replication protected item. operationId: microsoftAzureReplicationprotecteditemsRemovedisks consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Removes disk(s).: $ref: ./examples/ReplicationProtectedItems_RemoveDisks.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Resynchronize Or Repair Replication' description: >- The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization. operationId: microsoftAzureReplicationprotecteditemsRepairreplication produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: The name of the fabric. required: true type: string - name: protectionContainerName in: path description: The name of the container. required: true type: string - name: replicatedProtectedItemName in: path description: The name of the replication protected item. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Resynchronize or repair replication.: $ref: ./examples/ReplicationProtectedItems_RepairReplication.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Execute Reverse Replication\reprotect' description: >- Operation to reprotect or reverse replicate a failed over replication protected item. operationId: microsoftAzureReplicationprotecteditemsReprotect consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute Reverse Replication\Reprotect.: $ref: ./examples/ReplicationProtectedItems_Reprotect.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Resolve Health Errors' description: Operation to resolve health issues of the replication protected item. operationId: microsoftAzureReplicationprotecteditemsResolvehealtherrors consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Resolve health errors.: $ref: ./examples/ReplicationProtectedItems_ResolveHealthErrors.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/switchProvider : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Execute Switch Provider' description: >- Operation to initiate a switch provider of the replication protected item. operationId: microsoftAzureReplicationprotecteditemsSwitchprovider consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: Execute switch provider.: $ref: ./examples/ReplicationProtectedItems_SwitchProvider.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes : get: tags: - TargetComputeSizes summary: >- Microsoft Azure Gets The List Of Target Compute Sizes For The Replication Protected Item description: >- Lists the available target compute sizes for a replication protected item. operationId: microsoftAzureTargetcomputesizesListbyreplicationprotecteditems produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/TargetComputeSizeCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of target compute sizes for the replication protected item.: $ref: ./examples/TargetComputeSizes_ListByReplicationProtectedItems.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Execute Test Failover' description: Operation to perform a test failover of the replication protected item. operationId: microsoftAzureReplicationprotecteditemsTestfailover consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute test failover.: $ref: ./examples/ReplicationProtectedItems_TestFailover.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Execute Test Failover Cleanup' description: Operation to clean up the test failover of a replication protected item. operationId: microsoftAzureReplicationprotecteditemsTestfailovercleanup consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute test failover cleanup.: $ref: ./examples/ReplicationProtectedItems_TestFailoverCleanup.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Execute Unplanned Failover' description: Operation to initiate a failover of the replication protected item. operationId: microsoftAzureReplicationprotecteditemsUnplannedfailover consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute unplanned failover.: $ref: ./examples/ReplicationProtectedItems_UnplannedFailover.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateAppliance : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Updates Appliance For Replication Protected Item' description: The operation to update appliance of an ASR replication protected item. operationId: microsoftAzureReplicationprotecteditemsUpdateappliance consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Updates appliance for replication protected Item.: $ref: ./examples/ReplicationProtectedItems_UpdateAppliance.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateMobilityService : post: tags: - ReplicationProtectedItems summary: 'Microsoft Azure 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. operationId: microsoftAzureReplicationprotecteditemsUpdatemobilityservice consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: The name of the fabric containing the protected item. required: true type: string - name: protectionContainerName in: path description: The name of the container containing the protected item. required: true type: string - name: replicatedProtectedItemName in: path description: The name of the protected item on which the agent is to be updated. 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: OK schema: $ref: '#/definitions/ReplicationProtectedItem' '202': description: Accepted headers: Location: type: string x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: Update the mobility service on a protected item.: $ref: ./examples/ReplicationProtectedItems_UpdateMobilityService.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings : get: tags: - ReplicationProtectionContainerMappings summary: >- Microsoft Azure Gets The List Of Protection Container Mappings For A Protection Container description: Lists the protection container mappings for a protection container. operationId: >- microsoftAzureReplicationprotectioncontainermappingsListbyreplicationprotectioncontainers produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ProtectionContainerMappingCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of protection container mappings for a protection container.: $ref: >- ./examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName} : get: tags: - ReplicationProtectionContainerMappings summary: 'Microsoft Azure Gets A Protection Container Mapping' description: Gets the details of a protection container mapping. operationId: microsoftAzureReplicationprotectioncontainermappingsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ProtectionContainerMapping' x-ms-examples: Gets a protection container mapping.: $ref: ./examples/ReplicationProtectionContainerMappings_Get.json put: tags: - ReplicationProtectionContainerMappings summary: 'Microsoft Azure Create Protection Container Mapping' description: The operation to create a protection container mapping. operationId: microsoftAzureReplicationprotectioncontainermappingsCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ProtectionContainerMapping' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Create protection container mapping.: $ref: ./examples/ReplicationProtectionContainerMappings_Create.json delete: tags: - ReplicationProtectionContainerMappings summary: 'Microsoft Azure Purge Protection Container Mapping' description: The operation to purge(force delete) a protection container mapping. operationId: microsoftAzureReplicationprotectioncontainermappingsPurge parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Purge protection container mapping.: $ref: ./examples/ReplicationProtectionContainerMappings_Purge.json patch: tags: - ReplicationProtectionContainerMappings summary: 'Microsoft Azure Update Protection Container Mapping' description: The operation to update protection container mapping. operationId: microsoftAzureReplicationprotectioncontainermappingsUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ProtectionContainerMapping' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Update protection container mapping.: $ref: ./examples/ReplicationProtectionContainerMappings_Update.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove : post: tags: - ReplicationProtectionContainerMappings summary: 'Microsoft Azure Remove Protection Container Mapping' description: The operation to delete or remove a protection container mapping. operationId: microsoftAzureReplicationprotectioncontainermappingsDelete consumes: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Remove protection container mapping.: $ref: ./examples/ReplicationProtectionContainerMappings_Delete.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchprotection : post: tags: - ReplicationProtectionContainers summary: >- Microsoft Azure 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. operationId: microsoftAzureReplicationprotectioncontainersSwitchprotection consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Unique 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: OK schema: $ref: '#/definitions/ProtectionContainer' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Switches protection from one container to another or one replication provider to another.: $ref: ./examples/ReplicationProtectionContainers_SwitchProtection.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders : get: tags: - ReplicationRecoveryServicesProviders summary: 'Microsoft Azure Gets The List Of Registered Recovery Services Providers For The Fabric' description: >- Lists the registered recovery services providers for the specified fabric. operationId: >- microsoftAzureReplicationrecoveryservicesprovidersListbyreplicationfabrics produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Fabric name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/RecoveryServicesProviderCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of registered recovery services providers for the fabric.: $ref: >- ./examples/ReplicationRecoveryServicesProviders_ListByReplicationFabrics.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName} : get: tags: - ReplicationRecoveryServicesProviders summary: 'Microsoft Azure Gets The Details Of A Recovery Services Provider' description: Gets the details of registered recovery services provider. operationId: microsoftAzureReplicationrecoveryservicesprovidersGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/RecoveryServicesProvider' x-ms-examples: Gets the details of a recovery services provider.: $ref: ./examples/ReplicationRecoveryServicesProviders_Get.json put: tags: - ReplicationRecoveryServicesProviders summary: 'Microsoft Azure Adds A Recovery Services Provider' description: The operation to add a recovery services provider. operationId: microsoftAzureReplicationrecoveryservicesprovidersCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/RecoveryServicesProvider' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Adds a recovery services provider.: $ref: ./examples/ReplicationRecoveryServicesProviders_Create.json delete: tags: - ReplicationRecoveryServicesProviders summary: 'Microsoft Azure Purges Recovery Service Provider From Fabric' description: >- The operation to purge(force delete) a recovery services provider from the vault. operationId: microsoftAzureReplicationrecoveryservicesprovidersPurge parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Purges recovery service provider from fabric.: $ref: ./examples/ReplicationRecoveryServicesProviders_Purge.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/refreshProvider : post: tags: - ReplicationRecoveryServicesProviders summary: 'Microsoft Azure Refresh Details From The Recovery Services Provider' description: >- The operation to refresh the information from the recovery services provider. operationId: microsoftAzureReplicationrecoveryservicesprovidersRefreshprovider produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/RecoveryServicesProvider' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Refresh details from the recovery services provider.: $ref: ./examples/ReplicationRecoveryServicesProviders_RefreshProvider.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationRecoveryServicesProviders/{providerName}/remove : post: tags: - ReplicationRecoveryServicesProviders summary: >- Microsoft Azure 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. operationId: microsoftAzureReplicationrecoveryservicesprovidersDelete parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: Accepted '204': description: NoContent x-ms-long-running-operation: true 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 ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications : get: tags: - ReplicationStorageClassifications summary: 'Microsoft Azure Gets The List Of Storage Classification Objects Under A Fabric' description: Lists the storage classifications available in the specified fabric. operationId: microsoftAzureReplicationstorageclassificationsListbyreplicationfabrics produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Site name of interest. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/StorageClassificationCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of storage classification objects under a fabric.: $ref: >- ./examples/ReplicationStorageClassifications_ListByReplicationFabrics.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName} : get: tags: - ReplicationStorageClassifications summary: 'Microsoft Azure Gets The Details Of A Storage Classification' description: Gets the details of the specified storage classification. operationId: microsoftAzureReplicationstorageclassificationsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK 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: tags: - ReplicationStorageClassificationMappings summary: >- Microsoft Azure Gets The List Of Storage Classification Mappings Objects Under A Storage description: Lists the storage classification mappings for the fabric. operationId: >- microsoftAzureReplicationstorageclassificationmappingsListbyreplicationstorageclassifications produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/StorageClassificationMappingCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of storage classification mappings objects under a storage.: $ref: >- ./examples/ReplicationStorageClassificationMappings_ListByReplicationStorageClassifications.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationStorageClassifications/{storageClassificationName}/replicationStorageClassificationMappings/{storageClassificationMappingName} : get: tags: - ReplicationStorageClassificationMappings summary: 'Microsoft Azure Gets The Details Of A Storage Classification Mapping' description: Gets the details of the specified storage classification mapping. operationId: microsoftAzureReplicationstorageclassificationmappingsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/StorageClassificationMapping' x-ms-examples: Gets the details of a storage classification mapping.: $ref: ./examples/ReplicationStorageClassificationMappings_Get.json put: tags: - ReplicationStorageClassificationMappings summary: 'Microsoft Azure Create Storage Classification Mapping' description: The operation to create a storage classification mapping. operationId: microsoftAzureReplicationstorageclassificationmappingsCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/StorageClassificationMapping' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Create storage classification mapping.: $ref: ./examples/ReplicationStorageClassificationMappings_Create.json delete: tags: - ReplicationStorageClassificationMappings summary: 'Microsoft Azure Delete A Storage Classification Mapping' description: The operation to delete a storage classification mapping. operationId: microsoftAzureReplicationstorageclassificationmappingsDelete parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Delete a storage classification mapping.: $ref: ./examples/ReplicationStorageClassificationMappings_Delete.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters : get: tags: - ReplicationvCenters summary: 'Microsoft Azure Gets The List Of Vcenter Registered Under A Fabric' description: Lists the vCenter servers registered in a fabric. operationId: microsoftAzureReplicationvcentersListbyreplicationfabrics produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: fabricName in: path description: Fabric name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/VCenterCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of vCenter registered under a fabric.: $ref: ./examples/ReplicationvCenters_ListByReplicationFabrics.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationvCenters/{vcenterName} : get: tags: - ReplicationvCenters summary: 'Microsoft Azure Gets The Details Of A Vcenter' description: Gets the details of a registered vCenter server(Add vCenter server). operationId: microsoftAzureReplicationvcentersGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/VCenter' x-ms-examples: Gets the details of a vCenter.: $ref: ./examples/ReplicationvCenters_Get.json put: tags: - ReplicationvCenters summary: 'Microsoft Azure Add Vcenter' description: The operation to create a vCenter object.. operationId: microsoftAzureReplicationvcentersCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/VCenter' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Add vCenter.: $ref: ./examples/ReplicationvCenters_Create.json delete: tags: - ReplicationvCenters summary: 'Microsoft Azure Remove Vcenter Operation' description: >- The operation to remove(unregister) a registered vCenter server from the vault. operationId: microsoftAzureReplicationvcentersDelete parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Remove vCenter operation.: $ref: ./examples/ReplicationvCenters_Delete.json patch: tags: - ReplicationvCenters summary: 'Microsoft Azure Update Vcenter Operation' description: The operation to update a registered vCenter. operationId: microsoftAzureReplicationvcentersUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/VCenter' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Update vCenter operation.: $ref: ./examples/ReplicationvCenters_Update.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs : get: tags: - ReplicationJobs summary: 'Microsoft Azure Gets The List Of Jobs' description: Gets the list of Azure Site Recovery Jobs for the vault. operationId: microsoftAzureReplicationjobsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: $filter in: query description: OData filter options. required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/JobCollection' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/JobQueryParameter' x-ms-examples: Gets the list of jobs.: $ref: ./examples/ReplicationJobs_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName} : get: tags: - ReplicationJobs summary: 'Microsoft Azure Gets The Job Details' description: Get the details of an Azure Site Recovery job. operationId: microsoftAzureReplicationjobsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: jobName in: path description: Job identifier. required: true type: string responses: '200': description: OK 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: tags: - ReplicationJobs summary: 'Microsoft Azure Cancels The Specified Job' description: The operation to cancel an Azure Site Recovery job. operationId: microsoftAzureReplicationjobsCancel produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: jobName in: path description: Job identifier. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/Job' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Cancels the specified job.: $ref: ./examples/ReplicationJobs_Cancel.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/restart : post: tags: - ReplicationJobs summary: 'Microsoft Azure Restarts The Specified Job' description: The operation to restart an Azure Site Recovery job. operationId: microsoftAzureReplicationjobsRestart produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: jobName in: path description: Job identifier. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/Job' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Restarts the specified job.: $ref: ./examples/ReplicationJobs_Restart.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/{jobName}/resume : post: tags: - ReplicationJobs summary: 'Microsoft Azure Resumes The Specified Job' description: The operation to resume an Azure Site Recovery job. operationId: microsoftAzureReplicationjobsResume consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/Job' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Resumes the specified job.: $ref: ./examples/ReplicationJobs_Resume.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationJobs/export : post: tags: - ReplicationJobs summary: 'Microsoft Azure 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. operationId: microsoftAzureReplicationjobsExport consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: jobQueryParameter in: body description: job query filter. required: true schema: $ref: '#/definitions/JobQueryParameter' responses: '200': description: OK schema: $ref: '#/definitions/Job' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Exports the details of the Azure Site Recovery jobs of the vault.: $ref: ./examples/ReplicationJobs_Export.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationMigrationItems : get: tags: - ReplicationMigrationItems summary: 'Microsoft Azure Gets The List Of Migration Items In The Vault' operationId: microsoftAzureReplicationmigrationitemsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/MigrationItemCollection' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/MigrationItemsQueryParameter' x-ms-examples: Gets the list of migration items in the vault.: $ref: ./examples/ReplicationMigrationItems_List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworkMappings : get: tags: - ReplicationNetworkMappings summary: 'Microsoft Azure Gets All The Network Mappings Under A Vault' description: Lists all ASR network mappings in the vault. operationId: microsoftAzureReplicationnetworkmappingsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/NetworkMappingCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets all the network mappings under a vault.: $ref: ./examples/ReplicationNetworkMappings_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworks : get: tags: - ReplicationNetworks summary: 'Microsoft Azure Gets The List Of Networks View Only Api' description: Lists the networks available in a vault. operationId: microsoftAzureReplicationnetworksList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/NetworkCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of networks. View-only API.: $ref: ./examples/ReplicationNetworks_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies : get: tags: - ReplicationPolicies summary: 'Microsoft Azure Gets The List Of Replication Policies' description: Lists the replication policies for a vault. operationId: microsoftAzureReplicationpoliciesList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/PolicyCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of replication policies.: $ref: ./examples/ReplicationPolicies_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationPolicies/{policyName} : get: tags: - ReplicationPolicies summary: 'Microsoft Azure Gets The Requested Policy' description: Gets the details of a replication policy. operationId: microsoftAzureReplicationpoliciesGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: policyName in: path description: Replication policy name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/Policy' x-ms-examples: Gets the requested policy.: $ref: ./examples/ReplicationPolicies_Get.json put: tags: - ReplicationPolicies summary: 'Microsoft Azure Creates The Policy' description: The operation to create a replication policy. operationId: microsoftAzureReplicationpoliciesCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/Policy' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Creates the policy.: $ref: ./examples/ReplicationPolicies_Create.json delete: tags: - ReplicationPolicies summary: 'Microsoft Azure Delete The Policy' description: The operation to delete a replication policy. operationId: microsoftAzureReplicationpoliciesDelete parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: policyName in: path description: Replication policy name. required: true type: string responses: '202': description: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Delete the policy.: $ref: ./examples/ReplicationPolicies_Delete.json patch: tags: - ReplicationPolicies summary: 'Microsoft Azure Updates The Policy' description: The operation to update a replication policy. operationId: microsoftAzureReplicationpoliciesUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: policyName in: path description: Policy Id. required: true type: string - name: input in: body description: Update Policy Input. required: true schema: $ref: '#/definitions/UpdatePolicyInput' responses: '200': description: OK schema: $ref: '#/definitions/Policy' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Updates the policy.: $ref: ./examples/ReplicationPolicies_Update.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems : get: tags: - ReplicationProtectedItems summary: 'Microsoft Azure Gets The List Of Replication Protected Items' description: Gets the list of ASR replication protected items in the vault. operationId: microsoftAzureReplicationprotecteditemsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ReplicationProtectedItemCollection' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/ProtectedItemsQueryParameter' x-ms-examples: Gets the list of replication protected items.: $ref: ./examples/ReplicationProtectedItems_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainerMappings : get: tags: - ReplicationProtectionContainerMappings summary: 'Microsoft Azure Gets The List Of All Protection Container Mappings In A Vault' description: Lists the protection container mappings in the vault. operationId: microsoftAzureReplicationprotectioncontainermappingsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/ProtectionContainerMappingCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of all protection container mappings in a vault.: $ref: ./examples/ReplicationProtectionContainerMappings_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionContainers : get: tags: - ReplicationProtectionContainers summary: 'Microsoft Azure Gets The List Of All Protection Containers In A Vault' description: Lists the protection containers in a vault. operationId: microsoftAzureReplicationprotectioncontainersList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/ProtectionContainerCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of all protection containers in a vault.: $ref: ./examples/ReplicationProtectionContainers_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents : get: tags: - ReplicationProtectionIntents summary: 'Microsoft Azure Gets The List Of Replication Protection Intent Objects' description: Gets the list of ASR replication protection intent objects in the vault. operationId: microsoftAzureReplicationprotectionintentsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/ReplicationProtectionIntentCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of replication protection intent objects.: $ref: ./examples/ReplicationProtectionIntents_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectionIntents/{intentObjectName} : get: tags: - ReplicationProtectionIntents summary: 'Microsoft Azure Gets The Details Of A Replication Protection Intent Item' description: Gets the details of an ASR replication protection intent. operationId: microsoftAzureReplicationprotectionintentsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: intentObjectName in: path description: Replication protection intent name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/ReplicationProtectionIntent' x-ms-examples: Gets the details of a Replication protection intent item.: $ref: ./examples/ReplicationProtectionIntents_Get.json put: tags: - ReplicationProtectionIntents summary: 'Microsoft Azure Create Protection Intent Resource' description: The operation to create an ASR replication protection intent item. operationId: microsoftAzureReplicationprotectionintentsCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: intentObjectName in: path description: A name for the replication protection item. required: true type: string - name: input in: body description: Create Protection Intent Input. required: true schema: $ref: '#/definitions/CreateProtectionIntentInput' responses: '200': description: OK 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: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Gets The List Of Recovery Plans' description: Lists the recovery plans in the vault. operationId: microsoftAzureReplicationrecoveryplansList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlanCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of recovery plans.: $ref: ./examples/ReplicationRecoveryPlans_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName} : get: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Gets The Requested Recovery Plan' description: Gets the details of the recovery plan. operationId: microsoftAzureReplicationrecoveryplansGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Name of the recovery plan. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' x-ms-examples: Gets the requested recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_Get.json put: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Creates A Recovery Plan With The Given Details' description: The operation to create a recovery plan. operationId: microsoftAzureReplicationrecoveryplansCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Recovery Plan creation input. required: true schema: $ref: '#/definitions/CreateRecoveryPlanInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Creates a recovery plan with the given details.: $ref: ./examples/ReplicationRecoveryPlans_Create.json delete: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Deletes The Specified Recovery Plan' description: Delete a recovery plan. operationId: microsoftAzureReplicationrecoveryplansDelete parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string responses: '202': description: Accepted '204': description: NoContent x-ms-long-running-operation: true x-ms-examples: Deletes the specified recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_Delete.json patch: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Updates The Given Recovery Plan' description: The operation to update a recovery plan. operationId: microsoftAzureReplicationrecoveryplansUpdate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Update recovery plan input. required: true schema: $ref: '#/definitions/UpdateRecoveryPlanInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Updates the given recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_Update.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCancel : post: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Execute Cancel Failover Of The Recovery Plan' description: The operation to cancel the failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansFailovercancel produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute cancel failover of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_FailoverCancel.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/failoverCommit : post: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Execute Commit Failover Of The Recovery Plan' description: The operation to commit the failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansFailovercommit produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute commit failover of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_FailoverCommit.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/plannedFailover : post: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Execute Planned Failover Of The Recovery Plan' description: The operation to start the planned failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansPlannedfailover consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Failover input. required: true schema: $ref: '#/definitions/RecoveryPlanPlannedFailoverInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute planned failover of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_PlannedFailover.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/reProtect : post: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Execute Reprotect Of The Recovery Plan' description: The operation to reprotect(reverse replicate) a recovery plan. operationId: microsoftAzureReplicationrecoveryplansReprotect produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute reprotect of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_Reprotect.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailover : post: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Execute Test Failover Of The Recovery Plan' description: The operation to start the test failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansTestfailover consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Recovery plan test failover input. required: true schema: $ref: '#/definitions/RecoveryPlanTestFailoverInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute test failover of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_TestFailover.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/testFailoverCleanup : post: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Execute Test Failover Cleanup Of The Recovery Plan' description: The operation to cleanup test failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansTestfailovercleanup consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Recovery plan test failover cleanup input. required: true schema: $ref: '#/definitions/RecoveryPlanTestFailoverCleanupInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute test failover cleanup of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_TestFailoverCleanup.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/unplannedFailover : post: tags: - ReplicationRecoveryPlans summary: 'Microsoft Azure Execute Unplanned Failover Of The Recovery Plan' description: The operation to start the unplanned failover of a recovery plan. operationId: microsoftAzureReplicationrecoveryplansUnplannedfailover consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: recoveryPlanName in: path description: Recovery plan name. required: true type: string - name: input in: body description: Recovery plan unplanned failover input. required: true schema: $ref: '#/definitions/RecoveryPlanUnplannedFailoverInput' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryPlan' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Execute unplanned failover of the recovery plan.: $ref: ./examples/ReplicationRecoveryPlans_UnplannedFailover.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryServicesProviders : get: tags: - ReplicationRecoveryServicesProviders summary: >- Microsoft Azure 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. operationId: microsoftAzureReplicationrecoveryservicesprovidersList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/RecoveryServicesProviderCollection' x-ms-pageable: nextLinkName: nextLink 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 ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassificationMappings : get: tags: - ReplicationStorageClassificationMappings summary: 'Microsoft Azure Gets The List Of Storage Classification Mappings Objects Under A Vault' description: Lists the storage classification mappings in the vault. operationId: microsoftAzureReplicationstorageclassificationmappingsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/StorageClassificationMappingCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of storage classification mappings objects under a vault.: $ref: ./examples/ReplicationStorageClassificationMappings_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationStorageClassifications : get: tags: - ReplicationStorageClassifications summary: 'Microsoft Azure Gets The List Of Storage Classification Objects Under A Vault' description: Lists the storage classifications in the vault. operationId: microsoftAzureReplicationstorageclassificationsList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/StorageClassificationCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of storage classification objects under a vault.: $ref: ./examples/ReplicationStorageClassifications_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationSupportedOperatingSystems : get: tags: - SupportedOperatingSystems summary: 'Microsoft Azure Gets The Data Of Supported Operating Systems By Srs' operationId: microsoftAzureSupportedoperatingsystemsGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: instanceType in: query description: The instance type. required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/SupportedOperatingSystems' x-ms-examples: Gets the data of supported operating systems by SRS.: $ref: ./examples/SupportedOperatingSystems_Get.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultHealth : get: tags: - ReplicationVaultHealth summary: 'Microsoft Azure Gets The Health Summary For The Vault' description: Gets the health details of the vault. operationId: microsoftAzureReplicationvaulthealthGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK 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: tags: - ReplicationVaultHealth summary: 'Microsoft Azure Refreshes Health Summary Of The Vault' operationId: microsoftAzureReplicationvaulthealthRefresh produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/VaultHealthDetails' '202': description: Accepted x-ms-long-running-operation: true x-ms-examples: Refreshes health summary of the vault.: $ref: ./examples/ReplicationVaultHealth_Refresh.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings : get: tags: - ReplicationVaultSetting summary: 'Microsoft Azure Gets The List Of Vault Setting' description: >- Gets the list of vault setting. This includes the Migration Hub connection settings. operationId: microsoftAzureReplicationvaultsettingList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/VaultSettingCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of vault setting.: $ref: ./examples/ReplicationVaultSetting_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationVaultSettings/{vaultSettingName} : get: tags: - ReplicationVaultSetting summary: 'Microsoft Azure Gets The Vault Setting' description: >- Gets the vault setting. This includes the Migration Hub connection settings. operationId: microsoftAzureReplicationvaultsettingGet produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - name: vaultSettingName in: path description: Vault setting name. required: true type: string responses: '200': description: OK schema: $ref: '#/definitions/VaultSetting' x-ms-examples: Gets the vault setting.: $ref: ./examples/ReplicationVaultSetting_Get.json put: tags: - ReplicationVaultSetting summary: >- Microsoft Azure 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. operationId: microsoftAzureReplicationvaultsettingCreate consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' - 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: OK schema: $ref: '#/definitions/VaultSetting' x-ms-long-running-operation: true x-ms-examples: Updates vault setting. A vault setting object is a singleton per vault and it is always present by default.: $ref: ./examples/ReplicationVaultSetting_Create.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationvCenters : get: tags: - ReplicationvCenters summary: 'Microsoft Azure Gets The List Of Vcenter Registered Under The Vault' description: Lists the vCenter servers registered in the vault. operationId: microsoftAzureReplicationvcentersList produces: - application/json parameters: - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ResourceName' - $ref: '#/parameters/ResourceGroupName' - $ref: '#/parameters/SubscriptionId' responses: '200': description: OK schema: $ref: '#/definitions/VCenterCollection' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets the list of vCenter registered under the vault.: $ref: ./examples/ReplicationvCenters_List.json definitions: A2AAddDisksInput: description: A2A add disk(s) input. type: object allOf: - $ref: '#/definitions/AddDisksProviderSpecificInput' properties: vmDisks: description: The list of vm disk details. type: array items: $ref: '#/definitions/A2AVmDiskInputDetails' vmManagedDisks: description: The list of vm managed disk details. type: array items: $ref: '#/definitions/A2AVmManagedDiskInputDetails' x-ms-discriminator-value: A2A A2AApplyRecoveryPointInput: description: ApplyRecoveryPoint input specific to A2A provider. required: - instanceType type: object allOf: - $ref: '#/definitions/ApplyRecoveryPointProviderSpecificInput' properties: {} x-ms-discriminator-value: A2A A2AContainerCreationInput: description: A2A cloud creation input. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificContainerCreationInput' properties: {} x-ms-discriminator-value: A2A A2AContainerMappingInput: description: A2A container mapping input. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificContainerMappingInput' properties: agentAutoUpdateStatus: description: A value indicating whether the auto update is enabled. enum: - Disabled - Enabled type: string x-ms-enum: name: AgentAutoUpdateStatus modelAsString: true automationAccountArmId: description: The automation account arm id. type: string automationAccountAuthenticationType: description: >- A value indicating the type authentication to use for automation Account. enum: - RunAsAccount - SystemAssignedIdentity type: string default: RunAsAccount x-ms-enum: name: AutomationAccountAuthenticationType modelAsString: true x-ms-discriminator-value: A2A A2ACreateProtectionIntentInput: description: A2A create protection intent input. required: - fabricObjectId - primaryLocation - recoveryLocation - recoverySubscriptionId - recoveryAvailabilityType - recoveryResourceGroupId type: object allOf: - $ref: '#/definitions/CreateProtectionIntentProviderSpecificDetails' properties: fabricObjectId: description: The fabric specific object Id of the virtual machine. type: string primaryLocation: description: The primary location for the virtual machine. type: string recoveryLocation: description: The recovery location for the virtual machine. type: string recoverySubscriptionId: description: The recovery subscription Id of the virtual machine. type: string recoveryAvailabilityType: description: The recovery availability type of the virtual machine. enum: - Single - AvailabilitySet - AvailabilityZone type: string x-ms-enum: name: A2ARecoveryAvailabilityType modelAsString: true protectionProfileCustomInput: $ref: '#/definitions/ProtectionProfileCustomDetails' description: The protection profile custom inputs. recoveryResourceGroupId: description: The recovery resource group Id. Valid for V2 scenarios. type: string 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: description: A value indicating whether the auto protection is enabled. enum: - Disabled - Enabled type: string x-ms-enum: name: AutoProtectionOfDataDisk modelAsString: true vmDisks: description: The list of vm disk inputs. type: array items: $ref: '#/definitions/A2AProtectionIntentDiskInputDetails' vmManagedDisks: description: The list of vm managed disk inputs. type: array items: $ref: '#/definitions/A2AProtectionIntentManagedDiskInputDetails' multiVmGroupName: description: The multi vm group name. type: string multiVmGroupId: description: The multi vm group id. type: string 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: description: The recovery availability zone. type: string agentAutoUpdateStatus: description: A value indicating whether the auto update is enabled. enum: - Disabled - Enabled type: string x-ms-enum: name: AgentAutoUpdateStatus modelAsString: true automationAccountAuthenticationType: description: >- A value indicating the authentication type for automation account. The default value is "RunAsAccount". enum: - RunAsAccount - SystemAssignedIdentity type: string default: RunAsAccount x-ms-enum: name: AutomationAccountAuthenticationType modelAsString: true automationAccountArmId: description: The automation account arm id. type: string x-ms-discriminator-value: A2A A2ACrossClusterMigrationApplyRecoveryPointInput: description: ApplyRecoveryPoint input specific to A2ACrossClusterMigration provider. required: - instanceType type: object allOf: - $ref: '#/definitions/ApplyRecoveryPointProviderSpecificInput' properties: {} x-ms-discriminator-value: A2ACrossClusterMigration A2ACrossClusterMigrationContainerCreationInput: description: A2ACrossClusterMigration cloud creation input. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificContainerCreationInput' properties: {} x-ms-discriminator-value: A2ACrossClusterMigration A2ACrossClusterMigrationEnableProtectionInput: description: A2A Cross-Cluster Migration enable protection input. type: object allOf: - $ref: '#/definitions/EnableProtectionProviderSpecificInput' properties: fabricObjectId: description: The fabric specific object Id of the virtual machine. type: string recoveryContainerId: description: The recovery container Id. type: string x-ms-discriminator-value: A2ACrossClusterMigration A2ACrossClusterMigrationPolicyCreationInput: description: A2A Cross-Cluster Migration Policy creation input. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificInput' properties: {} x-ms-discriminator-value: A2ACrossClusterMigration A2ACrossClusterMigrationReplicationDetails: description: A2A provider specific settings. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificSettings' properties: fabricObjectId: description: The fabric specific object Id of the virtual machine. type: string primaryFabricLocation: description: Primary fabric location. type: string osType: description: The type of operating system. type: string vmProtectionState: description: The protection state for the vm. type: string vmProtectionStateDescription: description: The protection state description for the vm. type: string lifecycleId: 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. type: string x-ms-discriminator-value: A2ACrossClusterMigration A2AEnableProtectionInput: description: A2A enable protection input. required: - fabricObjectId type: object allOf: - $ref: '#/definitions/EnableProtectionProviderSpecificInput' properties: fabricObjectId: description: The fabric specific object Id of the virtual machine. type: string recoveryContainerId: description: The recovery container Id. type: string recoveryResourceGroupId: description: The recovery resource group Id. Valid for V2 scenarios. type: string recoveryCloudServiceId: description: The recovery cloud service Id. Valid for V1 scenarios. type: string recoveryAvailabilitySetId: description: The recovery availability set Id. type: string recoveryProximityPlacementGroupId: description: The recovery proximity placement group Id. type: string vmDisks: description: The list of vm disk details. type: array items: $ref: '#/definitions/A2AVmDiskInputDetails' vmManagedDisks: description: The list of vm managed disk details. type: array items: $ref: '#/definitions/A2AVmManagedDiskInputDetails' multiVmGroupName: description: The multi vm group name. type: string multiVmGroupId: description: The multi vm group id. type: string recoveryBootDiagStorageAccountId: description: The boot diagnostic storage account. type: string diskEncryptionInfo: $ref: '#/definitions/DiskEncryptionInfo' description: The recovery disk encryption information (for two pass flows). recoveryAvailabilityZone: description: The recovery availability zone. type: string recoveryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The recovery extended location. recoveryAzureNetworkId: description: The recovery Azure virtual network ARM id. type: string recoverySubnetName: description: The recovery subnet name. type: string recoveryVirtualMachineScaleSetId: description: The virtual machine scale set Id. type: string recoveryCapacityReservationGroupId: description: The recovery capacity reservation group Id. type: string x-ms-discriminator-value: A2A A2AEventDetails: description: Model class for event details of a A2A event. type: object allOf: - $ref: '#/definitions/EventProviderSpecificDetails' properties: protectedItemName: description: The protected item arm name. type: string fabricObjectId: description: The azure vm arm id. type: string fabricName: description: Fabric arm name. type: string fabricLocation: description: The fabric location. type: string remoteFabricName: description: Remote fabric arm name. type: string remoteFabricLocation: description: Remote fabric location. type: string x-ms-discriminator-value: A2A A2AExtendedLocationDetails: description: ExtendedLocation details data. type: object properties: primaryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The primary ExtendedLocation. recoveryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The recovery ExtendedLocation. A2AFabricSpecificLocationDetails: description: ExtendedLocation details data. type: object properties: initialPrimaryZone: description: The initial source zone info. type: string initialRecoveryZone: description: The initial target zone info. type: string initialPrimaryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The initial primary ExtendedLocation. initialRecoveryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The initial recovery ExtendedLocation. initialPrimaryFabricLocation: description: Initial primary fabric location info. type: string initialRecoveryFabricLocation: description: The initial recovery fabric location info. type: string primaryZone: description: Source zone info. type: string recoveryZone: description: The target zone info. type: string primaryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The primary ExtendedLocation. recoveryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The recovery ExtendedLocation. primaryFabricLocation: description: Primary fabric location info. type: string recoveryFabricLocation: description: The recovery fabric location info. type: string A2APolicyCreationInput: description: A2A Policy creation input. required: - multiVmSyncStatus type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificInput' properties: recoveryPointHistory: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency (in minutes). type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency (in minutes). type: integer multiVmSyncStatus: description: >- A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'. enum: - Enable - Disable type: string x-ms-enum: name: SetMultiVmSyncStatus modelAsString: true x-ms-discriminator-value: A2A A2APolicyDetails: description: A2A specific policy details. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: recoveryPointThresholdInMinutes: format: int32 description: The recovery point threshold in minutes. type: integer recoveryPointHistory: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency in minutes. type: integer multiVmSyncStatus: description: A value indicating whether multi-VM sync has to be enabled. type: string crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency in minutes. type: integer x-ms-discriminator-value: A2A A2AProtectedDiskDetails: description: A2A protected disk details. type: object properties: diskUri: description: The disk uri. type: string recoveryAzureStorageAccountId: description: The recovery disk storage account. type: string primaryDiskAzureStorageAccountId: description: The primary disk storage account. type: string recoveryDiskUri: description: Recovery disk uri. type: string diskName: description: The disk name. type: string diskCapacityInBytes: format: int64 description: The disk capacity in bytes. type: integer primaryStagingAzureStorageAccountId: description: The primary staging storage account. type: string diskType: description: The type of disk. type: string resyncRequired: description: A value indicating whether resync is required for this disk. type: boolean monitoringPercentageCompletion: format: int32 description: >- The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. type: integer monitoringJobType: description: >- The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. type: string dataPendingInStagingStorageAccountInMB: format: double description: The data pending for replication in MB at staging account. type: number dataPendingAtSourceAgentInMB: format: double description: The data pending at source virtual machine in MB. type: number diskState: description: The disk state. type: string allowedDiskLevelOperation: description: The disk level operations list. type: array items: type: string isDiskEncrypted: description: A value indicating whether vm has encrypted os disk or not. type: boolean secretIdentifier: description: The secret URL / identifier (BEK). type: string dekKeyVaultArmId: description: The KeyVault resource id for secret (BEK). type: string isDiskKeyEncrypted: description: A value indicating whether disk key got encrypted or not. type: boolean keyIdentifier: description: The key URL / identifier (KEK). type: string kekKeyVaultArmId: description: The KeyVault resource id for key (KEK). type: string failoverDiskName: description: The failover name for the managed disk. type: string tfoDiskName: description: The test failover name for the managed disk. type: string A2AProtectedManagedDiskDetails: description: A2A protected managed disk details. type: object properties: diskId: description: The managed disk Arm id. type: string recoveryResourceGroupId: description: The recovery disk resource group Arm Id. type: string recoveryTargetDiskId: description: Recovery target disk Arm Id. type: string recoveryReplicaDiskId: description: Recovery replica disk Arm Id. type: string recoveryOrignalTargetDiskId: description: Recovery original target disk Arm Id. type: string recoveryReplicaDiskAccountType: description: >- The replica disk type. Its an optional value and will be same as source disk type if not user provided. type: string recoveryTargetDiskAccountType: description: >- The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. type: string recoveryDiskEncryptionSetId: description: The recovery disk encryption set Id. type: string primaryDiskEncryptionSetId: description: The primary disk encryption set Id. type: string diskName: description: The disk name. type: string diskCapacityInBytes: format: int64 description: The disk capacity in bytes. type: integer primaryStagingAzureStorageAccountId: description: The primary staging storage account. type: string diskType: description: The type of disk. type: string resyncRequired: description: A value indicating whether resync is required for this disk. type: boolean monitoringPercentageCompletion: format: int32 description: >- The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. type: integer monitoringJobType: description: >- The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. type: string dataPendingInStagingStorageAccountInMB: format: double description: The data pending for replication in MB at staging account. type: number dataPendingAtSourceAgentInMB: format: double description: The data pending at source virtual machine in MB. type: number diskState: description: The disk state. type: string allowedDiskLevelOperation: description: The disk level operations list. type: array items: type: string isDiskEncrypted: description: A value indicating whether vm has encrypted os disk or not. type: boolean secretIdentifier: description: The secret URL / identifier (BEK). type: string dekKeyVaultArmId: description: The KeyVault resource id for secret (BEK). type: string isDiskKeyEncrypted: description: A value indicating whether disk key got encrypted or not. type: boolean keyIdentifier: description: The key URL / identifier (KEK). type: string kekKeyVaultArmId: description: The KeyVault resource id for key (KEK). type: string failoverDiskName: description: The failover name for the managed disk. type: string tfoDiskName: description: The test failover name for the managed disk. type: string A2AProtectionContainerMappingDetails: description: A2A provider specific settings. type: object allOf: - $ref: '#/definitions/ProtectionContainerMappingProviderSpecificDetails' properties: agentAutoUpdateStatus: description: A value indicating whether the auto update is enabled. enum: - Disabled - Enabled type: string x-ms-enum: name: AgentAutoUpdateStatus modelAsString: true automationAccountArmId: description: The automation account arm id. type: string automationAccountAuthenticationType: description: >- A value indicating the type authentication to use for automation Account. enum: - RunAsAccount - SystemAssignedIdentity type: string default: RunAsAccount x-ms-enum: name: AutomationAccountAuthenticationType modelAsString: true scheduleName: description: The schedule arm name. type: string jobScheduleName: description: The job schedule arm name. type: string x-ms-discriminator-value: A2A A2AProtectionIntentDiskInputDetails: description: Azure VM unmanaged disk input details. required: - diskUri type: object properties: diskUri: description: The disk Uri. type: string recoveryAzureStorageAccountCustomInput: $ref: '#/definitions/StorageAccountCustomDetails' description: The recovery VHD storage account input. primaryStagingStorageAccountCustomInput: $ref: '#/definitions/StorageAccountCustomDetails' description: The primary staging storage account input. A2AProtectionIntentManagedDiskInputDetails: description: Azure VM managed disk input details. required: - diskId type: object properties: diskId: description: The disk Id. type: string primaryStagingStorageAccountCustomInput: $ref: '#/definitions/StorageAccountCustomDetails' description: The primary staging storage account input. recoveryResourceGroupCustomInput: $ref: '#/definitions/RecoveryResourceGroupCustomDetails' description: The recovery resource group input. recoveryReplicaDiskAccountType: description: >- The replica disk type. Its an optional value and will be same as source disk type if not user provided. type: string recoveryTargetDiskAccountType: description: >- The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. type: string recoveryDiskEncryptionSetId: description: The recovery disk encryption set Id. type: string diskEncryptionInfo: $ref: '#/definitions/DiskEncryptionInfo' description: >- The recovery disk encryption information (for one / single pass flows). A2ARecoveryPointDetails: description: A2A provider specific recovery point details. type: object allOf: - $ref: '#/definitions/ProviderSpecificRecoveryPointDetails' properties: recoveryPointSyncType: description: A value indicating whether the recovery point is multi VM consistent. enum: - MultiVmSyncRecoveryPoint - PerVmRecoveryPoint type: string x-ms-enum: name: RecoveryPointSyncType modelAsString: true disks: description: List of disk ids representing a recovery point. type: array items: type: string x-ms-discriminator-value: A2A A2ARemoveDisksInput: description: A2A remove disk(s) input. type: object allOf: - $ref: '#/definitions/RemoveDisksProviderSpecificInput' properties: vmDisksUris: description: The list of vm disk vhd URIs. type: array items: type: string vmManagedDisksIds: description: The list of vm managed disk Ids. type: array items: type: string x-ms-discriminator-value: A2A A2AReplicationDetails: description: A2A provider specific settings. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificSettings' properties: fabricObjectId: description: The fabric specific object Id of the virtual machine. type: string initialPrimaryZone: description: The initial primary availability zone. type: string readOnly: true initialPrimaryFabricLocation: description: The initial primary fabric location. type: string readOnly: true initialRecoveryZone: description: The initial recovery availability zone. type: string readOnly: true initialPrimaryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The initial primary extended location. initialRecoveryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The initial recovery extended location. initialRecoveryFabricLocation: description: The initial recovery fabric location. type: string readOnly: true multiVmGroupId: description: The multi vm group Id. type: string multiVmGroupName: description: The multi vm group name. type: string multiVmGroupCreateOption: description: Whether Multi VM group is auto created or specified by user. enum: - AutoCreated - UserSpecified type: string x-ms-enum: name: MultiVmGroupCreateOption modelAsString: true managementId: description: The management Id. type: string protectedDisks: description: The list of protected disks. type: array items: $ref: '#/definitions/A2AProtectedDiskDetails' unprotectedDisks: description: The list of unprotected disks. type: array items: $ref: '#/definitions/A2AUnprotectedDiskDetails' protectedManagedDisks: description: The list of protected managed disks. type: array items: $ref: '#/definitions/A2AProtectedManagedDiskDetails' recoveryBootDiagStorageAccountId: description: The recovery boot diagnostic storage account Arm Id. type: string primaryFabricLocation: description: Primary fabric location. type: string recoveryFabricLocation: description: The recovery fabric location. type: string osType: description: The type of operating system. type: string recoveryAzureVMSize: description: The size of recovery virtual machine. type: string recoveryAzureVMName: description: The name of recovery virtual machine. type: string recoveryAzureResourceGroupId: description: The recovery resource group. type: string recoveryCloudService: description: The recovery cloud service. type: string recoveryAvailabilitySet: description: The recovery availability set. type: string selectedRecoveryAzureNetworkId: description: The recovery virtual network. type: string selectedTfoAzureNetworkId: description: The test failover virtual network. type: string vmNics: description: The virtual machine nic details. type: array items: $ref: '#/definitions/VMNicDetails' vmSyncedConfigDetails: $ref: '#/definitions/AzureToAzureVmSyncedConfigDetails' description: The synced configuration details. monitoringPercentageCompletion: format: int32 description: >- The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. type: integer monitoringJobType: description: >- The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. type: string lastHeartbeat: format: date-time description: The last heartbeat received from the source server. type: string agentVersion: description: The agent version. type: string agentExpiryDate: format: date-time description: Agent expiry date. type: string isReplicationAgentUpdateRequired: description: A value indicating whether replication agent update is required. type: boolean agentCertificateExpiryDate: format: date-time description: Agent certificate expiry date. type: string readOnly: true isReplicationAgentCertificateUpdateRequired: description: A value indicating whether agent certificate update is required. type: boolean recoveryFabricObjectId: description: The recovery fabric object Id. type: string vmProtectionState: description: The protection state for the vm. type: string vmProtectionStateDescription: description: The protection state description for the vm. type: string lifecycleId: 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. type: string testFailoverRecoveryFabricObjectId: description: The test failover fabric object Id. type: string rpoInSeconds: format: int64 description: The last RPO value in seconds. type: integer lastRpoCalculatedTime: format: date-time description: >- The time (in UTC) when the last RPO value was calculated by Protection Service. type: string primaryAvailabilityZone: description: The primary availability zone. type: string recoveryAvailabilityZone: description: The recovery availability zone. type: string primaryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The primary Extended Location. recoveryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The recovery Extended Location. vmEncryptionType: description: The encryption type of the VM. type: string readOnly: true enum: - NotEncrypted - OnePassEncrypted - TwoPassEncrypted x-ms-enum: name: VmEncryptionType modelAsString: true tfoAzureVMName: description: The test failover vm name. type: string recoveryAzureGeneration: description: The recovery azure generation. type: string readOnly: true recoveryProximityPlacementGroupId: description: The recovery proximity placement group Id. type: string autoProtectionOfDataDisk: description: A value indicating whether the auto protection is enabled. enum: - Disabled - Enabled type: string x-ms-enum: name: AutoProtectionOfDataDisk modelAsString: true recoveryVirtualMachineScaleSetId: description: The recovery virtual machine scale set id. type: string recoveryCapacityReservationGroupId: description: The recovery capacity reservation group Id. type: string churnOptionSelected: description: A value indicating the churn option selected by user. type: string readOnly: true enum: - Normal - High x-ms-enum: name: ChurnOptionSelected modelAsString: true x-ms-discriminator-value: A2A A2AReplicationIntentDetails: description: A2A provider specific settings. required: - recoveryAvailabilityType type: object allOf: - $ref: '#/definitions/ReplicationProtectionIntentProviderSpecificSettings' properties: fabricObjectId: description: The fabric specific object Id of the virtual machine. type: string primaryLocation: description: The primary location for the virtual machine. type: string recoveryLocation: description: The recovery location for the virtual machine. type: string recoverySubscriptionId: description: The recovery subscription Id of the virtual machine. type: string vmDisks: description: The list of vm disk details. type: array items: $ref: '#/definitions/A2AProtectionIntentDiskInputDetails' vmManagedDisks: description: The list of vm managed disk details. type: array items: $ref: '#/definitions/A2AProtectionIntentManagedDiskInputDetails' recoveryResourceGroupId: description: The recovery resource group id. type: string 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: description: A value indicating whether the auto protection is enabled. enum: - Disabled - Enabled type: string x-ms-enum: name: AutoProtectionOfDataDisk modelAsString: true multiVmGroupName: description: The multi vm group name. type: string multiVmGroupId: description: The multi vm group id. type: string 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: description: The recovery availability zone. type: string recoveryAvailabilityType: description: The recovery availability type of the virtual machine. type: string agentAutoUpdateStatus: description: A value indicating whether the auto update is enabled. enum: - Disabled - Enabled type: string x-ms-enum: name: AgentAutoUpdateStatus modelAsString: true automationAccountArmId: description: The automation account arm id. type: string automationAccountAuthenticationType: description: >- A value indicating the type authentication to use for automation Account. enum: - RunAsAccount - SystemAssignedIdentity type: string default: RunAsAccount x-ms-enum: name: AutomationAccountAuthenticationType modelAsString: true x-ms-discriminator-value: A2A A2AReprotectInput: description: Azure specific reprotect input. type: object allOf: - $ref: '#/definitions/ReverseReplicationProviderSpecificInput' properties: recoveryContainerId: description: The recovery container Id. type: string vmDisks: description: The list of vm disk details. type: array items: $ref: '#/definitions/A2AVmDiskInputDetails' recoveryResourceGroupId: description: The recovery resource group Id. Valid for V2 scenarios. type: string recoveryCloudServiceId: description: The recovery cloud service Id. Valid for V1 scenarios. type: string recoveryAvailabilitySetId: description: The recovery availability set. type: string policyId: description: The Policy Id. type: string x-ms-discriminator-value: A2A A2ASwitchProtectionInput: description: A2A specific switch protection input. type: object allOf: - $ref: '#/definitions/SwitchProtectionProviderSpecificInput' properties: recoveryContainerId: description: The recovery container Id. type: string vmDisks: description: The list of vm disk details. type: array items: $ref: '#/definitions/A2AVmDiskInputDetails' vmManagedDisks: description: The list of vm managed disk details. type: array items: $ref: '#/definitions/A2AVmManagedDiskInputDetails' recoveryResourceGroupId: description: The recovery resource group Id. Valid for V2 scenarios. type: string recoveryCloudServiceId: description: The recovery cloud service Id. Valid for V1 scenarios. type: string recoveryAvailabilitySetId: description: The recovery availability set. type: string policyId: description: The Policy Id. type: string recoveryBootDiagStorageAccountId: description: The boot diagnostic storage account. type: string recoveryAvailabilityZone: description: The recovery availability zone. type: string recoveryProximityPlacementGroupId: description: The recovery proximity placement group Id. type: string recoveryVirtualMachineScaleSetId: description: The virtual machine scale set id. type: string recoveryCapacityReservationGroupId: description: The recovery capacity reservation group Id. type: string diskEncryptionInfo: $ref: '#/definitions/DiskEncryptionInfo' description: The recovery disk encryption information. x-ms-discriminator-value: A2A A2ATestFailoverInput: description: A2A provider specific input for test failover. type: object allOf: - $ref: '#/definitions/TestFailoverProviderSpecificInput' properties: recoveryPointId: 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. type: string cloudServiceCreationOption: description: >- A value indicating whether to use recovery cloud service for TFO or not. type: string x-ms-discriminator-value: A2A A2AUnplannedFailoverInput: description: A2A provider specific input for unplanned failover. type: object allOf: - $ref: '#/definitions/UnplannedFailoverProviderSpecificInput' properties: recoveryPointId: 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. type: string cloudServiceCreationOption: description: >- A value indicating whether to use recovery cloud service for failover or not. type: string x-ms-discriminator-value: A2A A2AUnprotectedDiskDetails: description: A2A unprotected disk details. type: object properties: diskLunId: format: int32 description: The source lun Id for the data disk. type: integer diskAutoProtectionStatus: description: A value indicating whether the disk auto protection is enabled. enum: - Disabled - Enabled type: string x-ms-enum: name: AutoProtectionOfDataDisk modelAsString: true A2AUpdateContainerMappingInput: description: A2A update protection container mapping. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput' properties: agentAutoUpdateStatus: description: A value indicating whether the auto update is enabled. enum: - Disabled - Enabled type: string x-ms-enum: name: AgentAutoUpdateStatus modelAsString: true automationAccountArmId: description: The automation account arm id. type: string automationAccountAuthenticationType: description: >- A value indicating the type authentication to use for automation Account. enum: - RunAsAccount - SystemAssignedIdentity type: string default: RunAsAccount x-ms-enum: name: AutomationAccountAuthenticationType modelAsString: true x-ms-discriminator-value: A2A A2AUpdateReplicationProtectedItemInput: description: InMage Azure V2 input to update replication protected item. type: object allOf: - $ref: '#/definitions/UpdateReplicationProtectedItemProviderInput' properties: recoveryCloudServiceId: description: The target cloud service ARM Id (for V1). type: string recoveryResourceGroupId: description: The target resource group ARM Id (for V2). type: string managedDiskUpdateDetails: description: Managed disk update details. type: array items: $ref: '#/definitions/A2AVmManagedDiskUpdateDetails' recoveryBootDiagStorageAccountId: description: The boot diagnostic storage account. type: string diskEncryptionInfo: $ref: '#/definitions/DiskEncryptionInfo' description: The recovery os disk encryption information. tfoAzureVMName: description: The user given name for Test Failover VM. type: string recoveryProximityPlacementGroupId: description: The recovery proximity placement group Id. type: string recoveryVirtualMachineScaleSetId: description: The recovery virtual machine scale set Id. type: string recoveryCapacityReservationGroupId: description: The recovery capacity reservation group Id. type: string x-ms-discriminator-value: A2A A2AVmDiskInputDetails: description: A2A disk input details. required: - diskUri - recoveryAzureStorageAccountId - primaryStagingAzureStorageAccountId type: object properties: diskUri: description: The disk Uri. type: string recoveryAzureStorageAccountId: description: The recovery VHD storage account Id. type: string primaryStagingAzureStorageAccountId: description: The primary staging storage account Id. type: string A2AVmManagedDiskInputDetails: description: A2A managed disk input details. required: - diskId - primaryStagingAzureStorageAccountId - recoveryResourceGroupId type: object properties: diskId: description: The disk Id. type: string primaryStagingAzureStorageAccountId: description: The primary staging storage account Arm Id. type: string recoveryResourceGroupId: description: The target resource group Arm Id. type: string recoveryReplicaDiskAccountType: description: >- The replica disk type. Its an optional value and will be same as source disk type if not user provided. type: string recoveryTargetDiskAccountType: description: >- The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. type: string recoveryDiskEncryptionSetId: description: The recovery disk encryption set Id. type: string diskEncryptionInfo: $ref: '#/definitions/DiskEncryptionInfo' description: >- The recovery disk encryption information (for one / single pass flows). A2AVmManagedDiskUpdateDetails: description: A2A Vm managed disk update details. type: object properties: diskId: description: The disk Id. type: string recoveryTargetDiskAccountType: description: The target disk type before failover. type: string recoveryReplicaDiskAccountType: description: The replica disk type before failover. type: string diskEncryptionInfo: $ref: '#/definitions/DiskEncryptionInfo' description: The recovery os disk encryption information. failoverDiskName: description: The target disk name for unplanned failover operation. type: string tfoDiskName: description: The target disk name for test failover operation. type: string A2AZoneDetails: description: Zone details data. type: object properties: source: description: Source zone info. type: string target: description: The target zone info. type: string AddDisksInput: description: Input for add disk(s) operation. type: object properties: properties: $ref: '#/definitions/AddDisksInputProperties' description: Add disks input properties. AddDisksInputProperties: description: Add Disks input properties. required: - providerSpecificDetails type: object 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. AddDisksProviderSpecificInput: description: Add Disks provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType AddRecoveryServicesProviderInput: description: Input required to add a provider. required: - properties type: object properties: properties: $ref: '#/definitions/AddRecoveryServicesProviderInputProperties' description: The properties of an add provider request. AddRecoveryServicesProviderInputProperties: description: The properties of an add provider request. required: - machineName - authenticationIdentityInput - resourceAccessIdentityInput type: object properties: machineName: description: The name of the machine where the provider is getting added. type: string machineId: description: The Id of the machine where the provider is getting added. type: string biosId: description: The Bios Id of the machine. type: string 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. AddVCenterRequest: description: Input required to add vCenter. type: object properties: properties: $ref: '#/definitions/AddVCenterRequestProperties' description: The properties of an add vCenter request. AddVCenterRequestProperties: description: The properties of an add vCenter request. type: object properties: friendlyName: description: The friendly name of the vCenter. type: string ipAddress: description: The IP address of the vCenter to be discovered. type: string processServerId: description: The process server Id from where the discovery is orchestrated. type: string port: description: The port number for discovery. type: string runAsAccountId: description: The account Id which has privileges to discover the vCenter. type: string AgentDetails: description: Agent details. type: object properties: agentId: description: The Id of the agent running on the server. type: string readOnly: true machineId: description: The Id of the machine to which the agent is registered. type: string readOnly: true biosId: description: The machine BIOS Id. type: string readOnly: true fqdn: description: The machine FQDN. type: string readOnly: true disks: description: The disks. type: array items: $ref: '#/definitions/AgentDiskDetails' readOnly: true AgentDiskDetails: description: Agent disk details. type: object properties: diskId: description: The disk Id. type: string readOnly: true diskName: description: The disk name. type: string readOnly: true isOSDisk: description: A value indicating whether the disk is the OS disk. type: string readOnly: true capacityInBytes: format: int64 description: The disk capacity in bytes. type: integer readOnly: true lunId: format: int32 description: The lun of disk. type: integer readOnly: true Alert: description: Implements the Alert class. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/AlertProperties' description: Alert related data. AlertCollection: description: Collection of alerts. type: object properties: value: description: The list of alerts. type: array items: $ref: '#/definitions/Alert' nextLink: description: The value of next link. type: string AlertProperties: description: The properties of an alert. type: object properties: sendToOwners: description: >- A value indicating whether to send email to subscription administrator. type: string customEmailAddresses: description: The custom email address for sending emails. type: array items: type: string locale: description: The locale for the email notification. type: string ApplianceCollection: description: Collection of appliance details. type: object properties: value: description: The appliance details. type: array items: $ref: '#/definitions/ReplicationAppliance' nextLink: description: The value of next link. type: string ApplianceMonitoringDetails: description: Appliance details of the migration item. type: object properties: cpuDetails: $ref: '#/definitions/ApplianceResourceDetails' description: The appliance CPU details. readOnly: true ramDetails: $ref: '#/definitions/ApplianceResourceDetails' description: The appliance RAM details. readOnly: true datastoreSnapshot: description: The appliance datastore snapshot details. type: array 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 ApplianceQueryParameter: description: Query parameter to get appliance. type: object properties: providerType: description: The providerType to be used for fetching appliance details. type: string ApplianceResourceDetails: description: Details of the appliance resource. type: object properties: capacity: format: int64 description: A value indicating the total capacity of appliance resource. type: integer readOnly: true processUtilization: format: double description: >- A value indicating the utilization percentage by gateway agent on appliance. type: number readOnly: true totalUtilization: format: double description: >- A value indicating the total utilization percentage for all processes on the appliance. type: number readOnly: true status: description: A value indicating the status of appliance resource. type: string readOnly: true ApplianceSpecificDetails: description: Appliance specific details. type: object properties: instanceType: description: Gets the class type. Overridden in derived classes. type: string discriminator: instanceType required: - instanceType ApplyRecoveryPointInput: description: Input to apply recovery point. required: - properties type: object properties: properties: $ref: '#/definitions/ApplyRecoveryPointInputProperties' description: The input properties to apply recovery point. ApplyRecoveryPointInputProperties: description: Input properties to apply recovery point. required: - providerSpecificDetails type: object properties: recoveryPointId: description: The recovery point Id. type: string providerSpecificDetails: $ref: '#/definitions/ApplyRecoveryPointProviderSpecificInput' description: Provider specific input for applying recovery point. ApplyRecoveryPointProviderSpecificInput: description: Provider specific input for apply recovery point. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType AsrJobDetails: description: This class represents job details based on specific job type. type: object allOf: - $ref: '#/definitions/JobDetails' properties: {} x-ms-discriminator-value: AsrJobDetails ASRTask: description: Task of the Job. type: object properties: taskId: description: The Id. type: string name: description: The unique Task name. type: string startTime: format: date-time description: The start time. type: string endTime: format: date-time description: The end time. type: string allowedActions: description: The state/actions applicable on this task. type: array items: type: string friendlyName: description: The name. type: string state: description: >- The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. type: string stateDescription: description: >- The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. type: string taskType: description: >- The type of task. Details in CustomDetails property depend on this type. type: string 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: description: The task error details. type: array items: $ref: '#/definitions/JobErrorDetails' AutomationRunbookTaskDetails: description: This class represents the task details for an automation runbook. type: object allOf: - $ref: '#/definitions/TaskTypeDetails' properties: name: description: The recovery plan task name. type: string cloudServiceName: description: The cloud service of the automation runbook account. type: string subscriptionId: description: The subscription Id of the automation runbook account. type: string accountName: description: The automation account name of the runbook. type: string runbookId: description: The runbook Id. type: string runbookName: description: The runbook name. type: string jobId: description: The job Id of the runbook execution. type: string jobOutput: description: The execution output of the runbook. type: string isPrimarySideScript: description: A value indicating whether it is a primary side script or not. type: boolean x-ms-discriminator-value: AutomationRunbookTaskDetails AzureFabricCreationInput: description: Fabric provider specific settings. type: object allOf: - $ref: '#/definitions/FabricSpecificCreationInput' properties: location: description: The Location. type: string x-ms-discriminator-value: Azure AzureFabricSpecificDetails: description: Azure Fabric Specific Details. type: object allOf: - $ref: '#/definitions/FabricSpecificDetails' properties: location: description: The Location for the Azure fabric. type: string containerIds: description: The container Ids for the Azure fabric. type: array items: type: string zones: description: The zones. type: array items: $ref: '#/definitions/A2AZoneDetails' extendedLocations: description: The ExtendedLocations. type: array items: $ref: '#/definitions/A2AExtendedLocationDetails' x-ms-identifiers: [] locationDetails: description: The location details. type: array items: $ref: '#/definitions/A2AFabricSpecificLocationDetails' x-ms-identifiers: [] x-ms-discriminator-value: Azure AzureToAzureCreateNetworkMappingInput: description: >- Create network mappings input properties/behavior specific to Azure to Azure Network mapping. required: - primaryNetworkId type: object allOf: - $ref: '#/definitions/FabricSpecificCreateNetworkMappingInput' properties: primaryNetworkId: description: The primary azure vnet Id. type: string x-ms-discriminator-value: AzureToAzure AzureToAzureNetworkMappingSettings: description: A2A Network Mapping fabric specific settings. type: object allOf: - $ref: '#/definitions/NetworkMappingFabricSpecificSettings' properties: primaryFabricLocation: description: The primary fabric location. type: string recoveryFabricLocation: description: The recovery fabric location. type: string x-ms-discriminator-value: AzureToAzure AzureToAzureUpdateNetworkMappingInput: description: Updates network mappings input. type: object allOf: - $ref: '#/definitions/FabricSpecificUpdateNetworkMappingInput' properties: primaryNetworkId: description: The primary azure vnet Id. type: string x-ms-discriminator-value: AzureToAzure AzureToAzureVmSyncedConfigDetails: description: Azure to Azure VM synced configuration details. type: object properties: tags: description: The Azure VM tags. type: object additionalProperties: type: string inputEndpoints: description: The Azure VM input endpoints. type: array items: $ref: '#/definitions/InputEndpoint' AzureVmDiskDetails: description: Disk details for E2A provider. type: object properties: vhdType: description: VHD type. type: string vhdId: description: The VHD id. type: string diskId: description: The disk resource id. type: string vhdName: description: VHD name. type: string maxSizeMB: description: Max side in MB. type: string targetDiskLocation: description: Blob uri of the Azure disk. type: string targetDiskName: description: The target Azure disk name. type: string lunId: description: Ordinal\LunId of the disk for the Azure VM. type: string diskEncryptionSetId: description: The DiskEncryptionSet ARM ID. type: string customTargetDiskName: description: The custom target Azure disk name. type: string ComputeSizeErrorDetails: description: >- Represents the error used to indicate why the target compute size is not applicable. type: object properties: message: description: The error message. type: string severity: description: The severity of the error. type: string ConfigurationSettings: description: Replication provider specific settings. required: - instanceType type: object properties: instanceType: description: Gets the class type. Overridden in derived classes. type: string discriminator: instanceType ConfigureAlertRequest: description: Request to configure alerts for the system. type: object properties: properties: $ref: '#/definitions/ConfigureAlertRequestProperties' description: The properties of a configure alert request. ConfigureAlertRequestProperties: description: Properties of a configure alert request. type: object properties: sendToOwners: description: >- A value indicating whether to send email to subscription administrator. type: string customEmailAddresses: description: The custom email address for sending emails. type: array items: type: string locale: description: The locale for the email notification. type: string ConsistencyCheckTaskDetails: description: >- This class contains monitoring details of all the inconsistent Protected Entities in Vmm. type: object allOf: - $ref: '#/definitions/TaskTypeDetails' properties: vmDetails: description: The list of inconsistent Vm details. type: array items: $ref: '#/definitions/InconsistentVmDetails' x-ms-discriminator-value: ConsistencyCheckTaskDetails CreateNetworkMappingInput: description: Create network mappings input. required: - properties type: object properties: properties: $ref: '#/definitions/CreateNetworkMappingInputProperties' description: Input properties for creating network mapping. CreateNetworkMappingInputProperties: description: Common input details for network mapping operation. required: - recoveryNetworkId type: object properties: recoveryFabricName: description: Recovery fabric Name. type: string recoveryNetworkId: description: Recovery network Id. type: string fabricSpecificDetails: $ref: '#/definitions/FabricSpecificCreateNetworkMappingInput' description: Fabric specific input properties. CreatePolicyInput: description: Protection Policy input. type: object properties: properties: $ref: '#/definitions/CreatePolicyInputProperties' description: Policy creation properties. CreatePolicyInputProperties: description: Policy creation properties. type: object properties: providerSpecificInput: $ref: '#/definitions/PolicyProviderSpecificInput' description: The ReplicationProviderSettings. CreateProtectionContainerInput: description: Create protection container input. type: object properties: properties: $ref: '#/definitions/CreateProtectionContainerInputProperties' description: Create protection container input properties. CreateProtectionContainerInputProperties: description: Create protection container input properties. type: object properties: providerSpecificInput: description: Provider specific inputs for container creation. type: array items: $ref: '#/definitions/ReplicationProviderSpecificContainerCreationInput' CreateProtectionContainerMappingInput: description: Configure pairing input. type: object properties: properties: $ref: '#/definitions/CreateProtectionContainerMappingInputProperties' description: Configure protection input properties. CreateProtectionContainerMappingInputProperties: description: Configure pairing input properties. type: object properties: targetProtectionContainerId: description: The target unique protection container name. type: string policyId: description: Applicable policy. type: string providerSpecificInput: $ref: '#/definitions/ReplicationProviderSpecificContainerMappingInput' description: Provider specific input for pairing. CreateProtectionIntentInput: description: Create protection intent input. type: object properties: properties: $ref: '#/definitions/CreateProtectionIntentProperties' description: Create protection intent input properties. CreateProtectionIntentProperties: description: Create protection intent input properties. type: object properties: providerSpecificDetails: $ref: '#/definitions/CreateProtectionIntentProviderSpecificDetails' description: >- The ReplicationProviderInput. For A2A provider, it will be A2ACreateProtectionIntentInput object. CreateProtectionIntentProviderSpecificDetails: description: Create protection intent provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType CreateRecoveryPlanInput: description: Create recovery plan input class. required: - properties type: object properties: properties: $ref: '#/definitions/CreateRecoveryPlanInputProperties' description: Recovery plan creation properties. CreateRecoveryPlanInputProperties: description: Recovery plan creation properties. required: - primaryFabricId - recoveryFabricId - groups type: object properties: primaryFabricId: description: The primary fabric Id. type: string recoveryFabricId: description: The recovery fabric Id. type: string failoverDeploymentModel: description: The failover deployment model. enum: - NotApplicable - Classic - ResourceManager type: string x-ms-enum: name: FailoverDeploymentModel modelAsString: true groups: description: The recovery plan groups. type: array items: $ref: '#/definitions/RecoveryPlanGroup' providerSpecificInput: description: The provider specific input. type: array items: $ref: '#/definitions/RecoveryPlanProviderSpecificInput' CriticalJobHistoryDetails: description: Critical past job details of the migration item. type: object properties: jobName: description: The job name. type: string readOnly: true jobId: description: The ARM Id of the job being executed. type: string readOnly: true startTime: format: date-time description: The start time of the job. type: string readOnly: true jobStatus: description: The job state. type: string readOnly: true CurrentJobDetails: description: Current job details of the migration item. type: object properties: jobName: description: The job name. type: string readOnly: true jobId: description: The ARM Id of the job being executed. type: string readOnly: true startTime: format: date-time description: The start time of the job. type: string readOnly: true CurrentScenarioDetails: description: Current scenario details of the protected entity. type: object properties: scenarioName: description: Scenario name. type: string jobId: description: ARM Id of the job being executed. type: string startTime: format: date-time description: Start time of the workflow. type: string DataStore: description: The datastore details of the MT. type: object properties: symbolicName: description: The symbolic name of data store. type: string uuid: description: The uuid of data store. type: string capacity: description: The capacity of data store in GBs. type: string freeSpace: description: The free space of data store in GBs. type: string type: description: The type of data store. type: string DataStoreUtilizationDetails: description: Details of the appliance resource. type: object properties: totalSnapshotsSupported: format: int64 description: The total count of snapshots supported by the datastore. type: integer readOnly: true totalSnapshotsCreated: format: int64 description: The total snapshots created for server migration in the datastore. type: integer readOnly: true dataStoreName: description: The datastore name. type: string readOnly: true DisableProtectionInput: description: Disable protection input. required: - properties type: object properties: properties: $ref: '#/definitions/DisableProtectionInputProperties' description: Disable protection input properties. DisableProtectionInputProperties: description: Disable protection input properties. type: object properties: disableProtectionReason: description: >- Disable protection reason. It can have values NotSpecified/MigrationComplete. enum: - NotSpecified - MigrationComplete type: string x-ms-enum: name: DisableProtectionReason modelAsString: true replicationProviderInput: $ref: '#/definitions/DisableProtectionProviderSpecificInput' description: Replication provider specific input. DisableProtectionProviderSpecificInput: description: Disable protection provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType DiscoverProtectableItemRequest: description: Request to add a physical machine as a protectable item in a container. type: object properties: properties: $ref: '#/definitions/DiscoverProtectableItemRequestProperties' description: The properties of a discover protectable item request. DiscoverProtectableItemRequestProperties: description: Discover protectable item properties. type: object properties: friendlyName: description: The friendly name of the physical machine. type: string ipAddress: description: The IP address of the physical machine to be discovered. type: string osType: description: The OS type on the physical machine. type: string DiskDetails: description: Onprem disk details data. type: object properties: maxSizeMB: format: int64 description: The hard disk max size in MB. type: integer vhdType: description: The type of the volume. type: string vhdId: description: The VHD Id. type: string vhdName: description: The VHD name. type: string DiskEncryptionInfo: description: Recovery disk encryption info (BEK and KEK). type: object properties: diskEncryptionKeyInfo: $ref: '#/definitions/DiskEncryptionKeyInfo' description: The recovery KeyVault reference for secret. keyEncryptionKeyInfo: $ref: '#/definitions/KeyEncryptionKeyInfo' description: The recovery KeyVault reference for key. DiskEncryptionKeyInfo: description: >- Disk Encryption Key Information (BitLocker Encryption Key (BEK) on Windows). type: object properties: secretIdentifier: description: The secret url / identifier. type: string keyVaultResourceArmId: description: The KeyVault resource ARM id for secret. type: string DiskVolumeDetails: description: Volume details. type: object properties: label: description: The volume label. type: string name: description: The volume name. type: string Display: 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. type: object properties: provider: 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.". type: string resource: 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". type: string operation: 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'. type: string description: 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'. type: string DraDetails: description: DRA details. type: object properties: id: description: The DRA Id. type: string readOnly: true name: description: The DRA name. type: string readOnly: true biosId: description: The DRA Bios Id. type: string readOnly: true version: description: The version. type: string readOnly: true lastHeartbeatUtc: format: date-time description: The last heartbeat received from the DRA. type: string readOnly: true health: description: The health. enum: - None - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: ProtectionHealth modelAsString: true healthErrors: description: The health errors. type: array items: $ref: '#/definitions/HealthError' readOnly: true forwardProtectedItemCount: format: int32 description: The count of protected items which are protected in forward direction. type: integer readOnly: true reverseProtectedItemCount: format: int32 description: The count of protected items which are protected in reverse direction. type: integer readOnly: true EnableMigrationInput: description: Enable migration input. required: - properties type: object properties: properties: $ref: '#/definitions/EnableMigrationInputProperties' description: Enable migration input properties. EnableMigrationInputProperties: description: Enable migration input properties. required: - policyId - providerSpecificDetails type: object properties: policyId: description: The policy Id. type: string providerSpecificDetails: $ref: '#/definitions/EnableMigrationProviderSpecificInput' description: The provider specific details. EnableMigrationProviderSpecificInput: description: Enable migration provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType EnableProtectionInput: description: Enable protection input. type: object properties: properties: $ref: '#/definitions/EnableProtectionInputProperties' description: Enable protection input properties. EnableProtectionInputProperties: description: Enable protection input properties. type: object properties: policyId: description: The Policy Id. type: string protectableItemId: description: The protectable item Id. type: string 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: description: Enable protection provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType EncryptionDetails: description: Encryption details for the fabric. type: object properties: kekState: description: The key encryption key state for the Vmm. type: string kekCertThumbprint: description: The key encryption key certificate thumbprint. type: string kekCertExpiryDate: format: date-time description: The key encryption key certificate expiry date. type: string Event: description: Implements the Event class. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/EventProperties' description: Event related data. EventCollection: description: Collection of fabric details. type: object properties: value: description: The list of events. type: array items: $ref: '#/definitions/Event' nextLink: description: The value of next link. type: string EventProperties: description: The properties of a monitoring event. type: object properties: eventCode: description: The Id of the monitoring event. type: string description: description: The event name. type: string eventType: description: >- The type of the event. for example: VM Health, Server Health, Job Failure etc. type: string affectedObjectFriendlyName: description: >- The friendly name of the source of the event on which it is raised (for example, VM, VMM etc). type: string affectedObjectCorrelationId: description: The affected object correlationId for the event. type: string severity: description: The severity of the event. type: string timeOfOccurrence: format: date-time description: The time of occurrence of the event. type: string fabricId: description: The ARM ID of the fabric. type: string providerSpecificDetails: $ref: '#/definitions/EventProviderSpecificDetails' description: The provider specific settings. eventSpecificDetails: $ref: '#/definitions/EventSpecificDetails' description: The event specific settings. healthErrors: description: >- The list of errors / warnings capturing details associated with the issue(s). type: array items: $ref: '#/definitions/HealthError' EventProviderSpecificDetails: description: Model class for provider specific details for an event. required: - instanceType type: object properties: instanceType: description: Gets the class type. Overridden in derived classes. type: string discriminator: instanceType EventQueryParameter: description: Implements the event query parameter. type: object properties: eventCode: description: The source id of the events to be queried. type: string severity: description: The severity of the events to be queried. type: string eventType: description: The type of the events to be queried. type: string fabricName: description: The affected object server id of the events to be queried. type: string affectedObjectFriendlyName: description: The affected object name of the events to be queried. type: string affectedObjectCorrelationId: description: The affected object correlationId for the events to be queried. type: string startTime: format: date-time description: >- The start time of the time range within which the events are to be queried. type: string endTime: format: date-time description: >- The end time of the time range within which the events are to be queried. type: string EventSpecificDetails: description: Model class for event specific details for an event. required: - instanceType type: object properties: instanceType: description: Gets the class type. Overridden in derived classes. type: string discriminator: instanceType ExistingProtectionProfile: description: Existing storage account input. required: - protectionProfileId type: object allOf: - $ref: '#/definitions/ProtectionProfileCustomDetails' properties: protectionProfileId: description: >- The protection profile Arm Id. Throw error, if resource does not exists. type: string x-ms-discriminator-value: Existing ExistingRecoveryAvailabilitySet: description: Existing recovery availability set input. type: object allOf: - $ref: '#/definitions/RecoveryAvailabilitySetCustomDetails' properties: recoveryAvailabilitySetId: description: >- The recovery availability set Id. Will throw error, if resource does not exist. type: string x-ms-discriminator-value: Existing ExistingRecoveryProximityPlacementGroup: description: Existing recovery proximity placement group input. type: object allOf: - $ref: '#/definitions/RecoveryProximityPlacementGroupCustomDetails' properties: recoveryProximityPlacementGroupId: description: >- The recovery proximity placement group Id. Will throw error, if resource does not exist. type: string x-ms-discriminator-value: Existing ExistingRecoveryRecoveryResourceGroup: description: Existing recovery resource group input. type: object allOf: - $ref: '#/definitions/RecoveryResourceGroupCustomDetails' properties: recoveryResourceGroupId: description: The recovery resource group Id. Valid for V2 scenarios. type: string x-ms-discriminator-value: Existing ExistingRecoveryVirtualNetwork: description: Existing recovery virtual network input. required: - recoveryVirtualNetworkId type: object allOf: - $ref: '#/definitions/RecoveryVirtualNetworkCustomDetails' properties: recoveryVirtualNetworkId: description: >- The recovery virtual network Id. Will throw error, if resource does not exist. type: string recoverySubnetName: description: The recovery subnet name. type: string x-ms-discriminator-value: Existing ExistingStorageAccount: description: Existing storage account input. required: - azureStorageAccountId type: object allOf: - $ref: '#/definitions/StorageAccountCustomDetails' properties: azureStorageAccountId: description: The storage account Arm Id. Throw error, if resource does not exists. type: string x-ms-discriminator-value: Existing ExportJobDetails: description: This class represents details for export jobs workflow. type: object allOf: - $ref: '#/definitions/JobDetails' properties: blobUri: description: BlobUri of the exported jobs. type: string sasToken: description: The sas token to access blob. type: string x-ms-discriminator-value: ExportJobDetails ExtendedLocation: description: Extended location of the resource. required: - name - type type: object properties: name: description: The name of the extended location. type: string type: description: The extended location type. enum: - EdgeZone type: string x-ms-enum: name: ExtendedLocationType modelAsString: true Fabric: description: Fabric definition. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/FabricProperties' description: Fabric related data. FabricCollection: description: Collection of fabric details. type: object properties: value: description: The fabric details. type: array items: $ref: '#/definitions/Fabric' nextLink: description: The value of next link. type: string FabricCreationInput: description: Site details provided during the time of site creation. type: object properties: properties: $ref: '#/definitions/FabricCreationInputProperties' description: Fabric creation input. FabricCreationInputProperties: description: Properties of site details provided during the time of site creation. type: object properties: customDetails: $ref: '#/definitions/FabricSpecificCreationInput' description: Fabric provider specific creation input. FabricProperties: description: Fabric properties. type: object properties: friendlyName: description: Friendly name of the fabric. type: string encryptionDetails: $ref: '#/definitions/EncryptionDetails' description: Encryption details for the fabric. rolloverEncryptionDetails: $ref: '#/definitions/EncryptionDetails' description: Rollover encryption details for the fabric. internalIdentifier: description: Dra Registration Id. type: string bcdrState: description: BCDR state of the fabric. type: string customDetails: $ref: '#/definitions/FabricSpecificDetails' description: Fabric specific settings. healthErrorDetails: description: Fabric health error details. type: array items: $ref: '#/definitions/HealthError' health: description: Health of fabric. type: string FabricQueryParameter: description: Query parameter to get fabric. type: object properties: zoneToZoneMappings: description: >- A value indicating whether the zone to zone mappings are to be returned. type: string extendedLocationMappings: description: >- A value indicating whether the Extended Location mappings are to be returned. type: string locationDetails: description: A value indicating whether the location details are to be returned. type: string fetchAgentDetails: description: A value indicating whether the agent details are to be fetched. type: string biosId: description: The BIOS Id to be used for fetching agent details. type: string fqdn: description: The FQDN to be used for fetching agent details. type: string discoveryType: description: >- The type of the discovered machine to be used for fetching agent details. type: string osType: description: The OS type to be used for fetching agent details. type: string FabricReplicationGroupTaskDetails: description: This class represents the fabric replication group task details. type: object allOf: - $ref: '#/definitions/JobTaskDetails' properties: skippedReason: description: The skipped reason. type: string skippedReasonString: description: The skipped reason string. type: string x-ms-discriminator-value: FabricReplicationGroupTaskDetails FabricSpecificCreateNetworkMappingInput: description: Input details specific to fabrics during Network Mapping. required: - instanceType type: object properties: instanceType: description: The instance type. type: string discriminator: instanceType FabricSpecificCreationInput: description: Fabric provider specific settings. required: - instanceType type: object properties: instanceType: description: Gets the class type. type: string discriminator: instanceType FabricSpecificDetails: description: Fabric specific details. required: - instanceType type: object properties: instanceType: description: Gets the class type. Overridden in derived classes. type: string discriminator: instanceType FabricSpecificUpdateNetworkMappingInput: description: Input details specific to fabrics during Network Mapping. required: - instanceType type: object properties: instanceType: description: The instance type. type: string discriminator: instanceType FailoverJobDetails: description: This class represents the details for a failover job. type: object allOf: - $ref: '#/definitions/JobDetails' properties: protectedItemDetails: description: The test VM details. type: array items: $ref: '#/definitions/FailoverReplicationProtectedItemDetails' x-ms-discriminator-value: FailoverJobDetails FailoverProcessServerRequest: description: Request to failover a process server. type: object properties: properties: $ref: '#/definitions/FailoverProcessServerRequestProperties' description: The properties of the PS Failover request. FailoverProcessServerRequestProperties: description: The properties of the Failover Process Server request. type: object properties: containerName: description: The container identifier. type: string sourceProcessServerId: description: The source process server. type: string targetProcessServerId: description: The new process server. type: string vmsToMigrate: description: The VMS to migrate. type: array items: type: string updateType: description: A value for failover type. It can be systemlevel/serverlevel. type: string FailoverReplicationProtectedItemDetails: description: Failover details for a replication protected item. type: object properties: name: description: The name. type: string friendlyName: description: The friendly name. type: string testVmName: description: The test Vm name. type: string testVmFriendlyName: description: The test Vm friendly name. type: string networkConnectionStatus: description: The network connection status. type: string networkFriendlyName: description: The network friendly name. type: string subnet: description: The network subnet. type: string recoveryPointId: description: The recovery point Id. type: string recoveryPointTime: format: date-time description: The recovery point time. type: string GatewayOperationDetails: description: Details of the gateway operation. type: object properties: state: description: A value indicating the state of gateway operation. type: string readOnly: true progressPercentage: format: int32 description: A value indicating the progress percentage of gateway operation. type: integer readOnly: true timeElapsed: format: int64 description: A value indicating the time elapsed for the operation in milliseconds. type: integer readOnly: true timeRemaining: format: int64 description: >- A value indicating the time remaining for the operation in milliseconds. type: integer readOnly: true uploadSpeed: format: int64 description: A value indicating the upload speed in bytes per second. type: integer readOnly: true hostName: description: A value indicating the ESXi host name. type: string readOnly: true dataStores: description: A value indicating the datastore collection. type: array items: type: string readOnly: true vmwareReadThroughput: format: int64 description: A value indicating the VMware read throughput in bytes per second. type: integer readOnly: true GroupTaskDetails: description: >- This class represents the group task details when parent child relationship exists in the drill down. required: - instanceType type: object properties: instanceType: description: The type of task details. type: string childTasks: description: The child tasks. type: array items: $ref: '#/definitions/ASRTask' discriminator: instanceType HealthError: description: Health Error. type: object properties: innerHealthErrors: 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. type: array items: $ref: '#/definitions/InnerHealthError' errorSource: description: Source of error. type: string errorType: description: Type of error. type: string errorLevel: description: Level of error. type: string errorCategory: description: Category of error. type: string errorCode: description: Error code. type: string summaryMessage: description: Summary message of the entity. type: string errorMessage: description: Error message. type: string possibleCauses: description: Possible causes of error. type: string recommendedAction: description: Recommended action to resolve error. type: string creationTimeUtc: format: date-time description: Error creation time (UTC). type: string recoveryProviderErrorMessage: description: DRA error message. type: string entityId: description: ID of the entity. type: string errorId: description: The health error unique id. type: string customerResolvability: description: Value indicating whether the health error is customer resolvable. enum: - Allowed - NotAllowed type: string x-ms-enum: name: HealthErrorCustomerResolvability modelAsString: true HealthErrorSummary: description: class to define the summary of the health error details. type: object properties: summaryCode: description: The code of the health error. type: string category: description: The category of the health error. enum: - None - Replication - TestFailover - Configuration - FabricInfrastructure - VersionExpiry - AgentAutoUpdateInfra - AgentAutoUpdateArtifactDeleted - AgentAutoUpdateRunAsAccount - AgentAutoUpdateRunAsAccountExpiry - AgentAutoUpdateRunAsAccountExpired type: string x-ms-enum: name: HealthErrorCategory modelAsString: true severity: description: Severity of error. enum: - NONE - Warning - Error - Info type: string x-ms-enum: name: Severity modelAsString: true summaryMessage: description: The summary message of the health error. type: string affectedResourceType: description: The type of affected ARM resource. type: string affectedResourceSubtype: description: >- The sub type of any subcomponent within the ARM resource that this might be applicable. Value remains null if not applicable. type: string affectedResourceCorrelationIds: 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. type: array items: type: string HyperVHostDetails: description: Hyper-V host details. type: object properties: id: description: The Hyper-V host Id. type: string readOnly: true name: description: The Hyper-V host name. type: string readOnly: true marsAgentVersion: description: The Mars agent version. type: string readOnly: true HyperVReplica2012EventDetails: description: Model class for event details of a HyperVReplica E2E event. type: object allOf: - $ref: '#/definitions/EventProviderSpecificDetails' properties: containerName: description: The container friendly name. type: string fabricName: description: The fabric friendly name. type: string remoteContainerName: description: The remote container name. type: string remoteFabricName: description: The remote fabric name. type: string x-ms-discriminator-value: HyperVReplica2012 HyperVReplica2012R2EventDetails: description: Model class for event details of a HyperVReplica blue E2E event. type: object allOf: - $ref: '#/definitions/EventProviderSpecificDetails' properties: containerName: description: The container friendly name. type: string fabricName: description: The fabric friendly name. type: string remoteContainerName: description: The remote container name. type: string remoteFabricName: description: The remote fabric name. type: string x-ms-discriminator-value: HyperVReplica2012R2 HyperVReplicaAzureApplyRecoveryPointInput: description: ApplyRecoveryPoint input specific to HyperVReplicaAzure provider. required: - instanceType type: object allOf: - $ref: '#/definitions/ApplyRecoveryPointProviderSpecificInput' properties: primaryKekCertificatePfx: description: The primary kek certificate pfx. type: string secondaryKekCertificatePfx: description: The secondary kek certificate pfx. type: string x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaAzureDiskInputDetails: description: Disk input details. type: object properties: diskId: description: The DiskId. type: string logStorageAccountId: description: The LogStorageAccountId. type: string diskType: description: The DiskType. enum: - Standard_LRS - Premium_LRS - StandardSSD_LRS type: string x-ms-enum: name: DiskAccountType modelAsString: true diskEncryptionSetId: description: The DiskEncryptionSet ARM ID. type: string HyperVReplicaAzureEnableProtectionInput: description: HyperVReplicaAzure specific enable protection input. type: object allOf: - $ref: '#/definitions/EnableProtectionProviderSpecificInput' properties: hvHostVmId: description: The Hyper-V host VM Id. type: string vmName: description: The VM Name. type: string osType: description: The OS type associated with VM. type: string vhdId: description: The OS disk VHD id associated with VM. type: string targetStorageAccountId: description: The storage account Id. type: string targetAzureNetworkId: description: The selected target Azure network Id. type: string targetAzureSubnetId: description: The selected target Azure subnet Id. type: string enableRdpOnTargetOption: description: >- The selected option to enable RDP\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum. type: string targetAzureVmName: description: The target azure VM Name. type: string logStorageAccountId: description: The storage account to be used for logging during replication. type: string disksToInclude: description: The list of VHD Ids of disks to be protected. type: array items: type: string targetAzureV1ResourceGroupId: description: >- The Id of the target resource group (for classic deployment) in which the failover VM is to be created. type: string targetAzureV2ResourceGroupId: description: >- The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created. type: string useManagedDisks: description: >- A value indicating whether managed disks should be used during failover. type: string targetAvailabilitySetId: description: The target availability set ARM Id for resource manager deployment. type: string targetAvailabilityZone: description: The target availability zone. type: string licenseType: description: License type. enum: - NotSpecified - NoLicenseType - WindowsServer type: string x-ms-enum: name: LicenseType modelAsString: true sqlServerLicenseType: description: The SQL Server license type. enum: - NotSpecified - NoLicenseType - PAYG - AHUB type: string x-ms-enum: name: SqlServerLicenseType modelAsString: true targetVmSize: description: The target VM size. type: string targetProximityPlacementGroupId: description: The proximity placement group ARM Id. type: string useManagedDisksForReplication: description: >- A value indicating whether managed disks should be used during replication. type: string diskType: description: The DiskType. enum: - Standard_LRS - Premium_LRS - StandardSSD_LRS type: string x-ms-enum: name: DiskAccountType modelAsString: true disksToIncludeForManagedDisks: description: The disks to include list for managed disks. type: array items: $ref: '#/definitions/HyperVReplicaAzureDiskInputDetails' diskEncryptionSetId: description: The DiskEncryptionSet ARM Id. type: string targetVmTags: description: The target VM tags. maxLength: 50 type: object additionalProperties: type: string seedManagedDiskTags: description: The tags for the seed managed disks. maxLength: 49 type: object additionalProperties: type: string targetManagedDiskTags: description: The tags for the target managed disks. maxLength: 49 type: object additionalProperties: type: string targetNicTags: description: The tags for the target NICs. maxLength: 50 type: object additionalProperties: type: string x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaAzureEventDetails: description: Model class for event details of a HyperVReplica E2A event. type: object allOf: - $ref: '#/definitions/EventProviderSpecificDetails' properties: containerName: description: The container friendly name. type: string fabricName: description: The fabric friendly name. type: string remoteContainerName: description: The remote container name. type: string x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaAzureFailbackProviderInput: description: HyperVReplicaAzureFailback specific planned failover input. type: object allOf: - $ref: '#/definitions/PlannedFailoverProviderSpecificFailoverInput' properties: dataSyncOption: description: Data sync option. type: string recoveryVmCreationOption: description: ALR options to create alternate recovery. type: string providerIdForAlternateRecovery: description: Provider Id for alternate location. type: string x-ms-discriminator-value: HyperVReplicaAzureFailback HyperVReplicaAzureManagedDiskDetails: description: Hyper-V Managed disk details. type: object properties: diskId: description: The disk Id. type: string seedManagedDiskId: description: Seed managed disk Id. type: string replicaDiskType: description: The replica disk type. type: string diskEncryptionSetId: description: The disk encryption set ARM Id. type: string HyperVReplicaAzurePlannedFailoverProviderInput: description: HyperVReplicaAzure specific planned failover input. type: object allOf: - $ref: '#/definitions/PlannedFailoverProviderSpecificFailoverInput' properties: primaryKekCertificatePfx: description: Primary kek certificate pfx. type: string secondaryKekCertificatePfx: description: Secondary kek certificate pfx. type: string recoveryPointId: 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. type: string osUpgradeVersion: description: A value indicating the inplace OS Upgrade version. type: string x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaAzurePolicyDetails: description: Hyper-V Replica Azure specific protection profile details. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: recoveryPointHistoryDurationInHours: format: int32 description: >- The duration (in hours) to which point the recovery history needs to be maintained. type: integer applicationConsistentSnapshotFrequencyInHours: format: int32 description: >- The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM. type: integer replicationInterval: format: int32 description: The replication interval. type: integer onlineReplicationStartTime: description: >- The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately. type: string encryption: description: >- A value indicating whether encryption is enabled for virtual machines in this cloud. type: string activeStorageAccountId: description: The active storage account Id. type: string x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaAzurePolicyInput: description: Hyper-V Replica Azure specific input for creating a protection profile. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificInput' properties: recoveryPointHistoryDuration: format: int32 description: >- The duration (in hours) to which point the recovery history needs to be maintained. type: integer applicationConsistentSnapshotFrequencyInHours: format: int32 description: >- The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM. type: integer replicationInterval: format: int32 description: The replication interval. type: integer onlineReplicationStartTime: description: >- The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately. type: string storageAccounts: description: >- The list of storage accounts to which the VMs in the primary cloud can replicate to. type: array items: type: string x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaAzureReplicationDetails: description: Hyper V Replica Azure provider specific settings. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificSettings' properties: azureVmDiskDetails: description: Azure VM Disk details. type: array items: $ref: '#/definitions/AzureVmDiskDetails' recoveryAzureVmName: description: Recovery Azure given name. type: string recoveryAzureVMSize: description: The Recovery Azure VM size. type: string recoveryAzureStorageAccount: description: The recovery Azure storage account. type: string recoveryAzureLogStorageAccountId: 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. type: string lastReplicatedTime: format: date-time description: The Last replication time. type: string rpoInSeconds: format: int64 description: Last RPO value. type: integer lastRpoCalculatedTime: format: date-time description: The last RPO calculated time. type: string vmId: description: The virtual machine Id. type: string vmProtectionState: description: The protection state for the vm. type: string vmProtectionStateDescription: description: The protection state description for the vm. type: string initialReplicationDetails: $ref: '#/definitions/InitialReplicationDetails' description: Initial replication details. vmNics: description: The PE Network details. type: array items: $ref: '#/definitions/VMNicDetails' selectedRecoveryAzureNetworkId: description: The selected recovery azure network Id. type: string selectedSourceNicId: description: >- The selected source nic Id which will be used as the primary nic during failover. type: string encryption: description: The encryption info. type: string oSDetails: $ref: '#/definitions/OSDetails' description: The operating system info. sourceVmRamSizeInMB: format: int32 description: The RAM size of the VM on the primary side. type: integer sourceVmCpuCount: format: int32 description: The CPU count of the VM on the primary side. type: integer enableRdpOnTargetOption: description: >- The selected option to enable RDP\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum. type: string recoveryAzureResourceGroupId: description: The target resource group Id. type: string recoveryAvailabilitySetId: description: The recovery availability set Id. type: string targetAvailabilityZone: description: The target availability zone. type: string targetProximityPlacementGroupId: description: The target proximity placement group Id. type: string useManagedDisks: description: >- A value indicating whether managed disks should be used during failover. type: string licenseType: description: License Type of the VM to be used. type: string sqlServerLicenseType: description: The SQL Server license type. type: string lastRecoveryPointReceived: format: date-time description: The last recovery point received time. type: string readOnly: true targetVmTags: description: The target VM tags. type: object additionalProperties: type: string seedManagedDiskTags: description: The tags for the seed managed disks. type: object additionalProperties: type: string targetManagedDiskTags: description: The tags for the target managed disks. type: object additionalProperties: type: string targetNicTags: description: The tags for the target NICs. type: object additionalProperties: type: string protectedManagedDisks: description: The list of protected managed disks. type: array items: $ref: '#/definitions/HyperVReplicaAzureManagedDiskDetails' x-ms-identifiers: [] allAvailableOSUpgradeConfigurations: description: A value indicating all available inplace OS Upgrade configurations. type: array items: $ref: '#/definitions/OSUpgradeSupportedVersions' x-ms-identifiers: [] x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaAzureReprotectInput: description: Azure specific reprotect input. type: object allOf: - $ref: '#/definitions/ReverseReplicationProviderSpecificInput' properties: hvHostVmId: description: The Hyper-V host Vm Id. type: string vmName: description: The Vm Name. type: string osType: description: The OS type associated with vm. type: string vHDId: description: The OS disk VHD id associated with vm. type: string storageAccountId: description: The storage account name. type: string logStorageAccountId: description: The storage account to be used for logging during replication. type: string x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaAzureTestFailoverInput: description: HvrA provider specific input for test failover. type: object allOf: - $ref: '#/definitions/TestFailoverProviderSpecificInput' properties: primaryKekCertificatePfx: description: Primary kek certificate pfx. type: string secondaryKekCertificatePfx: description: Secondary kek certificate pfx. type: string recoveryPointId: 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. type: string osUpgradeVersion: description: A value indicating the inplace OS Upgrade version. type: string x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaAzureUnplannedFailoverInput: description: HvrA provider specific input for unplanned failover. type: object allOf: - $ref: '#/definitions/UnplannedFailoverProviderSpecificInput' properties: primaryKekCertificatePfx: description: Primary kek certificate pfx. type: string secondaryKekCertificatePfx: description: Secondary kek certificate pfx. type: string recoveryPointId: 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. type: string x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaAzureUpdateReplicationProtectedItemInput: description: HyperV replica Azure input to update replication protected item. type: object allOf: - $ref: '#/definitions/UpdateReplicationProtectedItemProviderInput' properties: recoveryAzureV1ResourceGroupId: description: The recovery Azure resource group Id for classic deployment. type: string recoveryAzureV2ResourceGroupId: description: The recovery Azure resource group Id for resource manager deployment. type: string useManagedDisks: description: >- A value indicating whether managed disks should be used during failover. type: string diskIdToDiskEncryptionMap: description: The dictionary of disk resource Id to disk encryption set ARM Id. type: object additionalProperties: type: string targetProximityPlacementGroupId: description: The target proximity placement group Id. type: string targetAvailabilityZone: description: The target availability zone. type: string targetVmTags: description: The target VM tags. maxLength: 50 type: object additionalProperties: type: string targetManagedDiskTags: description: The tags for the target managed disks. maxLength: 49 type: object additionalProperties: type: string targetNicTags: description: The tags for the target NICs. maxLength: 50 type: object additionalProperties: type: string sqlServerLicenseType: description: The SQL Server license type. enum: - NotSpecified - NoLicenseType - PAYG - AHUB type: string x-ms-enum: name: SqlServerLicenseType modelAsString: true vmDisks: description: The list of disk update properties. type: array items: $ref: '#/definitions/UpdateDiskInput' x-ms-discriminator-value: HyperVReplicaAzure HyperVReplicaBaseEventDetails: description: Abstract model class for event details of a HyperVReplica E2E event. type: object allOf: - $ref: '#/definitions/EventProviderSpecificDetails' properties: containerName: description: The container friendly name. type: string fabricName: description: The fabric friendly name. type: string remoteContainerName: description: The remote container name. type: string remoteFabricName: description: The remote fabric name. type: string x-ms-discriminator-value: HyperVReplicaBaseEventDetails HyperVReplicaBasePolicyDetails: description: Base class for HyperVReplica policy details. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: recoveryPoints: format: int32 description: A value indicating the number of recovery points. type: integer applicationConsistentSnapshotFrequencyInHours: format: int32 description: A value indicating the application consistent frequency. type: integer compression: description: A value indicating whether compression has to be enabled. type: string initialReplicationMethod: description: A value indicating whether IR is online. type: string onlineReplicationStartTime: description: A value indicating the online IR start time. type: string offlineReplicationImportPath: description: A value indicating the offline IR import path. type: string offlineReplicationExportPath: description: A value indicating the offline IR export path. type: string replicationPort: format: int32 description: A value indicating the recovery HTTPS port. type: integer allowedAuthenticationType: format: int32 description: A value indicating the authentication type. type: integer replicaDeletionOption: description: >- A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud. type: string x-ms-discriminator-value: HyperVReplicaBasePolicyDetails HyperVReplicaBaseReplicationDetails: description: Hyper V replica provider specific settings base class. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificSettings' properties: lastReplicatedTime: format: date-time description: The Last replication time. type: string vmNics: description: The PE Network details. type: array items: $ref: '#/definitions/VMNicDetails' vmId: description: The virtual machine Id. type: string vmProtectionState: description: The protection state for the vm. type: string vmProtectionStateDescription: description: The protection state description for the vm. type: string initialReplicationDetails: $ref: '#/definitions/InitialReplicationDetails' description: Initial replication details. vMDiskDetails: description: VM disk details. type: array items: $ref: '#/definitions/DiskDetails' x-ms-discriminator-value: HyperVReplicaBaseReplicationDetails HyperVReplicaBluePolicyDetails: description: Hyper-V Replica Blue specific protection profile details. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: replicationFrequencyInSeconds: format: int32 description: A value indicating the replication interval. type: integer recoveryPoints: format: int32 description: A value indicating the number of recovery points. type: integer applicationConsistentSnapshotFrequencyInHours: format: int32 description: A value indicating the application consistent frequency. type: integer compression: description: A value indicating whether compression has to be enabled. type: string initialReplicationMethod: description: A value indicating whether IR is online. type: string onlineReplicationStartTime: description: A value indicating the online IR start time. type: string offlineReplicationImportPath: description: A value indicating the offline IR import path. type: string offlineReplicationExportPath: description: A value indicating the offline IR export path. type: string replicationPort: format: int32 description: A value indicating the recovery HTTPS port. type: integer allowedAuthenticationType: format: int32 description: A value indicating the authentication type. type: integer replicaDeletionOption: description: >- A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud type: string x-ms-discriminator-value: HyperVReplica2012R2 HyperVReplicaBluePolicyInput: description: HyperV Replica Blue policy input. type: object allOf: - $ref: '#/definitions/HyperVReplicaPolicyInput' properties: replicationFrequencyInSeconds: format: int32 description: A value indicating the replication interval. type: integer x-ms-discriminator-value: HyperVReplica2012R2 HyperVReplicaBlueReplicationDetails: description: HyperV replica 2012 R2 (Blue) replication details. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificSettings' properties: lastReplicatedTime: format: date-time description: The Last replication time. type: string vmNics: description: The PE Network details. type: array items: $ref: '#/definitions/VMNicDetails' vmId: description: The virtual machine Id. type: string vmProtectionState: description: The protection state for the vm. type: string vmProtectionStateDescription: description: The protection state description for the vm. type: string initialReplicationDetails: $ref: '#/definitions/InitialReplicationDetails' description: Initial replication details. vMDiskDetails: description: VM disk details. type: array items: $ref: '#/definitions/DiskDetails' x-ms-discriminator-value: HyperVReplica2012R2 HyperVReplicaPolicyDetails: description: Hyper-V Replica Blue specific protection profile details. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: recoveryPoints: format: int32 description: A value indicating the number of recovery points. type: integer applicationConsistentSnapshotFrequencyInHours: format: int32 description: A value indicating the application consistent frequency. type: integer compression: description: A value indicating whether compression has to be enabled. type: string initialReplicationMethod: description: A value indicating whether IR is online. type: string onlineReplicationStartTime: description: A value indicating the online IR start time. type: string offlineReplicationImportPath: description: A value indicating the offline IR import path. type: string offlineReplicationExportPath: description: A value indicating the offline IR export path. type: string replicationPort: format: int32 description: A value indicating the recovery HTTPS port. type: integer allowedAuthenticationType: format: int32 description: A value indicating the authentication type. type: integer replicaDeletionOption: description: >- A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud type: string x-ms-discriminator-value: HyperVReplica2012 HyperVReplicaPolicyInput: description: Hyper-V Replica specific policy Input. required: - instanceType type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificInput' properties: recoveryPoints: format: int32 description: A value indicating the number of recovery points. type: integer applicationConsistentSnapshotFrequencyInHours: format: int32 description: A value indicating the application consistent frequency. type: integer compression: description: A value indicating whether compression has to be enabled. type: string initialReplicationMethod: description: A value indicating whether IR is online. type: string onlineReplicationStartTime: description: A value indicating the online IR start time. type: string offlineReplicationImportPath: description: A value indicating the offline IR import path. type: string offlineReplicationExportPath: description: A value indicating the offline IR export path. type: string replicationPort: format: int32 description: A value indicating the recovery HTTPS port. type: integer allowedAuthenticationType: format: int32 description: A value indicating the authentication type. type: integer replicaDeletion: description: A value indicating whether the VM has to be auto deleted. type: string discriminator: instanceType x-ms-discriminator-value: HyperVReplica2012 HyperVReplicaReplicationDetails: description: HyperV replica 2012 replication details. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificSettings' properties: lastReplicatedTime: format: date-time description: The Last replication time. type: string vmNics: description: The PE Network details. type: array items: $ref: '#/definitions/VMNicDetails' vmId: description: The virtual machine Id. type: string vmProtectionState: description: The protection state for the vm. type: string vmProtectionStateDescription: description: The protection state description for the vm. type: string initialReplicationDetails: $ref: '#/definitions/InitialReplicationDetails' description: Initial replication details. vMDiskDetails: description: VM disk details. type: array items: $ref: '#/definitions/DiskDetails' x-ms-discriminator-value: HyperVReplica2012 HyperVSiteDetails: description: HyperVSite fabric specific details. type: object allOf: - $ref: '#/definitions/FabricSpecificDetails' properties: hyperVHosts: description: The list of Hyper-V hosts associated with the fabric. type: array items: $ref: '#/definitions/HyperVHostDetails' x-ms-discriminator-value: HyperVSite HyperVVirtualMachineDetails: description: Single Host fabric provider specific VM settings. required: - instanceType type: object allOf: - $ref: '#/definitions/ConfigurationSettings' properties: sourceItemId: description: The source id of the object. type: string generation: description: The id of the object in fabric. type: string osDetails: $ref: '#/definitions/OSDetails' description: The Last replication time. diskDetails: description: The Last successful failover time. type: array items: $ref: '#/definitions/DiskDetails' hasPhysicalDisk: description: >- A value indicating whether the VM has a physical disk attached. String value of SrsDataContract.PresenceStatus enum. enum: - Unknown - Present - NotPresent type: string x-ms-enum: name: PresenceStatus modelAsString: true hasFibreChannelAdapter: description: >- A value indicating whether the VM has a fibre channel adapter attached. String value of SrsDataContract.PresenceStatus enum. enum: - Unknown - Present - NotPresent type: string x-ms-enum: name: PresenceStatus modelAsString: true hasSharedVhd: description: >- A value indicating whether the VM has a shared VHD attached. String value of SrsDataContract.PresenceStatus enum. enum: - Unknown - Present - NotPresent type: string x-ms-enum: name: PresenceStatus modelAsString: true hyperVHostId: description: The Id of the hyper-v host in fabric. type: string discriminator: instanceType x-ms-discriminator-value: HyperVVirtualMachine IdentityProviderDetails: description: Identity provider details. type: object properties: tenantId: description: >- The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. type: string applicationId: description: >- The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. type: string objectId: description: >- The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. type: string audience: description: >- The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. type: string aadAuthority: description: The base authority for Azure Active Directory authentication. type: string IdentityProviderInput: description: Identity provider input. required: - tenantId - applicationId - objectId - audience - aadAuthority type: object properties: tenantId: description: >- The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. type: string applicationId: description: >- The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. type: string objectId: description: >- The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. type: string audience: description: >- The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. type: string aadAuthority: description: The base authority for Azure Active Directory authentication. type: string InconsistentVmDetails: description: >- This class stores the monitoring details for consistency check of inconsistent Protected Entity. type: object properties: vmName: description: The Vm name. type: string cloudName: description: The Cloud name. type: string details: description: >- The list of details regarding state of the Protected Entity in SRS and On prem. type: array items: type: string errorIds: description: The list of error ids. type: array items: type: string InitialReplicationDetails: description: Initial replication details. type: object properties: initialReplicationType: description: Initial replication type. type: string initialReplicationProgressPercentage: description: The initial replication progress percentage. type: string InlineWorkflowTaskDetails: description: This class represents the inline workflow task details. type: object allOf: - $ref: '#/definitions/GroupTaskDetails' properties: workflowIds: description: The list of child workflow ids. type: array items: type: string x-ms-discriminator-value: InlineWorkflowTaskDetails InMageAgentDetails: description: The details of the InMage agent. type: object properties: agentVersion: description: The agent version. type: string agentUpdateStatus: description: A value indicating whether installed agent needs to be updated. type: string postUpdateRebootStatus: description: A value indicating whether reboot is required after update is applied. type: string agentExpiryDate: format: date-time description: Agent expiry date. type: string InMageAzureV2ApplyRecoveryPointInput: description: ApplyRecoveryPoint input specific to InMageAzureV2 provider. required: - instanceType type: object allOf: - $ref: '#/definitions/ApplyRecoveryPointProviderSpecificInput' properties: {} x-ms-discriminator-value: InMageAzureV2 InMageAzureV2DiskInputDetails: description: Disk input details. type: object properties: diskId: description: The DiskId. type: string logStorageAccountId: description: The LogStorageAccountId. type: string diskType: description: The DiskType. enum: - Standard_LRS - Premium_LRS - StandardSSD_LRS type: string x-ms-enum: name: DiskAccountType modelAsString: true diskEncryptionSetId: description: The DiskEncryptionSet ARM ID. type: string InMageAzureV2EnableProtectionInput: description: VMware Azure specific enable protection input. type: object allOf: - $ref: '#/definitions/EnableProtectionProviderSpecificInput' properties: masterTargetId: description: The Master target Id. type: string processServerId: description: The Process Server Id. type: string storageAccountId: description: The storage account Id. type: string runAsAccountId: description: The CS account Id. type: string multiVmGroupId: description: The multi VM group Id. type: string multiVmGroupName: description: The multi VM group name. type: string disksToInclude: description: The disks to include list. type: array items: $ref: '#/definitions/InMageAzureV2DiskInputDetails' targetAzureNetworkId: description: The selected target Azure network Id. type: string targetAzureSubnetId: description: The selected target Azure subnet Id. type: string enableRdpOnTargetOption: description: >- The selected option to enable RDP\SSH on target VM after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum. type: string targetAzureVmName: description: The target azure VM Name. type: string logStorageAccountId: description: The storage account to be used for logging during replication. type: string targetAzureV1ResourceGroupId: description: >- The Id of the target resource group (for classic deployment) in which the failover VM is to be created. type: string targetAzureV2ResourceGroupId: description: >- The Id of the target resource group (for resource manager deployment) in which the failover VM is to be created. type: string diskType: description: The DiskType. enum: - Standard_LRS - Premium_LRS - StandardSSD_LRS type: string x-ms-enum: name: DiskAccountType modelAsString: true targetAvailabilitySetId: description: The target availability set ARM Id for resource manager deployment. type: string targetAvailabilityZone: description: The target availability zone. type: string targetProximityPlacementGroupId: description: The proximity placement group ARM Id. type: string licenseType: description: License type. enum: - NotSpecified - NoLicenseType - WindowsServer type: string x-ms-enum: name: LicenseType modelAsString: true sqlServerLicenseType: description: The SQL Server license type. enum: - NotSpecified - NoLicenseType - PAYG - AHUB type: string x-ms-enum: name: SqlServerLicenseType modelAsString: true targetVmSize: description: The target VM size. type: string diskEncryptionSetId: description: The DiskEncryptionSet ARM Id. type: string targetVmTags: description: The target VM tags. maxLength: 50 type: object additionalProperties: type: string seedManagedDiskTags: description: The tags for the seed managed disks. maxLength: 49 type: object additionalProperties: type: string targetManagedDiskTags: description: The tags for the target managed disks. maxLength: 49 type: object additionalProperties: type: string targetNicTags: description: The tags for the target NICs. maxLength: 50 type: object additionalProperties: type: string x-ms-discriminator-value: InMageAzureV2 InMageAzureV2EventDetails: description: Model class for event details of a VMwareAzureV2 event. type: object allOf: - $ref: '#/definitions/EventProviderSpecificDetails' properties: eventType: description: >- InMage Event type. Takes one of the values of InMageDataContract.InMageMonitoringEventType. type: string category: description: InMage Event Category. type: string component: description: InMage Event Component. type: string correctiveAction: description: Corrective Action string for the event. type: string details: description: InMage Event Details. type: string summary: description: InMage Event Summary. type: string siteName: description: VMware Site name. type: string x-ms-discriminator-value: InMageAzureV2 InMageAzureV2ManagedDiskDetails: description: InMageAzureV2 Managed disk details. type: object properties: diskId: description: The disk id. type: string seedManagedDiskId: description: Seed managed disk Id. type: string replicaDiskType: description: The replica disk type. type: string diskEncryptionSetId: description: The DiskEncryptionSet ARM ID. type: string targetDiskName: description: The target disk name. type: string InMageAzureV2PolicyDetails: description: InMage Azure v2 specific protection profile details. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency in minutes. type: integer recoveryPointThresholdInMinutes: format: int32 description: The recovery point threshold in minutes. type: integer recoveryPointHistory: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency in minutes. type: integer multiVmSyncStatus: description: A value indicating whether multi-VM sync has to be enabled. type: string x-ms-discriminator-value: InMageAzureV2 InMageAzureV2PolicyInput: description: VMWare Azure specific policy Input. required: - multiVmSyncStatus type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificInput' properties: recoveryPointThresholdInMinutes: format: int32 description: The recovery point threshold in minutes. type: integer recoveryPointHistory: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency (in minutes). type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency (in minutes). type: integer multiVmSyncStatus: description: >- A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'. enum: - Enable - Disable type: string x-ms-enum: name: SetMultiVmSyncStatus modelAsString: true x-ms-discriminator-value: InMageAzureV2 InMageAzureV2ProtectedDiskDetails: description: InMageAzureV2 protected disk details. type: object properties: diskId: description: The disk id. type: string diskName: description: The disk name. type: string protectionStage: description: The protection stage. type: string healthErrorCode: description: The health error code for the disk. type: string rpoInSeconds: format: int64 description: The RPO in seconds. type: integer resyncRequired: description: A value indicating whether resync is required for this disk. type: string resyncProgressPercentage: format: int32 description: The resync progress percentage. type: integer resyncDurationInSeconds: format: int64 description: The resync duration in seconds. type: integer diskCapacityInBytes: format: int64 description: The disk capacity in bytes. type: integer fileSystemCapacityInBytes: format: int64 description: The disk file system capacity in bytes. type: integer sourceDataInMegaBytes: format: double description: The source data transit in MB. type: number psDataInMegaBytes: format: double description: The PS data transit in MB. type: number targetDataInMegaBytes: format: double description: The target data transit in MB. type: number diskResized: description: A value indicating whether disk is resized. type: string lastRpoCalculatedTime: format: date-time description: The last RPO calculated time. type: string resyncProcessedBytes: format: int64 description: The resync processed bytes. type: integer resyncTotalTransferredBytes: format: int64 description: The resync total transferred bytes. type: integer resyncLast15MinutesTransferredBytes: format: int64 description: The resync last 15 minutes transferred bytes. type: integer resyncLastDataTransferTimeUTC: format: date-time description: The last data transfer time in UTC. type: string resyncStartTime: format: date-time description: The resync start time. type: string progressHealth: description: The Progress Health. type: string progressStatus: description: The Progress Status. type: string secondsToTakeSwitchProvider: format: int64 description: The seconds to take for switch provider. type: integer InMageAzureV2RecoveryPointDetails: description: InMage Azure V2 provider specific recovery point details. type: object allOf: - $ref: '#/definitions/ProviderSpecificRecoveryPointDetails' properties: isMultiVmSyncPoint: description: A value indicating whether the recovery point is multi VM consistent. type: string x-ms-discriminator-value: InMageAzureV2 InMageAzureV2ReplicationDetails: description: InMageAzureV2 provider specific settings. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificSettings' properties: infrastructureVmId: description: The infrastructure VM Id. type: string vCenterInfrastructureId: description: The vCenter infrastructure Id. type: string protectionStage: description: The protection stage. type: string vmId: description: The virtual machine Id. type: string vmProtectionState: description: The protection state for the vm. type: string vmProtectionStateDescription: description: The protection state description for the vm. type: string resyncProgressPercentage: format: int32 description: The resync progress percentage. type: integer rpoInSeconds: format: int64 description: The RPO in seconds. type: integer compressedDataRateInMB: format: double description: The compressed data change rate in MB. type: number uncompressedDataRateInMB: format: double description: The uncompressed data change rate in MB. type: number ipAddress: description: The source IP address. type: string agentVersion: description: The agent version. type: string agentExpiryDate: format: date-time description: Agent expiry date. type: string isAgentUpdateRequired: description: A value indicating whether installed agent needs to be updated. type: string isRebootAfterUpdateRequired: description: >- A value indicating whether the source server requires a restart after update. type: string lastHeartbeat: format: date-time description: The last heartbeat received from the source server. type: string processServerId: description: The process server Id. type: string processServerName: description: The process server name. type: string multiVmGroupId: description: The multi vm group Id. type: string multiVmGroupName: description: The multi vm group name. type: string multiVmSyncStatus: description: A value indicating whether multi vm sync is enabled or disabled. type: string protectedDisks: description: The list of protected disks. type: array items: $ref: '#/definitions/InMageAzureV2ProtectedDiskDetails' diskResized: description: A value indicating whether any disk is resized for this VM. type: string masterTargetId: description: The master target Id. type: string sourceVmCpuCount: format: int32 description: The CPU count of the VM on the primary side. type: integer sourceVmRamSizeInMB: format: int32 description: The RAM size of the VM on the primary side. type: integer osType: description: The type of the OS on the VM. type: string vhdName: description: The OS disk VHD name. type: string osDiskId: description: The id of the disk containing the OS. type: string azureVMDiskDetails: description: Azure VM Disk details. type: array items: $ref: '#/definitions/AzureVmDiskDetails' recoveryAzureVMName: description: Recovery Azure given name. type: string recoveryAzureVMSize: description: The Recovery Azure VM size. type: string recoveryAzureStorageAccount: description: The recovery Azure storage account. type: string recoveryAzureLogStorageAccountId: 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. type: string vmNics: description: The PE Network details. type: array items: $ref: '#/definitions/VMNicDetails' selectedRecoveryAzureNetworkId: description: The selected recovery azure network Id. type: string selectedTfoAzureNetworkId: description: The test failover virtual network. type: string selectedSourceNicId: description: >- The selected source nic Id which will be used as the primary nic during failover. type: string discoveryType: description: >- A value indicating the discovery type of the machine. Value can be vCenter or physical. type: string enableRdpOnTargetOption: description: >- The selected option to enable RDP\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum. type: string datastores: description: >- The datastores of the on-premise machine. Value can be list of strings that contain datastore names. type: array items: type: string targetVmId: 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. type: string recoveryAzureResourceGroupId: description: The target resource group Id. type: string recoveryAvailabilitySetId: description: The recovery availability set Id. type: string targetAvailabilityZone: description: The target availability zone. type: string targetProximityPlacementGroupId: description: The target proximity placement group Id. type: string useManagedDisks: description: >- A value indicating whether managed disks should be used during failover. type: string licenseType: description: License Type of the VM to be used. type: string sqlServerLicenseType: description: The SQL Server license type. type: string validationErrors: description: >- The validation errors of the on-premise machine Value can be list of validation errors. type: array items: $ref: '#/definitions/HealthError' lastRpoCalculatedTime: format: date-time description: The last RPO calculated time. type: string lastUpdateReceivedTime: format: date-time description: The last update time received from on-prem components. type: string replicaId: description: The replica id of the protected item. type: string osVersion: description: The OS Version of the protected item. type: string protectedManagedDisks: description: The list of protected managed disks. type: array items: $ref: '#/definitions/InMageAzureV2ManagedDiskDetails' lastRecoveryPointReceived: format: date-time description: The last recovery point received time. type: string readOnly: true firmwareType: description: The firmware type of this protected item. type: string azureVmGeneration: description: The target generation for this protected item. type: string isAdditionalStatsAvailable: description: A value indicating whether additional IR stats are available or not. type: boolean totalDataTransferred: format: int64 description: The total transferred data in bytes. type: integer totalProgressHealth: description: The progress health. type: string targetVmTags: description: The target VM tags. type: object additionalProperties: type: string seedManagedDiskTags: description: The tags for the seed managed disks. type: object additionalProperties: type: string targetManagedDiskTags: description: The tags for the target managed disks. type: object additionalProperties: type: string targetNicTags: description: The tags for the target NICs. type: object additionalProperties: type: string switchProviderBlockingErrorDetails: description: The switch provider blocking error information. type: array items: $ref: '#/definitions/InMageAzureV2SwitchProviderBlockingErrorDetails' switchProviderDetails: $ref: '#/definitions/InMageAzureV2SwitchProviderDetails' description: The switch provider blocking error information. supportedOSVersions: description: A value indicating the inplace OS Upgrade version. type: array items: type: string x-ms-identifiers: [] allAvailableOSUpgradeConfigurations: description: A value indicating all available inplace OS Upgrade configurations. type: array items: $ref: '#/definitions/OSUpgradeSupportedVersions' x-ms-identifiers: [] osName: description: The name of the OS on the VM. type: string readOnly: true x-ms-discriminator-value: InMageAzureV2 InMageAzureV2ReprotectInput: description: InMageAzureV2 specific provider input. type: object allOf: - $ref: '#/definitions/ReverseReplicationProviderSpecificInput' properties: masterTargetId: description: The Master target Id. type: string processServerId: description: The Process Server Id. type: string storageAccountId: description: The storage account id. type: string runAsAccountId: description: The CS account Id. type: string policyId: description: The Policy Id. type: string logStorageAccountId: description: The storage account to be used for logging during replication. type: string disksToInclude: description: The disks to include list. type: array items: type: string x-ms-discriminator-value: InMageAzureV2 InMageAzureV2SwitchProviderBlockingErrorDetails: description: InMageAzureV2 switch provider blocking error details. type: object properties: errorCode: description: The error code. type: string readOnly: true errorMessage: description: The error message. type: string readOnly: true possibleCauses: description: The possible causes. type: string readOnly: true recommendedAction: description: The recommended action. type: string readOnly: true errorMessageParameters: description: The error message parameters. type: object additionalProperties: type: string readOnly: true errorTags: description: The error tags. type: object additionalProperties: type: string readOnly: true InMageAzureV2SwitchProviderDetails: description: InMageAzureV2 switch provider details. type: object properties: targetVaultId: description: The target vault Id. type: string readOnly: true targetResourceId: description: The target resource Id. type: string readOnly: true targetFabricId: description: The target fabric Id. type: string readOnly: true targetApplianceId: description: The target appliance Id. type: string readOnly: true InMageAzureV2SwitchProviderProviderInput: description: Provider specific input for InMageAzureV2 switch provider. required: - targetVaultID - targetFabricID - targetApplianceID type: object allOf: - $ref: '#/definitions/SwitchProviderProviderSpecificInput' properties: targetVaultID: description: The target vault Id. type: string targetFabricID: description: The target fabric Id. type: string targetApplianceID: description: The target appliance Id. type: string x-ms-discriminator-value: InMageAzureV2 InMageAzureV2TestFailoverInput: description: InMageAzureV2 provider specific input for test failover. type: object allOf: - $ref: '#/definitions/TestFailoverProviderSpecificInput' properties: recoveryPointId: 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. type: string osUpgradeVersion: description: A value indicating the inplace OS Upgrade version. type: string x-ms-discriminator-value: InMageAzureV2 InMageAzureV2UnplannedFailoverInput: description: InMageAzureV2 provider specific input for unplanned failover. type: object allOf: - $ref: '#/definitions/UnplannedFailoverProviderSpecificInput' properties: recoveryPointId: 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. type: string osUpgradeVersion: description: A value indicating the inplace OS Upgrade version. type: string x-ms-discriminator-value: InMageAzureV2 InMageAzureV2UpdateReplicationProtectedItemInput: description: InMage Azure V2 input to update replication protected item. type: object allOf: - $ref: '#/definitions/UpdateReplicationProtectedItemProviderInput' properties: recoveryAzureV1ResourceGroupId: description: The recovery Azure resource group Id for classic deployment. type: string recoveryAzureV2ResourceGroupId: description: The recovery Azure resource group Id for resource manager deployment. type: string useManagedDisks: description: >- A value indicating whether managed disks should be used during failover. type: string targetProximityPlacementGroupId: description: The target proximity placement group Id. type: string targetAvailabilityZone: description: The target availability zone. type: string targetVmTags: description: The target VM tags. maxLength: 50 type: object additionalProperties: type: string targetManagedDiskTags: description: The tags for the target managed disks. maxLength: 49 type: object additionalProperties: type: string targetNicTags: description: The tags for the target NICs. maxLength: 50 type: object additionalProperties: type: string sqlServerLicenseType: description: The SQL Server license type. enum: - NotSpecified - NoLicenseType - PAYG - AHUB type: string x-ms-enum: name: SqlServerLicenseType modelAsString: true vmDisks: description: The list of disk update properties. type: array items: $ref: '#/definitions/UpdateDiskInput' x-ms-discriminator-value: InMageAzureV2 InMageBasePolicyDetails: description: Base class for the policies of providers using InMage replication. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: recoveryPointThresholdInMinutes: format: int32 description: The recovery point threshold in minutes. type: integer recoveryPointHistory: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency in minutes. type: integer multiVmSyncStatus: description: A value indicating whether multi-VM sync has to be enabled. type: string x-ms-discriminator-value: InMageBasePolicyDetails InMageDisableProtectionProviderSpecificInput: description: InMage disable protection provider specific input. type: object allOf: - $ref: '#/definitions/DisableProtectionProviderSpecificInput' properties: replicaVmDeletionStatus: description: >- A value indicating whether the replica VM should be destroyed or retained. Values from Delete and Retain. type: string x-ms-discriminator-value: InMage InMageDiskDetails: description: VMware/Physical specific Disk Details. type: object properties: diskId: description: The disk Id. type: string diskName: description: The disk name. type: string diskSizeInMB: description: The disk size in MB. type: string diskType: description: Whether disk is system disk or data disk. type: string diskConfiguration: description: Whether disk is dynamic disk or basic disk. type: string volumeList: description: Volumes of the disk. type: array items: $ref: '#/definitions/DiskVolumeDetails' InMageDiskExclusionInput: description: >- DiskExclusionInput when doing enable protection of virtual machine in InMage provider. type: object properties: volumeOptions: description: The volume label based option for disk exclusion. type: array items: $ref: '#/definitions/InMageVolumeExclusionOptions' diskSignatureOptions: description: The guest disk signature based option for disk exclusion. type: array items: $ref: '#/definitions/InMageDiskSignatureExclusionOptions' InMageDiskSignatureExclusionOptions: description: >- Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider. type: object properties: diskSignature: description: The guest signature of disk to be excluded from replication. type: string InMageEnableProtectionInput: description: VMware Azure specific enable protection input. required: - masterTargetId - processServerId - retentionDrive - multiVmGroupId - multiVmGroupName type: object allOf: - $ref: '#/definitions/EnableProtectionProviderSpecificInput' properties: vmFriendlyName: description: The VM Name. type: string masterTargetId: description: The Master Target Id. type: string processServerId: description: The Process Server Id. type: string retentionDrive: description: The retention drive to use on the MT. type: string runAsAccountId: description: The CS account Id. type: string multiVmGroupId: description: The multi VM group Id. type: string multiVmGroupName: description: The multi VM group name. type: string datastoreName: description: The target datastore name. type: string diskExclusionInput: $ref: '#/definitions/InMageDiskExclusionInput' description: The enable disk exclusion input. disksToInclude: description: The disks to include list. type: array items: type: string x-ms-discriminator-value: InMage InMageFabricSwitchProviderBlockingErrorDetails: description: InMageFabric switch provider blocking error details. type: object properties: errorCode: description: The error code. type: string readOnly: true errorMessage: description: The error message. type: string readOnly: true possibleCauses: description: The possible causes. type: string readOnly: true recommendedAction: description: The recommended action. type: string readOnly: true errorMessageParameters: description: The error message parameters. type: object additionalProperties: type: string readOnly: true errorTags: description: The error tags. type: object additionalProperties: type: string readOnly: true InMagePolicyDetails: description: InMage specific protection profile details. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: recoveryPointThresholdInMinutes: format: int32 description: The recovery point threshold in minutes. type: integer recoveryPointHistory: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency in minutes. type: integer multiVmSyncStatus: description: A value indicating whether multi-VM sync has to be enabled. type: string x-ms-discriminator-value: InMage InMagePolicyInput: description: VMWare Azure specific protection profile Input. required: - multiVmSyncStatus type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificInput' properties: recoveryPointThresholdInMinutes: format: int32 description: The recovery point threshold in minutes. type: integer recoveryPointHistory: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency (in minutes). type: integer multiVmSyncStatus: description: >- A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'. enum: - Enable - Disable type: string x-ms-enum: name: SetMultiVmSyncStatus modelAsString: true x-ms-discriminator-value: InMage InMageProtectedDiskDetails: description: InMage protected disk details. type: object properties: diskId: description: The disk id. type: string diskName: description: The disk name. type: string protectionStage: description: The protection stage. type: string healthErrorCode: description: The health error code for the disk. type: string rpoInSeconds: format: int64 description: The RPO in seconds. type: integer resyncRequired: description: A value indicating whether resync is required for this disk. type: string resyncProgressPercentage: format: int32 description: The resync progress percentage. type: integer resyncDurationInSeconds: format: int64 description: The resync duration in seconds. type: integer diskCapacityInBytes: format: int64 description: The disk capacity in bytes. type: integer fileSystemCapacityInBytes: format: int64 description: The file system capacity in bytes. type: integer sourceDataInMB: format: double description: The source data transit in MB. type: number psDataInMB: format: double description: The PS data transit in MB. type: number targetDataInMB: format: double description: The target data transit in MB. type: number diskResized: description: A value indicating whether disk is resized. type: string lastRpoCalculatedTime: format: date-time description: The last RPO calculated time. type: string resyncProcessedBytes: format: int64 description: The resync processed bytes. type: integer resyncTotalTransferredBytes: format: int64 description: The resync total transferred bytes. type: integer resyncLast15MinutesTransferredBytes: format: int64 description: The resync last 15 minutes transferred bytes. type: integer resyncLastDataTransferTimeUTC: format: date-time description: The last data transfer time in UTC. type: string resyncStartTime: format: date-time description: The resync start time. type: string progressHealth: description: The Progress Health. type: string progressStatus: description: The Progress Status. type: string InMageRcmAgentUpgradeBlockingErrorDetails: description: InMageRcm source agent upgrade blocking error details. type: object properties: errorCode: description: The error code. type: string readOnly: true errorMessage: description: The error message. type: string readOnly: true possibleCauses: description: The possible causes. type: string readOnly: true recommendedAction: description: The recommended action. type: string readOnly: true errorMessageParameters: description: The error message parameters. type: object additionalProperties: type: string readOnly: true errorTags: description: The error tags. type: object additionalProperties: type: string readOnly: true InMageRcmApplianceDetails: description: InMageRcm appliance details. type: object properties: id: description: The appliance Id. type: string readOnly: true name: description: The appliance name. type: string readOnly: true fabricArmId: description: The fabric ARM Id. type: string 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: description: The switch provider blocking error information. type: array items: $ref: '#/definitions/InMageRcmFabricSwitchProviderBlockingErrorDetails' readOnly: true InMageRcmApplianceSpecificDetails: description: InMageRcm appliance specific details. type: object allOf: - $ref: '#/definitions/ApplianceSpecificDetails' properties: appliances: description: The list of appliances. type: array items: $ref: '#/definitions/InMageRcmApplianceDetails' readOnly: true x-ms-discriminator-value: InMageRcm InMageRcmApplyRecoveryPointInput: description: ApplyRecoveryPoint input specific to InMageRcm provider. required: - recoveryPointId - instanceType type: object allOf: - $ref: '#/definitions/ApplyRecoveryPointProviderSpecificInput' properties: recoveryPointId: description: The recovery point Id. type: string x-ms-discriminator-value: InMageRcm InMageRcmDiscoveredProtectedVmDetails: description: InMageRcm discovered protected VM details. type: object properties: vCenterId: description: The VCenter Id. type: string readOnly: true vCenterFqdn: description: The VCenter fqdn. type: string readOnly: true datastores: description: The list of datastores. type: array items: type: string readOnly: true ipAddresses: description: The list of IP addresses. type: array items: type: string readOnly: true vmwareToolsStatus: description: The VMware tools status. type: string readOnly: true powerStatus: description: The VM power status. type: string readOnly: true vmFqdn: description: The VM fqdn. type: string readOnly: true osName: description: The VM's OS name. type: string readOnly: true createdTimestamp: format: date-time description: The SDS created timestamp. type: string readOnly: true updatedTimestamp: format: date-time description: The SDS updated timestamp. type: string readOnly: true isDeleted: description: A value indicating whether the VM is deleted. type: boolean readOnly: true lastDiscoveryTimeInUtc: format: date-time description: The last time when SDS information discovered in SRS. type: string readOnly: true InMageRcmDiskInput: description: InMageRcm disk input. required: - diskId - logStorageAccountId - diskType type: object properties: diskId: description: The disk Id. type: string logStorageAccountId: description: The log storage account ARM Id. type: string diskType: description: The disk type. enum: - Standard_LRS - Premium_LRS - StandardSSD_LRS type: string x-ms-enum: name: DiskAccountType modelAsString: true diskEncryptionSetId: description: The DiskEncryptionSet ARM Id. type: string InMageRcmDisksDefaultInput: description: InMageRcm disk input. required: - logStorageAccountId - diskType type: object properties: logStorageAccountId: description: The log storage account ARM Id. type: string diskType: description: The disk type. enum: - Standard_LRS - Premium_LRS - StandardSSD_LRS type: string x-ms-enum: name: DiskAccountType modelAsString: true diskEncryptionSetId: description: The DiskEncryptionSet ARM Id. type: string InMageRcmEnableProtectionInput: description: InMageRcm specific enable protection input. required: - fabricDiscoveryMachineId - targetResourceGroupId - processServerId type: object allOf: - $ref: '#/definitions/EnableProtectionProviderSpecificInput' properties: fabricDiscoveryMachineId: description: The ARM Id of discovered machine. type: string disksToInclude: description: The disks to include list. minLength: 1 type: array items: $ref: '#/definitions/InMageRcmDiskInput' disksDefault: $ref: '#/definitions/InMageRcmDisksDefaultInput' description: The default disk input. targetResourceGroupId: description: The target resource group ARM Id. type: string targetNetworkId: description: The selected target network ARM Id. type: string testNetworkId: description: The selected test network ARM Id. type: string targetSubnetName: description: The selected target subnet name. type: string testSubnetName: description: The selected test subnet name. type: string targetVmName: description: The target VM name. type: string targetVmSize: description: The target VM size. type: string licenseType: description: The license type. enum: - NotSpecified - NoLicenseType - WindowsServer type: string x-ms-enum: name: LicenseType modelAsString: true targetAvailabilitySetId: description: The target availability set ARM Id. type: string targetAvailabilityZone: description: The target availability zone. type: string targetProximityPlacementGroupId: description: The target proximity placement group Id. type: string targetBootDiagnosticsStorageAccountId: description: The target boot diagnostics storage account ARM Id. type: string runAsAccountId: description: The run-as account Id. type: string processServerId: description: The process server Id. type: string multiVmGroupName: description: The multi VM group name. type: string x-ms-discriminator-value: InMageRcm InMageRcmEventDetails: description: Event details for InMageRcm provider. type: object allOf: - $ref: '#/definitions/EventProviderSpecificDetails' properties: protectedItemName: description: The protected item name. type: string readOnly: true vmName: description: The protected item name. type: string readOnly: true latestAgentVersion: description: The latest agent version. type: string readOnly: true jobId: description: The job Id. type: string readOnly: true fabricName: description: The fabric name. type: string readOnly: true applianceName: description: The appliance name. type: string readOnly: true serverType: description: The server type. type: string readOnly: true componentDisplayName: description: The component display name. type: string readOnly: true x-ms-discriminator-value: InMageRcm InMageRcmFabricCreationInput: description: InMageRcm fabric provider specific settings. required: - vmwareSiteId - physicalSiteId - sourceAgentIdentity type: object allOf: - $ref: '#/definitions/FabricSpecificCreationInput' properties: vmwareSiteId: description: The ARM Id of the VMware site. type: string physicalSiteId: description: The ARM Id of the physical site. type: string sourceAgentIdentity: $ref: '#/definitions/IdentityProviderInput' description: The identity provider input for source agent authentication. x-ms-discriminator-value: InMageRcm InMageRcmFabricSpecificDetails: description: InMageRcm fabric specific details. type: object allOf: - $ref: '#/definitions/FabricSpecificDetails' properties: vmwareSiteId: description: The ARM Id of the VMware site. type: string readOnly: true physicalSiteId: description: The ARM Id of the physical site. type: string readOnly: true serviceEndpoint: description: The service endpoint. type: string readOnly: true serviceResourceId: description: The service resource Id. type: string readOnly: true serviceContainerId: description: The service container Id. type: string readOnly: true dataPlaneUri: description: The data plane Uri. type: string readOnly: true controlPlaneUri: description: The control plane Uri. type: string readOnly: true sourceAgentIdentityDetails: $ref: '#/definitions/IdentityProviderDetails' description: The source agent identity details. processServers: description: The list of process servers. type: array items: $ref: '#/definitions/ProcessServerDetails' readOnly: true rcmProxies: description: The list of RCM proxies. type: array items: $ref: '#/definitions/RcmProxyDetails' readOnly: true pushInstallers: description: The list of push installers. type: array items: $ref: '#/definitions/PushInstallerDetails' readOnly: true replicationAgents: description: The list of replication agents. type: array items: $ref: '#/definitions/ReplicationAgentDetails' readOnly: true reprotectAgents: description: The list of reprotect agents. type: array items: $ref: '#/definitions/ReprotectAgentDetails' readOnly: true marsAgents: description: The list of Mars agents. type: array items: $ref: '#/definitions/MarsAgentDetails' readOnly: true dras: description: The list of DRAs. type: array items: $ref: '#/definitions/DraDetails' readOnly: true agentDetails: description: The list of agent details. type: array items: $ref: '#/definitions/AgentDetails' readOnly: true x-ms-discriminator-value: InMageRcm InMageRcmFabricSwitchProviderBlockingErrorDetails: description: InMageRcmFabric switch provider blocking error details. type: object properties: errorCode: description: The error code. type: string readOnly: true errorMessage: description: The error message. type: string readOnly: true possibleCauses: description: The possible causes. type: string readOnly: true recommendedAction: description: The recommended action. type: string readOnly: true errorMessageParameters: description: The error message parameters. type: object additionalProperties: type: string readOnly: true errorTags: description: The error tags. type: object additionalProperties: type: string readOnly: true InMageRcmFailbackDiscoveredProtectedVmDetails: description: InMageRcmFailback discovered VM details. type: object properties: vCenterId: description: The VCenter Id. type: string readOnly: true vCenterFqdn: description: The VCenter fqdn. type: string readOnly: true datastores: description: The list of datastores. type: array items: type: string readOnly: true ipAddresses: description: The list of IP addresses. type: array items: type: string readOnly: true vmwareToolsStatus: description: The VMware tools status. type: string readOnly: true powerStatus: description: The VM power status. type: string readOnly: true vmFqdn: description: The VM fqdn. type: string readOnly: true osName: description: The VM's OS name. type: string readOnly: true createdTimestamp: format: date-time description: The SDS created timestamp. type: string readOnly: true updatedTimestamp: format: date-time description: The SDS updated timestamp. type: string readOnly: true isDeleted: description: A value indicating whether the VM is deleted. type: boolean readOnly: true lastDiscoveryTimeInUtc: format: date-time description: The last time when SDS information discovered in SRS. type: string readOnly: true InMageRcmFailbackEventDetails: description: Event details for InMageRcmFailback provider. type: object allOf: - $ref: '#/definitions/EventProviderSpecificDetails' properties: protectedItemName: description: The protected item name. type: string readOnly: true vmName: description: The protected item name. type: string readOnly: true applianceName: description: The appliance name. type: string readOnly: true serverType: description: The server type. type: string readOnly: true componentDisplayName: description: The component display name. type: string readOnly: true x-ms-discriminator-value: InMageRcmFailback InMageRcmFailbackMobilityAgentDetails: description: InMageRcmFailback mobility agent details. type: object properties: version: description: The agent version. type: string readOnly: true latestVersion: description: The latest agent version available. type: string readOnly: true driverVersion: description: The driver version. type: string readOnly: true latestUpgradableVersionWithoutReboot: description: The latest upgradeable version available without reboot. type: string readOnly: true agentVersionExpiryDate: format: date-time description: The agent version expiry date. type: string readOnly: true driverVersionExpiryDate: format: date-time description: The driver version expiry date. type: string readOnly: true lastHeartbeatUtc: format: date-time description: The time of the last heartbeat received from the agent. type: string readOnly: true reasonsBlockingUpgrade: description: The whether update is possible or not. type: array items: enum: - AlreadyOnLatestVersion - RebootRequired - AgentNoHeartbeat - RcmProxyNoHeartbeat - ProcessServerNoHeartbeat - IncompatibleApplianceVersion - NotProtected - UnsupportedProtectionScenario - DistroIsNotReported - DistroNotSupportedForUpgrade - MissingUpgradePath - InvalidAgentVersion - InvalidDriverVersion - Unknown type: string x-ms-enum: name: AgentUpgradeBlockedReason modelAsString: true readOnly: true isUpgradeable: description: A value indicating whether agent is upgradeable or not. type: string readOnly: true InMageRcmFailbackNicDetails: description: InMageRcmFailback NIC details. type: object properties: macAddress: description: The mac address. type: string readOnly: true networkName: description: The network name. type: string readOnly: true adapterType: description: The adapter type. type: string readOnly: true sourceIpAddress: description: The IP address. type: string readOnly: true InMageRcmFailbackPlannedFailoverProviderInput: description: Provider specific input for InMageRcmFailback failover. required: - recoveryPointType type: object allOf: - $ref: '#/definitions/PlannedFailoverProviderSpecificFailoverInput' properties: recoveryPointType: description: The recovery point type. enum: - ApplicationConsistent - CrashConsistent type: string x-ms-enum: name: InMageRcmFailbackRecoveryPointType modelAsString: true x-ms-discriminator-value: InMageRcmFailback InMageRcmFailbackPolicyCreationInput: description: InMageRcmFailback policy creation input. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificInput' properties: crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency (in minutes). type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency (in minutes). type: integer x-ms-discriminator-value: InMageRcmFailback InMageRcmFailbackPolicyDetails: description: InMageRcm failback specific policy details. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency in minutes. type: integer crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency in minutes. type: integer x-ms-discriminator-value: InMageRcmFailback InMageRcmFailbackProtectedDiskDetails: description: InMageRcmFailback protected disk details. type: object properties: diskId: description: The disk Id (reported by source agent). type: string readOnly: true diskName: description: The disk name. type: string readOnly: true isOSDisk: description: A value indicating whether the disk is the OS disk. type: string readOnly: true capacityInBytes: format: int64 description: The disk capacity in bytes. type: integer readOnly: true diskUuid: description: The disk Uuid (reported by vCenter). type: string readOnly: true dataPendingInLogDataStoreInMB: format: double description: The data pending in log data store in MB. type: number readOnly: true dataPendingAtSourceAgentInMB: format: double description: The data pending at source agent in MB. type: number readOnly: true isInitialReplicationComplete: description: A value indicating whether initial replication is complete or not. type: string readOnly: true irDetails: $ref: '#/definitions/InMageRcmFailbackSyncDetails' description: The initial replication details. resyncDetails: $ref: '#/definitions/InMageRcmFailbackSyncDetails' description: The resync details. lastSyncTime: format: date-time description: The last sync time. type: string readOnly: true InMageRcmFailbackReplicationDetails: description: InMageRcmFailback provider specific details. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificSettings' properties: internalIdentifier: description: The virtual machine internal identifier. type: string readOnly: true azureVirtualMachineId: description: The ARM Id of the azure VM. type: string readOnly: true multiVmGroupName: description: The multi VM group name. type: string readOnly: true reprotectAgentId: description: The reprotect agent Id. type: string readOnly: true reprotectAgentName: description: The reprotect agent name. type: string readOnly: true osType: description: The type of the OS on the VM. type: string readOnly: true logStorageAccountId: description: The log storage account ARM Id. type: string readOnly: true targetvCenterId: description: The target vCenter Id. type: string readOnly: true targetDataStoreName: description: The target datastore name. type: string readOnly: true targetVmName: description: The target VM name. type: string readOnly: true initialReplicationProgressPercentage: format: int32 description: The initial replication progress percentage. type: integer readOnly: true initialReplicationProcessedBytes: 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. type: integer readOnly: true initialReplicationTransferredBytes: format: int64 description: >- The initial replication transferred bytes from source VM to target for all selected disks on source VM. type: integer readOnly: true initialReplicationProgressHealth: description: The initial replication progress health. enum: - None - InProgress - SlowProgress - NoProgress type: string readOnly: true x-ms-enum: name: VmReplicationProgressHealth modelAsString: true resyncProgressPercentage: format: int32 description: The resync progress percentage. type: integer readOnly: true resyncProcessedBytes: format: int64 description: >- The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM. type: integer readOnly: true resyncTransferredBytes: format: int64 description: >- The resync transferred bytes from source VM to target for all selected disks on source VM. type: integer readOnly: true resyncProgressHealth: description: The resync progress health. enum: - None - InProgress - SlowProgress - NoProgress type: string readOnly: true x-ms-enum: name: VmReplicationProgressHealth modelAsString: true resyncRequired: description: A value indicating whether resync is required. type: string readOnly: true resyncState: description: The resync state. enum: - None - PreparedForResynchronization - StartedResynchronization type: string readOnly: true x-ms-enum: name: ResyncState modelAsString: true protectedDisks: description: The list of protected disks. type: array items: $ref: '#/definitions/InMageRcmFailbackProtectedDiskDetails' mobilityAgentDetails: $ref: '#/definitions/InMageRcmFailbackMobilityAgentDetails' description: The mobility agent information. vmNics: description: The network details. type: array items: $ref: '#/definitions/InMageRcmFailbackNicDetails' lastPlannedFailoverStartTime: format: date-time description: The last planned failover start time. type: string readOnly: true lastPlannedFailoverStatus: description: The last planned failover status. enum: - Succeeded - Failed - Cancelled - Unknown type: string readOnly: true x-ms-enum: name: PlannedFailoverStatus modelAsString: true discoveredVmDetails: $ref: '#/definitions/InMageRcmFailbackDiscoveredProtectedVmDetails' description: The discovered VM information. lastUsedPolicyId: description: The policy Id used by the forward replication. type: string readOnly: true lastUsedPolicyFriendlyName: description: The policy friendly name used by the forward replication. type: string readOnly: true isAgentRegistrationSuccessfulAfterFailover: description: >- A value indicating whether agent registration was successful after failover. type: boolean readOnly: true x-ms-discriminator-value: InMageRcmFailback InMageRcmFailbackReprotectInput: description: InMageRcmFailback specific provider input. required: - processServerId - policyId type: object allOf: - $ref: '#/definitions/ReverseReplicationProviderSpecificInput' properties: processServerId: description: The process server Id. type: string runAsAccountId: description: The run as account Id. type: string policyId: description: The Policy Id. type: string x-ms-discriminator-value: InMageRcmFailback InMageRcmFailbackSyncDetails: description: InMageRcmFailback disk level sync details. type: object properties: progressHealth: description: The progress health. enum: - None - InProgress - SlowProgress - NoProgress - Queued type: string readOnly: true x-ms-enum: name: DiskReplicationProgressHealth modelAsString: true transferredBytes: format: int64 description: The transferred bytes from source VM to azure for the disk. type: integer readOnly: true last15MinutesTransferredBytes: format: int64 description: The bytes transferred in last 15 minutes from source VM to target. type: integer readOnly: true lastDataTransferTimeUtc: description: The time of the last data transfer from source VM to target. type: string readOnly: true processedBytes: format: int64 description: >- The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. type: integer readOnly: true startTime: description: The start time. type: string readOnly: true lastRefreshTime: description: The last refresh time. type: string readOnly: true progressPercentage: format: int32 description: >- Progress in percentage. Progress percentage is calculated based on processed bytes. type: integer readOnly: true InMageRcmLastAgentUpgradeErrorDetails: description: InMageRcm last source agent upgrade error details. type: object properties: errorCode: description: The error code. type: string readOnly: true errorMessage: description: The error message. type: string readOnly: true possibleCauses: description: The possible causes. type: string readOnly: true recommendedAction: description: The recommended action. type: string readOnly: true errorMessageParameters: description: The error message parameters. type: object additionalProperties: type: string readOnly: true errorTags: description: The error tags. type: object additionalProperties: type: string readOnly: true InMageRcmMobilityAgentDetails: description: InMageRcm mobility agent details. type: object properties: version: description: The agent version. type: string readOnly: true latestVersion: description: The latest agent version available. type: string readOnly: true latestAgentReleaseDate: description: The latest agent version release date. type: string readOnly: true driverVersion: description: The driver version. type: string readOnly: true latestUpgradableVersionWithoutReboot: description: The latest upgradeable version available without reboot. type: string readOnly: true agentVersionExpiryDate: format: date-time description: The agent version expiry date. type: string readOnly: true driverVersionExpiryDate: format: date-time description: The driver version expiry date. type: string readOnly: true lastHeartbeatUtc: format: date-time description: The time of the last heartbeat received from the agent. type: string readOnly: true reasonsBlockingUpgrade: description: The whether update is possible or not. type: array items: enum: - AlreadyOnLatestVersion - RebootRequired - AgentNoHeartbeat - RcmProxyNoHeartbeat - ProcessServerNoHeartbeat - IncompatibleApplianceVersion - NotProtected - UnsupportedProtectionScenario - DistroIsNotReported - DistroNotSupportedForUpgrade - MissingUpgradePath - InvalidAgentVersion - InvalidDriverVersion - Unknown type: string x-ms-enum: name: AgentUpgradeBlockedReason modelAsString: true readOnly: true isUpgradeable: description: A value indicating whether agent is upgradeable or not. type: string readOnly: true InMageRcmNicDetails: description: InMageRcm NIC details. type: object properties: nicId: description: The NIC Id. type: string readOnly: true isPrimaryNic: description: A value indicating whether this is the primary NIC. type: string isSelectedForFailover: description: A value indicating whether this NIC is selected for failover. type: string sourceIPAddress: description: The source IP address. type: string readOnly: true sourceIPAddressType: description: The source IP address type. enum: - Dynamic - Static type: string readOnly: true x-ms-enum: name: EthernetAddressType modelAsString: true sourceNetworkId: description: Source network Id. type: string readOnly: true sourceSubnetName: description: Source subnet name. type: string readOnly: true targetIPAddress: description: The target IP address. type: string targetIPAddressType: description: The target IP address type. enum: - Dynamic - Static type: string x-ms-enum: name: EthernetAddressType modelAsString: true targetSubnetName: description: Target subnet name. type: string testSubnetName: description: Test subnet name. type: string testIPAddress: description: The test IP address. type: string testIPAddressType: description: The test IP address type. enum: - Dynamic - Static type: string x-ms-enum: name: EthernetAddressType modelAsString: true InMageRcmNicInput: description: InMageRcm NIC input. required: - nicId - isPrimaryNic type: object properties: nicId: description: The NIC Id. type: string isPrimaryNic: description: A value indicating whether this is the primary NIC. type: string isSelectedForFailover: description: A value indicating whether this NIC is selected for failover. type: string targetSubnetName: description: Target subnet name. type: string targetStaticIPAddress: description: The target static IP address. type: string testSubnetName: description: The test subnet name. type: string testStaticIPAddress: description: The test static IP address. type: string InMageRcmPolicyCreationInput: description: InMageRcm policy creation input. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificInput' properties: recoveryPointHistoryInMinutes: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency (in minutes). type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency (in minutes). type: integer enableMultiVmSync: description: A value indicating whether multi-VM sync has to be enabled. type: string x-ms-discriminator-value: InMageRcm InMageRcmPolicyDetails: description: InMageRcm specific policy details. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: recoveryPointHistoryInMinutes: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency in minutes. type: integer crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency in minutes. type: integer enableMultiVmSync: description: A value indicating whether multi-VM sync has to be enabled. type: string x-ms-discriminator-value: InMageRcm InMageRcmProtectedDiskDetails: description: InMageRcm protected disk details. type: object properties: diskId: description: The disk Id. type: string readOnly: true diskName: description: The disk name. type: string readOnly: true isOSDisk: description: A value indicating whether the disk is the OS disk. type: string readOnly: true capacityInBytes: format: int64 description: The disk capacity in bytes. type: integer readOnly: true logStorageAccountId: description: The log storage account ARM Id. type: string readOnly: true diskEncryptionSetId: description: The DiskEncryptionSet ARM Id. type: string readOnly: true seedManagedDiskId: description: The ARM Id of the seed managed disk. type: string readOnly: true seedBlobUri: description: The uri of the seed blob. type: string readOnly: true targetManagedDiskId: description: The ARM Id of the target managed disk. type: string readOnly: true diskType: description: The disk type. enum: - Standard_LRS - Premium_LRS - StandardSSD_LRS type: string x-ms-enum: name: DiskAccountType modelAsString: true dataPendingInLogDataStoreInMB: format: double description: The data pending in log data store in MB. type: number readOnly: true dataPendingAtSourceAgentInMB: format: double description: The data pending at source agent in MB. type: number readOnly: true isInitialReplicationComplete: description: A value indicating whether initial replication is complete or not. type: string readOnly: true irDetails: $ref: '#/definitions/InMageRcmSyncDetails' description: The initial replication details. resyncDetails: $ref: '#/definitions/InMageRcmSyncDetails' description: The resync details. InMageRcmProtectionContainerMappingDetails: description: InMageRcm provider specific container mapping details. type: object allOf: - $ref: '#/definitions/ProtectionContainerMappingProviderSpecificDetails' properties: enableAgentAutoUpgrade: description: A value indicating whether the flag for enable agent auto upgrade. type: string readOnly: true x-ms-discriminator-value: InMageRcm InMageRcmRecoveryPointDetails: description: InMageRcm provider specific recovery point details. type: object allOf: - $ref: '#/definitions/ProviderSpecificRecoveryPointDetails' properties: isMultiVmSyncPoint: description: A value indicating whether the recovery point is multi VM consistent. type: string readOnly: true x-ms-discriminator-value: InMageRcm InMageRcmReplicationDetails: description: InMageRcm provider specific details. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificSettings' properties: internalIdentifier: description: The virtual machine internal identifier. type: string readOnly: true fabricDiscoveryMachineId: description: The ARM Id of the discovered VM. type: string readOnly: true multiVmGroupName: description: The multi VM group name. type: string readOnly: true discoveryType: description: The type of the discovered VM. type: string readOnly: true processServerId: description: The process server Id. type: string readOnly: true processorCoreCount: format: int32 description: The processor core count. type: integer readOnly: true allocatedMemoryInMB: format: double description: The allocated memory in MB. type: number readOnly: true processServerName: description: The process server name. type: string readOnly: true runAsAccountId: description: The run-as account Id. type: string readOnly: true osType: description: The type of the OS on the VM. type: string readOnly: true firmwareType: description: The firmware type. type: string readOnly: true primaryNicIpAddress: description: The IP address of the primary network interface. type: string readOnly: true targetGeneration: description: The target generation. type: string readOnly: true licenseType: description: License Type of the VM to be used. type: string storageAccountId: description: >- The replication storage account ARM Id. This is applicable only for the blob based replication test hook. type: string readOnly: true targetVmName: description: Target VM name. type: string targetVmSize: description: The target VM size. type: string targetResourceGroupId: description: The target resource group Id. type: string targetLocation: description: The target location. type: string targetAvailabilitySetId: description: The target availability set Id. type: string targetAvailabilityZone: description: The target availability zone. type: string targetProximityPlacementGroupId: description: The target proximity placement group Id. type: string targetBootDiagnosticsStorageAccountId: description: The target boot diagnostics storage account ARM Id. type: string targetNetworkId: description: The target network Id. type: string testNetworkId: description: The test network Id. type: string failoverRecoveryPointId: description: The recovery point Id to which the VM was failed over. type: string readOnly: true lastRecoveryPointReceived: format: date-time description: The last recovery point received time. type: string readOnly: true lastRpoInSeconds: format: int64 description: The last recovery point objective value. type: integer readOnly: true lastRpoCalculatedTime: format: date-time description: The last recovery point objective calculated time. type: string readOnly: true lastRecoveryPointId: description: The last recovery point Id. type: string readOnly: true initialReplicationProgressPercentage: format: int32 description: >- The initial replication progress percentage. This is calculated based on total bytes processed for all disks in the source VM. type: integer readOnly: true initialReplicationProcessedBytes: 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. type: integer readOnly: true initialReplicationTransferredBytes: format: int64 description: >- The initial replication transferred bytes from source VM to azure for all selected disks on source VM. type: integer readOnly: true initialReplicationProgressHealth: description: The initial replication progress health. enum: - None - InProgress - SlowProgress - NoProgress type: string readOnly: true x-ms-enum: name: VmReplicationProgressHealth modelAsString: true resyncProgressPercentage: format: int32 description: >- The resync progress percentage. This is calculated based on total bytes processed for all disks in the source VM. type: integer readOnly: true resyncProcessedBytes: format: int64 description: >- The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM. type: integer readOnly: true resyncTransferredBytes: format: int64 description: >- The resync transferred bytes from source VM to azure for all selected disks on source VM. type: integer readOnly: true resyncProgressHealth: description: The resync progress health. enum: - None - InProgress - SlowProgress - NoProgress type: string readOnly: true x-ms-enum: name: VmReplicationProgressHealth modelAsString: true resyncRequired: description: A value indicating whether resync is required. type: string readOnly: true resyncState: description: The resync state. enum: - None - PreparedForResynchronization - StartedResynchronization type: string readOnly: true x-ms-enum: name: ResyncState modelAsString: true agentUpgradeState: description: The agent auto upgrade state. enum: - None - Started - Completed - Commit type: string readOnly: true x-ms-enum: name: MobilityAgentUpgradeState modelAsString: true lastAgentUpgradeType: description: The last agent upgrade type. type: string readOnly: true agentUpgradeJobId: description: The agent upgrade job Id. type: string readOnly: true agentUpgradeAttemptToVersion: description: The agent version to which last agent upgrade was attempted. type: string readOnly: true protectedDisks: description: The list of protected disks. type: array items: $ref: '#/definitions/InMageRcmProtectedDiskDetails' isLastUpgradeSuccessful: description: A value indicating whether last agent upgrade was successful or not. type: string readOnly: true isAgentRegistrationSuccessfulAfterFailover: description: >- A value indicating whether agent registration was successful after failover. type: boolean readOnly: true mobilityAgentDetails: $ref: '#/definitions/InMageRcmMobilityAgentDetails' description: The mobility agent information. lastAgentUpgradeErrorDetails: description: The last agent upgrade error information. type: array items: $ref: '#/definitions/InMageRcmLastAgentUpgradeErrorDetails' agentUpgradeBlockingErrorDetails: description: The agent upgrade blocking error information. type: array items: $ref: '#/definitions/InMageRcmAgentUpgradeBlockingErrorDetails' vmNics: description: The network details. type: array items: $ref: '#/definitions/InMageRcmNicDetails' discoveredVmDetails: $ref: '#/definitions/InMageRcmDiscoveredProtectedVmDetails' description: The discovered VM details. x-ms-discriminator-value: InMageRcm InMageRcmReprotectInput: description: InMageRcm specific provider input. required: - reprotectAgentId - datastoreName - logStorageAccountId type: object allOf: - $ref: '#/definitions/ReverseReplicationProviderSpecificInput' properties: reprotectAgentId: description: The reprotect agent Id. type: string datastoreName: description: The target datastore name. type: string logStorageAccountId: description: The log storage account ARM Id. type: string policyId: description: The Policy Id. type: string x-ms-discriminator-value: InMageRcm InMageRcmSyncDetails: description: InMageRcm disk level sync details. type: object properties: progressHealth: description: The progress health. enum: - None - InProgress - SlowProgress - NoProgress - Queued type: string readOnly: true x-ms-enum: name: DiskReplicationProgressHealth modelAsString: true transferredBytes: format: int64 description: The transferred bytes from source VM to azure for the disk. type: integer readOnly: true last15MinutesTransferredBytes: format: int64 description: The bytes transferred in last 15 minutes from source VM to azure. type: integer readOnly: true lastDataTransferTimeUtc: description: The time of the last data transfer from source VM to azure. type: string readOnly: true processedBytes: format: int64 description: >- The total processed bytes. This includes bytes that are transferred from source VM to azure and matched bytes. type: integer readOnly: true startTime: description: The start time. type: string readOnly: true lastRefreshTime: description: The last refresh time. type: string readOnly: true progressPercentage: format: int32 description: >- Progress in percentage. Progress percentage is calculated based on processed bytes. type: integer readOnly: true InMageRcmTestFailoverInput: description: InMageRcm provider specific input for test failover. type: object allOf: - $ref: '#/definitions/TestFailoverProviderSpecificInput' properties: networkId: description: The test network Id. type: string recoveryPointId: 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. type: string x-ms-discriminator-value: InMageRcm InMageRcmUnplannedFailoverInput: description: InMageRcm provider specific input for unplanned failover. required: - performShutdown type: object allOf: - $ref: '#/definitions/UnplannedFailoverProviderSpecificInput' properties: performShutdown: description: A value indicating whether VM is to be shutdown. type: string recoveryPointId: 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. type: string x-ms-discriminator-value: InMageRcm InMageRcmUpdateApplianceForReplicationProtectedItemInput: description: >- InMageRcm provider specific input to update appliance for replication protected item. type: object allOf: - $ref: >- #/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput properties: runAsAccountId: description: The run as account Id. type: string x-ms-discriminator-value: InMageRcm InMageRcmUpdateContainerMappingInput: description: InMageRcm update protection container mapping. required: - enableAgentAutoUpgrade type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput' properties: enableAgentAutoUpgrade: description: A value indicating whether agent auto upgrade has to be enabled. type: string x-ms-discriminator-value: InMageRcm InMageRcmUpdateReplicationProtectedItemInput: description: InMageRcm provider specific input to update replication protected item. type: object allOf: - $ref: '#/definitions/UpdateReplicationProtectedItemProviderInput' properties: targetVmName: description: The target VM name. type: string targetVmSize: description: The target VM size. type: string targetResourceGroupId: description: The target resource group ARM Id. type: string targetAvailabilitySetId: description: The target availability set ARM Id. type: string targetAvailabilityZone: description: The target availability zone. type: string targetProximityPlacementGroupId: description: The target proximity placement group Id. type: string targetBootDiagnosticsStorageAccountId: description: The target boot diagnostics storage account ARM Id. type: string targetNetworkId: description: The target network ARM Id. type: string testNetworkId: description: The test network ARM Id. type: string vmNics: description: The list of NIC details. minLength: 1 type: array items: $ref: '#/definitions/InMageRcmNicInput' licenseType: description: The license type. enum: - NotSpecified - NoLicenseType - WindowsServer type: string x-ms-enum: name: LicenseType modelAsString: true x-ms-discriminator-value: InMageRcm InMageReplicationDetails: description: InMage provider specific settings. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificSettings' properties: activeSiteType: 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. type: string sourceVmCpuCount: format: int32 description: The CPU count of the VM on the primary side. type: integer sourceVmRamSizeInMB: format: int32 description: The RAM size of the VM on the primary side. type: integer osDetails: $ref: '#/definitions/OSDiskDetails' description: The OS details. protectionStage: description: The protection stage. type: string vmId: description: The virtual machine Id. type: string vmProtectionState: description: The protection state for the vm. type: string vmProtectionStateDescription: description: The protection state description for the vm. type: string resyncDetails: $ref: '#/definitions/InitialReplicationDetails' description: The resync details of the machine. retentionWindowStart: format: date-time description: The retention window start time. type: string retentionWindowEnd: format: date-time description: The retention window end time. type: string compressedDataRateInMB: format: double description: The compressed data change rate in MB. type: number uncompressedDataRateInMB: format: double description: The uncompressed data change rate in MB. type: number rpoInSeconds: format: int64 description: The RPO in seconds. type: integer protectedDisks: description: The list of protected disks. type: array items: $ref: '#/definitions/InMageProtectedDiskDetails' ipAddress: description: The source IP address. type: string lastHeartbeat: format: date-time description: The last heartbeat received from the source server. type: string processServerId: description: The process server Id. type: string masterTargetId: description: The master target Id. type: string consistencyPoints: description: The collection of Consistency points. type: object additionalProperties: format: date-time type: string diskResized: description: A value indicating whether any disk is resized for this VM. type: string rebootAfterUpdateStatus: description: >- A value indicating whether the source server requires a restart after update. type: string multiVmGroupId: description: The multi vm group Id, if any. type: string multiVmGroupName: description: The multi vm group name, if any. type: string multiVmSyncStatus: description: A value indicating whether the multi vm sync is enabled or disabled. type: string agentDetails: $ref: '#/definitions/InMageAgentDetails' description: The agent details. vCenterInfrastructureId: description: The vCenter infrastructure Id. type: string infrastructureVmId: description: The infrastructure VM Id. type: string vmNics: description: The PE Network details. type: array items: $ref: '#/definitions/VMNicDetails' discoveryType: description: A value indicating the discovery type of the machine. type: string azureStorageAccountId: description: >- A value indicating the underlying Azure storage account. If the VM is not running in Azure, this value shall be set to null. type: string datastores: description: >- The datastores of the on-premise machine Value can be list of strings that contain datastore names. type: array items: type: string validationErrors: description: >- The validation errors of the on-premise machine Value can be list of validation errors. type: array items: $ref: '#/definitions/HealthError' lastRpoCalculatedTime: format: date-time description: The last RPO calculated time. type: string lastUpdateReceivedTime: format: date-time description: The last update time received from on-prem components. type: string replicaId: description: The replica id of the protected item. type: string osVersion: description: The OS Version of the protected item. type: string isAdditionalStatsAvailable: description: A value indicating whether additional IR stats are available or not. type: boolean totalDataTransferred: format: int64 description: The total transferred data in bytes. type: integer totalProgressHealth: description: The progress health. type: string x-ms-discriminator-value: InMage InMageReprotectInput: description: InMageAzureV2 specific provider input. required: - masterTargetId - processServerId - retentionDrive - profileId type: object allOf: - $ref: '#/definitions/ReverseReplicationProviderSpecificInput' properties: masterTargetId: description: The Master Target Id. type: string processServerId: description: The Process Server Id. type: string retentionDrive: description: The retention drive to use on the MT. type: string runAsAccountId: description: The CS account Id. type: string datastoreName: description: The target datastore name. type: string diskExclusionInput: $ref: '#/definitions/InMageDiskExclusionInput' description: The enable disk exclusion input. profileId: description: The Policy Id. type: string disksToInclude: description: The disks to include list. type: array items: type: string x-ms-discriminator-value: InMage InMageTestFailoverInput: description: Provider specific input for InMage test failover. type: object allOf: - $ref: '#/definitions/TestFailoverProviderSpecificInput' properties: 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. enum: - LatestTime - LatestTag - Custom type: string x-ms-enum: name: RecoveryPointType modelAsString: true recoveryPointId: 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. type: string x-ms-discriminator-value: InMage InMageUnplannedFailoverInput: description: Provider specific input for InMage unplanned failover. type: object allOf: - $ref: '#/definitions/UnplannedFailoverProviderSpecificInput' properties: 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. enum: - LatestTime - LatestTag - Custom type: string x-ms-enum: name: RecoveryPointType modelAsString: true recoveryPointId: 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. type: string x-ms-discriminator-value: InMage InMageVolumeExclusionOptions: description: >- Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider. type: object properties: volumeLabel: description: >- The volume label. The disk having any volume with this label will be excluded from replication. type: string onlyExcludeIfSingleVolume: 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. type: string InnerHealthError: 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. type: object properties: errorSource: description: Source of error. type: string errorType: description: Type of error. type: string errorLevel: description: Level of error. type: string errorCategory: description: Category of error. type: string errorCode: description: Error code. type: string summaryMessage: description: Summary message of the entity. type: string errorMessage: description: Error message. type: string possibleCauses: description: Possible causes of error. type: string recommendedAction: description: Recommended action to resolve error. type: string creationTimeUtc: format: date-time description: Error creation time (UTC). type: string recoveryProviderErrorMessage: description: DRA error message. type: string entityId: description: ID of the entity. type: string errorId: description: The health error unique id. type: string customerResolvability: description: Value indicating whether the health error is customer resolvable. enum: - Allowed - NotAllowed type: string x-ms-enum: name: HealthErrorCustomerResolvability modelAsString: true InputEndpoint: type: object properties: endpointName: type: string privatePort: format: int32 type: integer publicPort: format: int32 type: integer protocol: type: string Job: description: Job details. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/JobProperties' description: The custom data. JobCollection: description: Collection of jobs. type: object properties: value: description: The list of jobs. type: array items: $ref: '#/definitions/Job' nextLink: description: The value of next link. type: string JobDetails: description: Job details based on specific job type. required: - instanceType type: object properties: instanceType: description: >- Gets the type of job details (see JobDetailsTypes enum for possible values). type: string affectedObjectDetails: description: >- The affected object properties like source server, source cloud, target server, target cloud etc. based on the workflow object details. type: object additionalProperties: type: string discriminator: instanceType JobEntity: description: >- This class contains the minimal job details required to navigate to the desired drill down. type: object properties: jobId: description: The job id. type: string jobFriendlyName: description: The job display name. type: string targetObjectId: description: The object id. type: string targetObjectName: description: The object name. type: string targetInstanceType: description: The workflow affected object type. type: string jobScenarioName: description: The job name. Enum type ScenarioName. type: string JobErrorDetails: description: This class contains the error details per object. type: object properties: serviceErrorDetails: $ref: '#/definitions/ServiceError' description: The Service error details. providerErrorDetails: $ref: '#/definitions/ProviderError' description: The Provider error details. errorLevel: description: Error level of error. type: string creationTime: format: date-time description: The creation time of job error. type: string taskId: description: The Id of the task. type: string JobProperties: description: Job custom data details. type: object properties: activityId: description: The activity id. type: string scenarioName: description: The ScenarioName. type: string friendlyName: description: The DisplayName. type: string state: description: >- The status of the Job. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other. type: string stateDescription: description: >- The description of the state of the Job. For e.g. - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped. type: string tasks: description: The tasks. type: array items: $ref: '#/definitions/ASRTask' errors: description: The errors. type: array items: $ref: '#/definitions/JobErrorDetails' startTime: format: date-time description: The start time. type: string endTime: format: date-time description: The end time. type: string allowedActions: description: The Allowed action the job. type: array items: type: string targetObjectId: description: The affected Object Id. type: string targetObjectName: description: The name of the affected object. type: string targetInstanceType: description: >- The type of the affected object which is of Microsoft.Azure.SiteRecovery.V2015_11_10.AffectedObjectType class. type: string customDetails: $ref: '#/definitions/JobDetails' description: The custom job details like test failover job details. JobQueryParameter: description: Query parameter to enumerate jobs. type: object properties: startTime: description: Date time to get jobs from. type: string endTime: description: Date time to get jobs upto. type: string fabricId: description: The Id of the fabric to search jobs under. type: string affectedObjectTypes: description: The type of objects. type: string jobStatus: description: The states of the job to be filtered can be in. type: string jobOutputType: description: The output type of the jobs. enum: - Json - Xml - Excel type: string x-ms-enum: name: ExportJobOutputSerializationType modelAsString: true jobName: description: The job Name. type: string timezoneOffset: format: double description: The timezone offset for the location of the request (in minutes). type: number JobStatusEventDetails: description: Model class for event details of a job status event. type: object allOf: - $ref: '#/definitions/EventSpecificDetails' properties: jobId: description: Job arm id for the event. type: string jobFriendlyName: description: JobName for the Event. type: string jobStatus: description: JobStatus for the Event. type: string affectedObjectType: description: AffectedObjectType for the event. type: string x-ms-discriminator-value: JobStatus JobTaskDetails: description: >- This class represents a task which is actually a workflow so that one can navigate to its individual drill down. required: - instanceType type: object allOf: - $ref: '#/definitions/TaskTypeDetails' properties: jobTask: $ref: '#/definitions/JobEntity' description: The job entity. discriminator: instanceType x-ms-discriminator-value: JobTaskDetails KeyEncryptionKeyInfo: description: Key Encryption Key (KEK) information. type: object properties: keyIdentifier: description: The key URL / identifier. type: string keyVaultResourceArmId: description: The KeyVault resource ARM Id for key. type: string LogicalNetwork: description: Logical network data model. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/LogicalNetworkProperties' description: The Logical Network Properties. LogicalNetworkCollection: description: List of logical networks. type: object properties: value: description: The Logical Networks list details. type: array items: $ref: '#/definitions/LogicalNetwork' nextLink: description: The value of next link. type: string LogicalNetworkProperties: description: Logical Network Properties. type: object properties: friendlyName: description: The Friendly Name. type: string networkVirtualizationStatus: description: >- A value indicating whether Network Virtualization is enabled for the logical network. type: string logicalNetworkUsage: description: >- A value indicating whether logical network is used as private test network by test failover. type: string logicalNetworkDefinitionsStatus: description: A value indicating whether logical network definitions are isolated. type: string ManualActionTaskDetails: description: This class represents the manual action task details. type: object allOf: - $ref: '#/definitions/TaskTypeDetails' properties: name: description: The name. type: string instructions: description: The instructions. type: string observation: description: The observation. type: string x-ms-discriminator-value: ManualActionTaskDetails MarsAgentDetails: description: Mars agent details. type: object properties: id: description: The Mars agent Id. type: string readOnly: true name: description: The Mars agent name. type: string readOnly: true biosId: description: The Mars agent Bios Id. type: string readOnly: true fabricObjectId: description: The fabric object Id. type: string readOnly: true fqdn: description: The Mars agent Fqdn. type: string readOnly: true version: description: The version. type: string readOnly: true lastHeartbeatUtc: format: date-time description: The last heartbeat received from the Mars agent. type: string readOnly: true health: description: The health of the Mars agent. enum: - None - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: ProtectionHealth modelAsString: true healthErrors: description: The health errors. type: array items: $ref: '#/definitions/HealthError' readOnly: true MasterTargetServer: description: Details of a Master Target Server. type: object properties: id: description: The server Id. type: string ipAddress: description: The IP address of the server. type: string name: description: The server name. type: string osType: description: The OS type of the server. type: string agentVersion: description: The version of the scout component on the server. type: string lastHeartbeat: format: date-time description: The last heartbeat received from the server. type: string versionStatus: description: Version status. type: string retentionVolumes: description: The retention volumes of Master target Server. type: array items: $ref: '#/definitions/RetentionVolume' dataStores: description: The list of data stores in the fabric. type: array items: $ref: '#/definitions/DataStore' validationErrors: description: Validation errors. type: array items: $ref: '#/definitions/HealthError' healthErrors: description: Health errors. type: array items: $ref: '#/definitions/HealthError' diskCount: format: int32 description: Disk count of the master target. type: integer osVersion: description: OS Version of the master target. type: string agentExpiryDate: format: date-time description: Agent expiry date. type: string marsAgentVersion: description: MARS agent version. type: string marsAgentExpiryDate: format: date-time description: MARS agent expiry date. type: string agentVersionDetails: $ref: '#/definitions/VersionDetails' description: Agent version details. marsAgentVersionDetails: $ref: '#/definitions/VersionDetails' description: Mars agent version details. MigrateInput: description: Input for migrate. required: - properties type: object properties: properties: $ref: '#/definitions/MigrateInputProperties' description: Migrate input properties. MigrateInputProperties: description: Migrate input properties. required: - providerSpecificDetails type: object properties: providerSpecificDetails: $ref: '#/definitions/MigrateProviderSpecificInput' description: The provider specific details. MigrateProviderSpecificInput: description: Migrate provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType MigrationItem: description: Migration item. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/MigrationItemProperties' description: The migration item properties. MigrationItemCollection: description: Migration item collection. type: object properties: value: description: The list of migration items. type: array items: $ref: '#/definitions/MigrationItem' nextLink: description: The value of next link. type: string MigrationItemProperties: description: Migration item properties. type: object properties: machineName: description: The on-premise virtual machine name. type: string readOnly: true policyId: description: The ARM Id of policy governing this item. type: string readOnly: true policyFriendlyName: description: The name of policy governing this item. type: string readOnly: true recoveryServicesProviderId: description: The recovery services provider ARM Id. type: string readOnly: true replicationStatus: description: The replication status. type: string readOnly: true migrationState: description: The migration status. enum: - None - EnableMigrationInProgress - EnableMigrationFailed - DisableMigrationInProgress - DisableMigrationFailed - InitialSeedingInProgress - InitialSeedingFailed - Replicating - MigrationInProgress - MigrationSucceeded - MigrationFailed - ResumeInProgress - ResumeInitiated - SuspendingProtection - ProtectionSuspended - MigrationCompletedWithInformation - MigrationPartiallySucceeded type: string readOnly: true x-ms-enum: name: MigrationState modelAsString: true migrationStateDescription: description: The migration state description. type: string readOnly: true lastTestMigrationTime: format: date-time description: The last test migration time. type: string readOnly: true lastTestMigrationStatus: description: The status of the last test migration. type: string readOnly: true lastMigrationTime: format: date-time description: The last migration time. type: string readOnly: true lastMigrationStatus: description: The status of the last migration. type: string readOnly: true testMigrateState: description: The test migrate state. enum: - None - TestMigrationInProgress - TestMigrationSucceeded - TestMigrationFailed - TestMigrationCleanupInProgress - TestMigrationCompletedWithInformation - TestMigrationPartiallySucceeded type: string readOnly: true x-ms-enum: name: TestMigrationState modelAsString: true testMigrateStateDescription: description: The test migrate state description. type: string readOnly: true health: description: The consolidated health. enum: - None - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: ProtectionHealth modelAsString: true healthErrors: description: The list of health errors. type: array items: $ref: '#/definitions/HealthError' readOnly: true allowedOperations: description: >- The allowed operations on the migration item based on the current migration state of the item. type: array items: enum: - DisableMigration - TestMigrate - TestMigrateCleanup - Migrate - StartResync - PauseReplication - ResumeReplication type: string x-ms-enum: name: MigrationItemOperation modelAsString: true readOnly: true currentJob: $ref: '#/definitions/CurrentJobDetails' description: The current job details. readOnly: true criticalJobHistory: description: The critical past job details. type: array items: $ref: '#/definitions/CriticalJobHistoryDetails' readOnly: true x-ms-identifiers: [] eventCorrelationId: description: The correlation Id for events associated with this migration item. type: string readOnly: true providerSpecificDetails: $ref: '#/definitions/MigrationProviderSpecificSettings' description: The migration provider custom settings. MigrationItemsQueryParameter: description: Query parameter to enumerate migration items. type: object properties: sourceFabricName: description: The source fabric name filter. type: string sourceContainerName: description: The source container name filter. type: string instanceType: description: The replication provider type. type: string MigrationProviderSpecificSettings: description: Migration provider specific settings. required: - instanceType type: object properties: instanceType: description: Gets the instance type. type: string discriminator: instanceType MigrationRecoveryPoint: description: Recovery point for a migration item. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/MigrationRecoveryPointProperties' description: Recovery point properties. MigrationRecoveryPointCollection: description: Collection of migration recovery points. type: object properties: value: description: The migration recovery point details. type: array items: $ref: '#/definitions/MigrationRecoveryPoint' nextLink: description: The value of next link. type: string MigrationRecoveryPointProperties: description: Migration item recovery point properties. type: object properties: recoveryPointTime: format: date-time description: The recovery point time. type: string readOnly: true recoveryPointType: description: The recovery point type. enum: - NotSpecified - ApplicationConsistent - CrashConsistent type: string readOnly: true x-ms-enum: name: MigrationRecoveryPointType modelAsString: true MobilityServiceUpdate: description: The Mobility Service update details. type: object properties: version: description: The version of the latest update. type: string rebootStatus: description: The reboot status of the update - whether it is required or not. type: string osType: description: The OS type. type: string Network: description: Network model. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/NetworkProperties' description: The Network Properties. NetworkCollection: description: List of networks. type: object properties: value: description: The Networks list details. type: array items: $ref: '#/definitions/Network' nextLink: description: The value of next link. type: string NetworkMapping: 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. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/NetworkMappingProperties' description: The Network Mapping Properties. NetworkMappingCollection: 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. type: object properties: value: description: The Network Mappings list. type: array items: $ref: '#/definitions/NetworkMapping' nextLink: description: The value of next link. type: string NetworkMappingFabricSpecificSettings: description: Network Mapping fabric specific settings. required: - instanceType type: object properties: instanceType: description: Gets the Instance type. type: string discriminator: instanceType NetworkMappingProperties: description: Network Mapping Properties. type: object properties: state: description: The pairing state for network mapping. type: string primaryNetworkFriendlyName: description: The primary network friendly name. type: string primaryNetworkId: description: The primary network id for network mapping. type: string primaryFabricFriendlyName: description: The primary fabric friendly name. type: string recoveryNetworkFriendlyName: description: The recovery network friendly name. type: string recoveryNetworkId: description: The recovery network id for network mapping. type: string recoveryFabricArmId: description: The recovery fabric ARM id. type: string recoveryFabricFriendlyName: description: The recovery fabric friendly name. type: string fabricSpecificSettings: $ref: '#/definitions/NetworkMappingFabricSpecificSettings' description: The fabric specific settings. NetworkProperties: description: Network Properties. type: object properties: fabricType: description: The Fabric Type. type: string subnets: description: The List of subnets. type: array items: $ref: '#/definitions/Subnet' friendlyName: description: The Friendly Name. type: string networkType: description: The Network Type. type: string NewProtectionProfile: description: New Protection profile input. required: - policyName - multiVmSyncStatus type: object allOf: - $ref: '#/definitions/ProtectionProfileCustomDetails' properties: policyName: description: The protection profile input. type: string recoveryPointHistory: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency (in minutes). type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency (in minutes). type: integer multiVmSyncStatus: description: >- A value indicating whether multi-VM sync has to be enabled. Value should be 'Enabled' or 'Disabled'. enum: - Enable - Disable type: string x-ms-enum: name: SetMultiVmSyncStatus modelAsString: true x-ms-discriminator-value: New NewRecoveryVirtualNetwork: description: >- Recovery virtual network input to create new virtual network from given source network. type: object allOf: - $ref: '#/definitions/RecoveryVirtualNetworkCustomDetails' properties: recoveryVirtualNetworkResourceGroupName: 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. type: string recoveryVirtualNetworkName: description: The recovery virtual network name. type: string x-ms-discriminator-value: New OperationsDiscovery: description: Operations discovery class. type: object properties: name: 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). type: string display: $ref: '#/definitions/Display' description: Object type. origin: 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". type: string properties: $ref: '#/definitions/OperationsDiscoveryProperties' description: Properties. Reserved for future use. OperationsDiscoveryCollection: description: Collection of ClientDiscovery details. type: object properties: value: description: The ClientDiscovery details. type: array items: $ref: '#/definitions/OperationsDiscovery' nextLink: description: The value of next link. type: string OperationsDiscoveryProperties: description: ClientDiscovery properties. type: object properties: {} OSDetails: description: Disk Details. type: object properties: osType: description: VM Disk details. type: string productType: description: Product type. type: string osEdition: description: The OSEdition. type: string oSVersion: description: The OS Version. type: string oSMajorVersion: description: The OS Major Version. type: string oSMinorVersion: description: The OS Minor Version. type: string OSDiskDetails: description: Details of the OS Disk. type: object properties: osVhdId: description: The id of the disk containing the OS. type: string osType: description: The type of the OS on the VM. type: string vhdName: description: The OS disk VHD name. type: string OSUpgradeSupportedVersions: description: Supported OS upgrade versions. type: object properties: supportedSourceOsVersion: description: The source OS version name. type: string readOnly: true supportedTargetOsVersions: description: The target OS version names. type: array items: type: string readOnly: true OSVersionWrapper: description: Wrapper model for OSVersion to include version and service pack info. type: object properties: version: description: The version. type: string servicePack: description: The service pack. type: string PauseReplicationInput: description: Pause replication input. required: - properties type: object properties: properties: $ref: '#/definitions/PauseReplicationInputProperties' description: Pause replication input properties. PauseReplicationInputProperties: description: Pause replication input properties. required: - instanceType type: object properties: instanceType: description: The class type. type: string PlannedFailoverInput: description: Input definition for planned failover. type: object properties: properties: $ref: '#/definitions/PlannedFailoverInputProperties' description: Planned failover input properties. PlannedFailoverInputProperties: description: Input definition for planned failover input properties. type: object properties: failoverDirection: description: Failover direction. type: string providerSpecificDetails: $ref: '#/definitions/PlannedFailoverProviderSpecificFailoverInput' description: Provider specific settings. PlannedFailoverProviderSpecificFailoverInput: description: Provider specific failover input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType Policy: description: Protection profile details. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/PolicyProperties' description: The custom data. PolicyCollection: description: Protection Profile Collection details. type: object properties: value: description: The policy details. type: array items: $ref: '#/definitions/Policy' nextLink: description: The value of next link. type: string PolicyProperties: description: Protection profile custom data details. type: object properties: friendlyName: description: The FriendlyName. type: string providerSpecificDetails: $ref: '#/definitions/PolicyProviderSpecificDetails' description: The ReplicationChannelSetting. PolicyProviderSpecificDetails: description: Base class for Provider specific details for policies. required: - instanceType type: object properties: instanceType: description: Gets the class type. Overridden in derived classes. type: string discriminator: instanceType PolicyProviderSpecificInput: description: Base class for provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType ProcessServer: description: Details of the Process Server. type: object properties: friendlyName: description: The Process Server's friendly name. type: string id: description: The Process Server Id. type: string ipAddress: description: The IP address of the server. type: string osType: description: The OS type of the server. type: string agentVersion: description: The version of the scout component on the server. type: string lastHeartbeat: format: date-time description: The last heartbeat received from the server. type: string versionStatus: description: Version status. type: string mobilityServiceUpdates: description: >- The list of the mobility service updates available on the Process Server. type: array items: $ref: '#/definitions/MobilityServiceUpdate' hostId: description: The agent generated Id. type: string machineCount: description: The servers configured with this PS. type: string replicationPairCount: description: The number of replication pairs configured in this PS. type: string systemLoad: description: The percentage of the system load. type: string systemLoadStatus: description: The system load status. type: string cpuLoad: description: The percentage of the CPU load. type: string cpuLoadStatus: description: The CPU load status. type: string totalMemoryInBytes: format: int64 description: The total memory. type: integer availableMemoryInBytes: format: int64 description: The available memory. type: integer memoryUsageStatus: description: The memory usage status. type: string totalSpaceInBytes: format: int64 description: The total space. type: integer availableSpaceInBytes: format: int64 description: The available space. type: integer spaceUsageStatus: description: The space usage status. type: string psServiceStatus: description: The PS service status. type: string sslCertExpiryDate: format: date-time description: The PS SSL cert expiry date. type: string sslCertExpiryRemainingDays: format: int32 description: CS SSL cert expiry date. type: integer osVersion: description: >- OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. type: string healthErrors: description: Health errors. type: array items: $ref: '#/definitions/HealthError' agentExpiryDate: format: date-time description: Agent expiry date. type: string agentVersionDetails: $ref: '#/definitions/VersionDetails' description: The agent version details. health: description: The health of Process Server. enum: - None - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: ProtectionHealth modelAsString: true psStatsRefreshTime: format: date-time description: The process server stats refresh time. type: string readOnly: true throughputUploadPendingDataInBytes: format: int64 description: The uploading pending data in bytes. type: integer readOnly: true throughputInMBps: format: int64 description: The throughput in MBps. type: integer readOnly: true throughputInBytes: format: int64 description: The throughput in bytes. type: integer readOnly: true throughputStatus: description: The throughput status. type: string readOnly: true marsCommunicationStatus: description: The MARS communication status. type: string readOnly: true marsRegistrationStatus: description: The MARS registration status. type: string readOnly: true ProcessServerDetails: description: Process server details. type: object properties: id: description: The process server Id. type: string readOnly: true name: description: The process server name. type: string readOnly: true biosId: description: The process server Bios Id. type: string readOnly: true fabricObjectId: description: The fabric object Id. type: string readOnly: true fqdn: description: The process server Fqdn. type: string readOnly: true ipAddresses: description: The list of IP addresses for communicating with the RCM component. type: array items: type: string readOnly: true version: description: The version. type: string readOnly: true lastHeartbeatUtc: format: date-time description: The last heartbeat received from the process server. type: string readOnly: true totalMemoryInBytes: format: int64 description: The total memory. type: integer readOnly: true availableMemoryInBytes: format: int64 description: The available memory. type: integer readOnly: true usedMemoryInBytes: format: int64 description: The used memory. type: integer readOnly: true memoryUsagePercentage: format: double description: The memory usage percentage. type: number readOnly: true totalSpaceInBytes: format: int64 description: The total disk space. type: integer readOnly: true availableSpaceInBytes: format: int64 description: The available disk space. type: integer readOnly: true usedSpaceInBytes: format: int64 description: The used disk space. type: integer readOnly: true freeSpacePercentage: format: double description: The free disk space percentage. type: number readOnly: true throughputUploadPendingDataInBytes: format: int64 description: The uploading pending data in bytes. type: integer readOnly: true throughputInBytes: format: int64 description: The throughput in bytes. type: integer readOnly: true processorUsagePercentage: format: double description: The processor usage percentage. type: number readOnly: true throughputStatus: description: The throughput status. enum: - Healthy - Warning - Critical - Unknown type: string readOnly: true x-ms-enum: name: RcmComponentStatus modelAsString: true systemLoad: format: int64 description: The system load. type: integer readOnly: true systemLoadStatus: description: The system load status. enum: - Healthy - Warning - Critical - Unknown type: string readOnly: true x-ms-enum: name: RcmComponentStatus modelAsString: true diskUsageStatus: description: The disk usage status. enum: - Healthy - Warning - Critical - Unknown type: string readOnly: true x-ms-enum: name: RcmComponentStatus modelAsString: true memoryUsageStatus: description: The memory usage status. enum: - Healthy - Warning - Critical - Unknown type: string readOnly: true x-ms-enum: name: RcmComponentStatus modelAsString: true processorUsageStatus: description: The processor usage status. enum: - Healthy - Warning - Critical - Unknown type: string readOnly: true x-ms-enum: name: RcmComponentStatus modelAsString: true health: description: The health of the process server. enum: - None - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: ProtectionHealth modelAsString: true healthErrors: description: The health errors. type: array items: $ref: '#/definitions/HealthError' readOnly: true protectedItemCount: format: int32 description: The protected item count. type: integer readOnly: true historicHealth: description: >- The historic health of the process server based on the health in last 24 hours. enum: - None - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: ProtectionHealth modelAsString: true ProtectableItem: description: Replication protected item. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/ProtectableItemProperties' description: The custom data. ProtectableItemCollection: description: Protectable item collection. type: object properties: value: description: The Protectable item details. type: array items: $ref: '#/definitions/ProtectableItem' nextLink: description: The value of next link. type: string ProtectableItemProperties: description: Replication protected item custom data details. type: object properties: friendlyName: description: The name. type: string protectionStatus: description: The protection status. type: string replicationProtectedItemId: description: The ARM resource of protected items. type: string recoveryServicesProviderId: description: The recovery provider ARM Id. type: string protectionReadinessErrors: description: The Current protection readiness errors. type: array items: type: string supportedReplicationProviders: description: The list of replication providers supported for the protectable item. type: array items: type: string customDetails: $ref: '#/definitions/ConfigurationSettings' description: The Replication provider custom settings. ProtectableItemQueryParameter: description: Query parameter to enumerate Protectable items. type: object properties: state: description: State of the Protectable item query filter. type: string ProtectedItemsQueryParameter: description: Query parameter to enumerate protected items. type: object properties: sourceFabricName: description: The source fabric name filter. type: string recoveryPlanName: description: The recovery plan filter. type: string sourceFabricLocation: description: The source fabric location filter. type: string fabricObjectId: description: The fabric object Id filter. type: string vCenterName: description: The vCenter name filter. type: string instanceType: description: The replication provider type. type: string multiVmGroupCreateOption: description: Whether Multi VM group is auto created or specified by user. enum: - AutoCreated - UserSpecified type: string x-ms-enum: name: MultiVmGroupCreateOption modelAsString: true processServerId: description: The process server Id filter. type: string ProtectionContainer: description: Protection container details. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/ProtectionContainerProperties' description: The custom data. ProtectionContainerCollection: description: Protection Container collection. type: object properties: value: description: The Protection Container details. type: array items: $ref: '#/definitions/ProtectionContainer' nextLink: description: The value of next link. type: string ProtectionContainerFabricSpecificDetails: description: Base class for fabric specific details of container. type: object properties: instanceType: description: Gets the class type. Overridden in derived classes. type: string readOnly: true ProtectionContainerMapping: description: Protection container mapping object. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/ProtectionContainerMappingProperties' description: The custom data. ProtectionContainerMappingCollection: description: Protection container mapping collection class. type: object properties: value: description: List of container mappings. type: array items: $ref: '#/definitions/ProtectionContainerMapping' nextLink: description: Link to fetch rest of the data. type: string ProtectionContainerMappingProperties: description: Protection container mapping properties. type: object properties: targetProtectionContainerId: description: Paired protection container ARM ID. type: string targetProtectionContainerFriendlyName: description: Friendly name of paired container. type: string providerSpecificDetails: $ref: '#/definitions/ProtectionContainerMappingProviderSpecificDetails' description: Provider specific provider details. health: description: Health of pairing. type: string healthErrorDetails: description: Health error. type: array items: $ref: '#/definitions/HealthError' policyId: description: Policy ARM Id. type: string state: description: Association Status. type: string sourceProtectionContainerFriendlyName: description: Friendly name of source protection container. type: string sourceFabricFriendlyName: description: Friendly name of source fabric. type: string targetFabricFriendlyName: description: Friendly name of target fabric. type: string policyFriendlyName: description: Friendly name of replication policy. type: string ProtectionContainerMappingProviderSpecificDetails: description: Container mapping provider specific details. required: - instanceType type: object properties: instanceType: description: Gets the class type. Overridden in derived classes. type: string discriminator: instanceType ProtectionContainerProperties: description: Protection profile custom data details. type: object properties: fabricFriendlyName: description: Fabric friendly name. type: string friendlyName: description: The name. type: string fabricType: description: The fabric type. type: string protectedItemCount: format: int32 description: Number of protected PEs. type: integer pairingStatus: description: The pairing status of this cloud. type: string role: description: The role of this cloud. type: string fabricSpecificDetails: $ref: '#/definitions/ProtectionContainerFabricSpecificDetails' description: Fabric specific details. ProtectionProfileCustomDetails: description: Protection Profile custom input. required: - resourceType type: object properties: resourceType: description: The class type. type: string discriminator: resourceType ProviderError: description: This class contains the error details per object. type: object properties: errorCode: format: int32 description: The Error code. type: integer errorMessage: description: The Error message. type: string errorId: description: The Provider error Id. type: string possibleCauses: description: The possible causes for the error. type: string recommendedAction: description: The recommended action to resolve the error. type: string ProviderSpecificRecoveryPointDetails: description: Replication provider specific recovery point details. required: - instanceType type: object properties: instanceType: description: Gets the provider type. type: string discriminator: instanceType PushInstallerDetails: description: Push installer details. type: object properties: id: description: The push installer Id. type: string readOnly: true name: description: The push installer name. type: string readOnly: true biosId: description: The push installer Bios Id. type: string readOnly: true fabricObjectId: description: The fabric object Id. type: string readOnly: true fqdn: description: The push installer Fqdn. type: string readOnly: true version: description: The version. type: string readOnly: true lastHeartbeatUtc: format: date-time description: The last heartbeat received from the push installer. type: string readOnly: true health: description: The health of the push installer. enum: - None - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: ProtectionHealth modelAsString: true healthErrors: description: The health errors. type: array items: $ref: '#/definitions/HealthError' readOnly: true RcmProxyDetails: description: RCM proxy details. type: object properties: id: description: The RCM proxy Id. type: string readOnly: true name: description: The RCM proxy name. type: string readOnly: true biosId: description: The RCM proxy Bios Id. type: string readOnly: true fabricObjectId: description: The fabric object Id. type: string readOnly: true fqdn: description: The RCM proxy Fqdn. type: string readOnly: true clientAuthenticationType: description: The client authentication type. type: string readOnly: true version: description: The version. type: string readOnly: true lastHeartbeatUtc: format: date-time description: The last heartbeat received from the RCM proxy. type: string readOnly: true health: description: The health of the RCM proxy. enum: - None - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: ProtectionHealth modelAsString: true healthErrors: description: The health errors. type: array items: $ref: '#/definitions/HealthError' readOnly: true RecoveryAvailabilitySetCustomDetails: description: Recovery Availability Set custom input. required: - resourceType type: object properties: resourceType: description: The class type. type: string discriminator: resourceType RecoveryPlan: description: Recovery plan details. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/RecoveryPlanProperties' description: The custom details. RecoveryPlanA2ADetails: description: Recovery plan A2A specific details. type: object allOf: - $ref: '#/definitions/RecoveryPlanProviderSpecificDetails' properties: primaryZone: description: The primary zone. type: string recoveryZone: description: The recovery zone. type: string primaryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The primary extended location. recoveryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The recovery extended location. x-ms-discriminator-value: A2A RecoveryPlanA2AFailoverInput: description: Recovery plan A2A failover input. required: - recoveryPointType type: object allOf: - $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' properties: recoveryPointType: description: The recovery point type. enum: - Latest - LatestApplicationConsistent - LatestCrashConsistent - LatestProcessed type: string x-ms-enum: name: A2ARpRecoveryPointType modelAsString: true cloudServiceCreationOption: description: >- A value indicating whether to use recovery cloud service for TFO or not. type: string multiVmSyncPointOption: description: >- A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover. enum: - UseMultiVmSyncRecoveryPoint - UsePerVmRecoveryPoint type: string x-ms-enum: name: MultiVmSyncPointOption modelAsString: true x-ms-discriminator-value: A2A RecoveryPlanA2AInput: description: Recovery plan A2A input. type: object allOf: - $ref: '#/definitions/RecoveryPlanProviderSpecificInput' properties: primaryZone: description: The primary zone. type: string recoveryZone: description: The recovery zone. type: string primaryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The primary extended location. recoveryExtendedLocation: $ref: '#/definitions/ExtendedLocation' description: The recovery extended location. x-ms-discriminator-value: A2A RecoveryPlanAction: description: Recovery plan action details. required: - actionName - failoverTypes - failoverDirections - customDetails type: object properties: actionName: description: The action name. type: string failoverTypes: description: The list of failover types. type: array items: enum: - ReverseReplicate - Commit - PlannedFailover - UnplannedFailover - DisableProtection - TestFailover - TestFailoverCleanup - Failback - FinalizeFailback - CancelFailover - ChangePit - RepairReplication - SwitchProtection - CompleteMigration type: string x-ms-enum: name: ReplicationProtectedItemOperation modelAsString: true failoverDirections: description: The list of failover directions. type: array items: enum: - PrimaryToRecovery - RecoveryToPrimary type: string x-ms-enum: name: PossibleOperationsDirections modelAsString: true customDetails: $ref: '#/definitions/RecoveryPlanActionDetails' description: The custom details. RecoveryPlanActionDetails: description: Recovery plan action custom details. required: - instanceType type: object properties: instanceType: description: >- Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). type: string discriminator: instanceType RecoveryPlanAutomationRunbookActionDetails: description: Recovery plan Automation runbook action details. required: - fabricLocation type: object allOf: - $ref: '#/definitions/RecoveryPlanActionDetails' properties: runbookId: description: The runbook ARM Id. type: string timeout: description: The runbook timeout. type: string fabricLocation: description: The fabric location. enum: - Primary - Recovery type: string x-ms-enum: name: RecoveryPlanActionLocation modelAsString: true x-ms-discriminator-value: AutomationRunbookActionDetails RecoveryPlanCollection: description: Recovery plan collection details. type: object properties: value: description: The list of recovery plans. type: array items: $ref: '#/definitions/RecoveryPlan' nextLink: description: The value of next link. type: string RecoveryPlanGroup: description: Recovery plan group details. required: - groupType type: object properties: groupType: description: The group type. enum: - Shutdown - Boot - Failover type: string x-ms-enum: name: RecoveryPlanGroupType modelAsString: true replicationProtectedItems: description: The list of protected items. type: array items: $ref: '#/definitions/RecoveryPlanProtectedItem' startGroupActions: description: The start group actions. type: array items: $ref: '#/definitions/RecoveryPlanAction' endGroupActions: description: The end group actions. type: array items: $ref: '#/definitions/RecoveryPlanAction' RecoveryPlanGroupTaskDetails: description: This class represents the recovery plan group task. required: - instanceType type: object allOf: - $ref: '#/definitions/GroupTaskDetails' properties: name: description: The name. type: string groupId: description: The group identifier. type: string rpGroupType: description: The group type. type: string discriminator: instanceType x-ms-discriminator-value: RecoveryPlanGroupTaskDetails RecoveryPlanHyperVReplicaAzureFailbackInput: description: Recovery plan HVR Azure failback input. required: - dataSyncOption - recoveryVmCreationOption type: object allOf: - $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' properties: dataSyncOption: description: The data sync option. enum: - ForDownTime - ForSynchronization type: string x-ms-enum: name: DataSyncStatus modelAsString: true recoveryVmCreationOption: description: The ALR option. enum: - CreateVmIfNotFound - NoAction type: string x-ms-enum: name: AlternateLocationRecoveryOption modelAsString: true x-ms-discriminator-value: HyperVReplicaAzureFailback RecoveryPlanHyperVReplicaAzureFailoverInput: description: Recovery plan HVR Azure failover input. type: object allOf: - $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' properties: primaryKekCertificatePfx: description: The primary KEK certificate PFX. type: string secondaryKekCertificatePfx: description: The secondary KEK certificate PFX. type: string recoveryPointType: description: The recovery point type. enum: - Latest - LatestApplicationConsistent - LatestProcessed type: string x-ms-enum: name: HyperVReplicaAzureRpRecoveryPointType modelAsString: true x-ms-discriminator-value: HyperVReplicaAzure RecoveryPlanInMageAzureV2FailoverInput: description: Recovery plan InMageAzureV2 failover input. required: - recoveryPointType type: object allOf: - $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' properties: recoveryPointType: description: The recovery point type. enum: - Latest - LatestApplicationConsistent - LatestCrashConsistent - LatestProcessed type: string x-ms-enum: name: InMageV2RpRecoveryPointType modelAsString: true useMultiVmSyncPoint: description: >- A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover. type: string x-ms-discriminator-value: InMageAzureV2 RecoveryPlanInMageFailoverInput: description: Recovery plan InMage failover input. required: - recoveryPointType type: object allOf: - $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' properties: recoveryPointType: description: The recovery point type. enum: - LatestTime - LatestTag - Custom type: string x-ms-enum: name: RpInMageRecoveryPointType modelAsString: true x-ms-discriminator-value: InMage RecoveryPlanInMageRcmFailbackFailoverInput: description: Recovery plan InMageRcmFailback failover input. required: - recoveryPointType type: object allOf: - $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' properties: recoveryPointType: description: The recovery point type. enum: - ApplicationConsistent - CrashConsistent type: string x-ms-enum: name: InMageRcmFailbackRecoveryPointType modelAsString: true useMultiVmSyncPoint: description: >- A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover. type: string x-ms-discriminator-value: InMageRcmFailback RecoveryPlanInMageRcmFailoverInput: description: Recovery plan InMageRcm failover input. required: - recoveryPointType type: object allOf: - $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' properties: recoveryPointType: description: The recovery point type. enum: - Latest - LatestApplicationConsistent - LatestCrashConsistent - LatestProcessed type: string x-ms-enum: name: RecoveryPlanPointType modelAsString: true useMultiVmSyncPoint: description: >- A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover. type: string x-ms-discriminator-value: InMageRcm RecoveryPlanManualActionDetails: description: Recovery plan manual action details. type: object allOf: - $ref: '#/definitions/RecoveryPlanActionDetails' properties: description: description: The manual action description. type: string x-ms-discriminator-value: ManualActionDetails RecoveryPlanPlannedFailoverInput: description: Recovery plan planned failover input. required: - properties type: object properties: properties: $ref: '#/definitions/RecoveryPlanPlannedFailoverInputProperties' description: The recovery plan planned failover input properties. RecoveryPlanPlannedFailoverInputProperties: description: Recovery plan planned failover input properties. required: - failoverDirection type: object properties: failoverDirection: description: The failover direction. enum: - PrimaryToRecovery - RecoveryToPrimary type: string x-ms-enum: name: PossibleOperationsDirections modelAsString: true providerSpecificDetails: description: The provider specific properties. type: array items: $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' RecoveryPlanProperties: description: Recovery plan properties. type: object properties: friendlyName: description: The friendly name. type: string primaryFabricId: description: The primary fabric Id. type: string primaryFabricFriendlyName: description: The primary fabric friendly name. type: string recoveryFabricId: description: The recovery fabric Id. type: string recoveryFabricFriendlyName: description: The recovery fabric friendly name. type: string failoverDeploymentModel: description: The failover deployment model. type: string replicationProviders: description: The list of replication providers. type: array items: type: string allowedOperations: description: The list of allowed operations. type: array items: type: string lastPlannedFailoverTime: format: date-time description: The start time of the last planned failover. type: string lastUnplannedFailoverTime: format: date-time description: The start time of the last unplanned failover. type: string lastTestFailoverTime: format: date-time description: The start time of the last test failover. type: string currentScenario: $ref: '#/definitions/CurrentScenarioDetails' description: The current scenario details. currentScenarioStatus: description: The recovery plan status. type: string currentScenarioStatusDescription: description: The recovery plan status description. type: string groups: description: The recovery plan groups. type: array items: $ref: '#/definitions/RecoveryPlanGroup' providerSpecificDetails: description: The provider id and provider specific details. type: array items: $ref: '#/definitions/RecoveryPlanProviderSpecificDetails' RecoveryPlanProtectedItem: description: Recovery plan protected item. type: object properties: id: description: The ARM Id of the recovery plan protected item. type: string virtualMachineId: description: The virtual machine Id. type: string RecoveryPlanProviderSpecificDetails: description: Recovery plan provider specific details. required: - instanceType type: object properties: instanceType: description: Gets the Instance type. type: string discriminator: instanceType RecoveryPlanProviderSpecificFailoverInput: description: Recovery plan provider specific failover input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType RecoveryPlanProviderSpecificInput: description: Recovery plan provider specific input base class. required: - instanceType type: object properties: instanceType: description: Gets the Instance type. type: string discriminator: instanceType RecoveryPlanScriptActionDetails: description: Recovery plan script action details. required: - path - fabricLocation type: object allOf: - $ref: '#/definitions/RecoveryPlanActionDetails' properties: path: description: The script path. type: string timeout: description: The script timeout. type: string fabricLocation: description: The fabric location. enum: - Primary - Recovery type: string x-ms-enum: name: RecoveryPlanActionLocation modelAsString: true x-ms-discriminator-value: ScriptActionDetails RecoveryPlanShutdownGroupTaskDetails: description: This class represents the recovery plan shutdown group task details. type: object allOf: - $ref: '#/definitions/RecoveryPlanGroupTaskDetails' properties: {} x-ms-discriminator-value: RecoveryPlanShutdownGroupTaskDetails RecoveryPlanTestFailoverCleanupInput: description: Recovery plan test failover cleanup input. required: - properties type: object properties: properties: $ref: '#/definitions/RecoveryPlanTestFailoverCleanupInputProperties' description: The recovery plan test failover cleanup input properties. RecoveryPlanTestFailoverCleanupInputProperties: description: Recovery plan test failover cleanup input properties. type: object properties: comments: description: The test failover cleanup comments. maxLength: 1024 type: string RecoveryPlanTestFailoverInput: description: Recovery plan test failover input. required: - properties type: object properties: properties: $ref: '#/definitions/RecoveryPlanTestFailoverInputProperties' description: The recovery plan test failover input properties. RecoveryPlanTestFailoverInputProperties: description: Recovery plan test failover input properties. required: - failoverDirection - networkType type: object properties: failoverDirection: description: The failover direction. enum: - PrimaryToRecovery - RecoveryToPrimary type: string x-ms-enum: name: PossibleOperationsDirections modelAsString: true networkType: description: The network type to be used for test failover. type: string networkId: description: The Id of the network to be used for test failover. type: string providerSpecificDetails: description: The provider specific properties. maxLength: 1 type: array items: $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' RecoveryPlanUnplannedFailoverInput: description: Recovery plan unplanned failover input. required: - properties type: object properties: properties: $ref: '#/definitions/RecoveryPlanUnplannedFailoverInputProperties' description: The recovery plan unplanned failover input properties. RecoveryPlanUnplannedFailoverInputProperties: description: Recovery plan unplanned failover input properties. required: - failoverDirection - sourceSiteOperations type: object properties: failoverDirection: description: The failover direction. enum: - PrimaryToRecovery - RecoveryToPrimary type: string x-ms-enum: name: PossibleOperationsDirections modelAsString: true sourceSiteOperations: description: A value indicating whether source site operations are required. enum: - Required - NotRequired type: string x-ms-enum: name: SourceSiteOperations modelAsString: true providerSpecificDetails: description: The provider specific properties. maxLength: 1 type: array items: $ref: '#/definitions/RecoveryPlanProviderSpecificFailoverInput' RecoveryPoint: description: Recovery point. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/RecoveryPointProperties' description: The recovery point properties. RecoveryPointCollection: description: Collection of recovery point details. type: object properties: value: description: The recovery point details. type: array items: $ref: '#/definitions/RecoveryPoint' nextLink: description: The value of next link. type: string RecoveryPointProperties: description: Recovery point properties. type: object properties: recoveryPointTime: format: date-time description: The recovery point time. type: string recoveryPointType: description: 'The recovery point type: ApplicationConsistent, CrashConsistent.' type: string providerSpecificDetails: $ref: '#/definitions/ProviderSpecificRecoveryPointDetails' description: The provider specific details for the recovery point. RecoveryProximityPlacementGroupCustomDetails: description: Recovery Proximity placement group custom input. required: - resourceType type: object properties: resourceType: description: The class type. type: string discriminator: resourceType RecoveryResourceGroupCustomDetails: description: Recovery Resource Group custom input. required: - resourceType type: object properties: resourceType: description: The class type. type: string discriminator: resourceType RecoveryServicesProvider: description: Provider details. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/RecoveryServicesProviderProperties' description: Provider properties. RecoveryServicesProviderCollection: description: Collection of providers. type: object properties: value: description: The Servers details. type: array items: $ref: '#/definitions/RecoveryServicesProvider' nextLink: description: The value of next link. type: string RecoveryServicesProviderProperties: description: Recovery services provider properties. type: object properties: fabricType: description: Type of the site. type: string friendlyName: description: Friendly name of the DRA. type: string providerVersion: description: The provider version. type: string serverVersion: description: The fabric provider. type: string providerVersionState: description: DRA version status. type: string providerVersionExpiryDate: format: date-time description: Expiry date of the version. type: string fabricFriendlyName: description: The fabric friendly name. type: string lastHeartBeat: format: date-time description: Time when last heartbeat was sent by the DRA. type: string connectionStatus: description: A value indicating whether DRA is responsive. type: string protectedItemCount: format: int32 description: Number of protected VMs currently managed by the DRA. type: integer allowedScenarios: description: The scenarios allowed on this provider. type: array items: type: string healthErrorDetails: description: The recovery services provider health error details. type: array items: $ref: '#/definitions/HealthError' draIdentifier: description: The DRA Id. type: string machineId: description: The machine Id. type: string machineName: description: The machine name. type: string biosId: description: The Bios Id. type: string 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: description: Recovery Virtual network custom input. required: - resourceType type: object properties: resourceType: description: The class type. type: string discriminator: resourceType RemoveDisksInput: description: Input for remove disk(s) operation. type: object properties: properties: $ref: '#/definitions/RemoveDisksInputProperties' description: Remove disk input properties. RemoveDisksInputProperties: description: Remove Disk input properties. type: object 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: description: Remove Disk provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType RemoveProtectionContainerMappingInput: description: Container unpairing input. type: object properties: properties: $ref: '#/definitions/RemoveProtectionContainerMappingInputProperties' description: Configure protection input properties. RemoveProtectionContainerMappingInputProperties: description: Unpairing input properties. type: object properties: providerSpecificInput: $ref: '#/definitions/ReplicationProviderContainerUnmappingInput' description: Provider specific input for unpairing. RenewCertificateInput: description: Certificate renewal input. type: object properties: properties: $ref: '#/definitions/RenewCertificateInputProperties' description: Renew certificate input properties. RenewCertificateInputProperties: description: Renew Certificate input properties. type: object properties: renewCertificateType: description: Renew certificate type. type: string ReplicationAgentDetails: description: Replication agent details. type: object properties: id: description: The replication agent Id. type: string readOnly: true name: description: The replication agent name. type: string readOnly: true biosId: description: The replication agent Bios Id. type: string readOnly: true fabricObjectId: description: The fabric object Id. type: string readOnly: true fqdn: description: The replication agent Fqdn. type: string readOnly: true version: description: The version. type: string readOnly: true lastHeartbeatUtc: format: date-time description: The last heartbeat received from the replication agent. type: string readOnly: true health: description: The health of the replication agent. enum: - None - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: ProtectionHealth modelAsString: true healthErrors: description: The health errors. type: array items: $ref: '#/definitions/HealthError' readOnly: true ReplicationAppliance: description: Replication appliance definition. type: object properties: properties: $ref: '#/definitions/ReplicationApplianceProperties' description: Appliance related data. ReplicationApplianceProperties: description: Replication appliance properties. type: object properties: providerSpecificDetails: $ref: '#/definitions/ApplianceSpecificDetails' description: Provider specific settings. ReplicationEligibilityResults: description: Replication eligibility results response model. type: object properties: name: description: Gets the name of this object. type: string readOnly: true type: description: Gets the object type. type: string readOnly: true id: description: Gets Unique ARM identifier for this object. type: string readOnly: true properties: $ref: '#/definitions/ReplicationEligibilityResultsProperties' description: Gets properties model for replication eligibility results API. readOnly: true ReplicationEligibilityResultsCollection: description: Replication eligibility results collection response model. type: object properties: value: description: The replication eligibility results details. uniqueItems: false type: array items: $ref: '#/definitions/ReplicationEligibilityResults' ReplicationEligibilityResultsErrorInfo: description: Error model that can be exposed to the user. type: object properties: code: description: The error code. type: string message: description: The error message. type: string possibleCauses: description: The possible causes. type: string recommendedAction: description: The recommended action. type: string status: description: The error status. readOnly: true type: string ReplicationEligibilityResultsProperties: description: Properties model for replication eligibility results API. type: object properties: clientRequestId: description: The client request Id. readOnly: true type: string errors: description: The error details. type: array uniqueItems: false items: $ref: '#/definitions/ReplicationEligibilityResultsErrorInfo' ReplicationGroupDetails: description: Replication group details. This will be used in case of San. type: object allOf: - $ref: '#/definitions/ConfigurationSettings' properties: {} x-ms-discriminator-value: ReplicationGroupDetails ReplicationProtectedItem: description: Replication protected item. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/ReplicationProtectedItemProperties' description: The custom data. ReplicationProtectedItemCollection: description: Replication protected item collection. type: object properties: value: description: The Replication protected item details. type: array items: $ref: '#/definitions/ReplicationProtectedItem' nextLink: description: The value of next link. type: string ReplicationProtectedItemProperties: description: Replication protected item custom data details. type: object properties: friendlyName: description: The name. type: string protectedItemType: description: The type of protected item type. type: string protectableItemId: description: The protected item ARM Id. type: string recoveryServicesProviderId: description: The recovery provider ARM Id. type: string primaryFabricFriendlyName: description: The friendly name of the primary fabric. type: string primaryFabricProvider: description: The fabric provider of the primary fabric. type: string recoveryFabricFriendlyName: description: The friendly name of recovery fabric. type: string recoveryFabricId: description: The Arm Id of recovery fabric. type: string primaryProtectionContainerFriendlyName: description: The name of primary protection container friendly name. type: string recoveryProtectionContainerFriendlyName: description: The name of recovery container friendly name. type: string protectionState: description: The protection status. type: string protectionStateDescription: description: The protection state description. type: string activeLocation: description: The Current active location of the PE. type: string testFailoverState: description: The Test failover state. type: string testFailoverStateDescription: description: The Test failover state description. type: string switchProviderState: description: The switch provider state. type: string switchProviderStateDescription: description: The switch provider state description. type: string allowedOperations: description: The allowed operations on the Replication protected item. type: array items: type: string replicationHealth: 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. type: string failoverHealth: description: The consolidated failover health for the VM. type: string healthErrors: description: List of health errors. type: array items: $ref: '#/definitions/HealthError' policyId: description: The ID of Policy governing this PE. type: string policyFriendlyName: description: The name of Policy governing this PE. type: string lastSuccessfulFailoverTime: format: date-time description: The Last successful failover time. type: string lastSuccessfulTestFailoverTime: format: date-time description: The Last successful test failover time. type: string currentScenario: $ref: '#/definitions/CurrentScenarioDetails' description: The current scenario. failoverRecoveryPointId: description: The recovery point ARM Id to which the Vm was failed over. type: string providerSpecificDetails: $ref: '#/definitions/ReplicationProviderSpecificSettings' description: The Replication provider custom settings. recoveryContainerId: description: The recovery container Id. type: string eventCorrelationId: description: The correlation Id for events associated with this protected item. type: string ReplicationProtectionIntent: description: Replication protection intent. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/ReplicationProtectionIntentProperties' description: The custom data. ReplicationProtectionIntentCollection: description: Replication protection intent objects collection. type: object properties: value: description: The Replication protection intent details. type: array items: $ref: '#/definitions/ReplicationProtectionIntent' nextLink: description: The value of next link. type: string ReplicationProtectionIntentProperties: description: Replication protection intent custom data details. type: object properties: friendlyName: description: The name. type: string jobId: description: The job Id. type: string readOnly: true jobState: description: The job state. type: string readOnly: true isActive: description: A value indicating whether the intent object is active. type: boolean readOnly: true creationTimeUTC: description: The creation time in UTC. type: string readOnly: true providerSpecificDetails: $ref: '#/definitions/ReplicationProtectionIntentProviderSpecificSettings' description: The Replication provider custom settings. ReplicationProtectionIntentProviderSpecificSettings: description: Replication provider specific settings. required: - instanceType type: object properties: instanceType: description: Gets the Instance type. type: string discriminator: instanceType ReplicationProviderContainerUnmappingInput: description: Provider specific input for unpairing operations. type: object properties: instanceType: description: The class type. type: string ReplicationProviderSpecificContainerCreationInput: description: Provider specific input for container creation operation. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType ReplicationProviderSpecificContainerMappingInput: description: Provider specific input for pairing operations. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType ReplicationProviderSpecificSettings: description: Replication provider specific settings. required: - instanceType type: object properties: instanceType: description: Gets the Instance type. type: string discriminator: instanceType ReplicationProviderSpecificUpdateContainerMappingInput: description: Provider specific input for update pairing operations. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType ReprotectAgentDetails: description: Reprotect agent details. type: object properties: id: description: The reprotect agent Id. type: string readOnly: true name: description: The reprotect agent name. type: string readOnly: true biosId: description: The reprotect agent Bios Id. type: string readOnly: true fabricObjectId: description: The fabric object Id. type: string readOnly: true fqdn: description: The reprotect agent Fqdn. type: string readOnly: true version: description: The version. type: string readOnly: true lastHeartbeatUtc: format: date-time description: The last heartbeat received from the reprotect agent. type: string readOnly: true health: description: The health of the reprotect agent. enum: - None - Normal - Warning - Critical type: string readOnly: true x-ms-enum: name: ProtectionHealth modelAsString: true healthErrors: description: The health errors. type: array items: $ref: '#/definitions/HealthError' readOnly: true protectedItemCount: format: int32 description: The protected item count. type: integer readOnly: true accessibleDatastores: description: The list of accessible datastores fetched from discovery. type: array items: type: string readOnly: true vcenterId: description: The Vcenter Id. type: string readOnly: true lastDiscoveryInUtc: format: date-time description: The last time when SDS information discovered in SRS. type: string readOnly: true ResolveHealthError: description: Resolve health errors input properties. type: object properties: healthErrorId: description: Health error id. type: string ResolveHealthInput: description: Resolve health input. type: object properties: properties: $ref: '#/definitions/ResolveHealthInputProperties' description: Disable resolve health input properties. ResolveHealthInputProperties: description: Resolve health input properties. type: object properties: healthErrors: description: Health errors. type: array items: $ref: '#/definitions/ResolveHealthError' Resource: description: Azure resource. type: object properties: id: description: Resource Id type: string readOnly: true name: description: Resource Name type: string readOnly: true type: description: Resource Type type: string readOnly: true location: description: Resource Location type: string x-ms-azure-resource: true ResourceHealthSummary: description: >- Base class to define the health summary of the resources contained under an Arm resource. type: object properties: resourceCount: format: int32 description: The count of total resources under the container. type: integer issues: description: >- The list of summary of health errors across the resources under the container. type: array items: $ref: '#/definitions/HealthErrorSummary' categorizedResourceCounts: description: The categorized resource counts. type: object additionalProperties: format: int32 type: integer ResumeJobParams: description: Resume job params. type: object properties: properties: $ref: '#/definitions/ResumeJobParamsProperties' description: Resume job properties. ResumeJobParamsProperties: description: Resume job properties. type: object properties: comments: description: Resume job comments. type: string ResumeReplicationInput: description: Resume replication input. required: - properties type: object properties: properties: $ref: '#/definitions/ResumeReplicationInputProperties' description: Resume replication input properties. ResumeReplicationInputProperties: description: Resume replication input properties. required: - providerSpecificDetails type: object properties: providerSpecificDetails: $ref: '#/definitions/ResumeReplicationProviderSpecificInput' description: The provider specific input for resume replication. ResumeReplicationProviderSpecificInput: description: Resume replication provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType ResyncInput: description: Resync input. required: - properties type: object properties: properties: $ref: '#/definitions/ResyncInputProperties' description: Resync input properties. ResyncInputProperties: description: Resync input properties. required: - providerSpecificDetails type: object properties: providerSpecificDetails: $ref: '#/definitions/ResyncProviderSpecificInput' description: The provider specific details. ResyncProviderSpecificInput: description: Resync provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType RetentionVolume: description: The retention details of the MT. type: object properties: volumeName: description: The volume name. type: string capacityInBytes: format: int64 description: The volume capacity. type: integer freeSpaceInBytes: format: int64 description: The free space available in this volume. type: integer thresholdPercentage: format: int32 description: The threshold percentage. type: integer ReverseReplicationInput: description: Reverse replication input. type: object properties: properties: $ref: '#/definitions/ReverseReplicationInputProperties' description: Reverse replication properties. ReverseReplicationInputProperties: description: Reverse replication input properties. type: object properties: failoverDirection: description: Failover direction. type: string providerSpecificDetails: $ref: '#/definitions/ReverseReplicationProviderSpecificInput' description: Provider specific reverse replication input. ReverseReplicationProviderSpecificInput: description: Provider specific reverse replication input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType RoleAssignment: description: Azure role assignment details. type: object properties: id: description: The ARM Id of the role assignment. type: string name: description: The name of the role assignment. type: string scope: description: Role assignment scope. type: string principalId: description: Principal Id. type: string roleDefinitionId: description: Role definition id. type: string RunAsAccount: description: CS Accounts Details. type: object properties: accountId: description: The CS RunAs account Id. type: string accountName: description: The CS RunAs account name. type: string ScriptActionTaskDetails: description: This class represents the script action task details. type: object allOf: - $ref: '#/definitions/TaskTypeDetails' properties: name: description: The name. type: string path: description: The path. type: string output: description: The output. type: string isPrimarySideScript: description: A value indicating whether it is a primary side script or not. type: boolean x-ms-discriminator-value: ScriptActionTaskDetails ServiceError: description: ASR error model. type: object properties: code: description: Error code. type: string message: description: Error message. type: string possibleCauses: description: Possible causes of error. type: string recommendedAction: description: Recommended action to resolve error. type: string activityId: description: Activity Id. type: string 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 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 StorageAccountCustomDetails: description: Storage account custom input. required: - resourceType type: object properties: resourceType: description: The class type. type: string discriminator: resourceType StorageClassification: description: Storage object definition. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/StorageClassificationProperties' description: Properties of the storage object. StorageClassificationCollection: description: Collection of storage details. type: object properties: value: description: The storage details. type: array items: $ref: '#/definitions/StorageClassification' nextLink: description: The value of next link. type: string StorageClassificationMapping: description: Storage mapping object. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/StorageClassificationMappingProperties' description: Properties of the storage mapping object. StorageClassificationMappingCollection: description: Collection of storage mapping details. type: object properties: value: description: The storage details. type: array items: $ref: '#/definitions/StorageClassificationMapping' nextLink: description: The value of next link. type: string StorageClassificationMappingInput: description: Storage mapping input. type: object properties: properties: $ref: '#/definitions/StorageMappingInputProperties' description: Storage mapping input properties. StorageClassificationMappingProperties: description: Storage mapping properties. type: object properties: targetStorageClassificationId: description: Target storage object Id. type: string StorageClassificationProperties: description: Storage object properties. type: object properties: friendlyName: description: Friendly name of the Storage classification. type: string StorageMappingInputProperties: description: Storage mapping input properties. type: object properties: targetStorageClassificationId: description: The ID of the storage object. type: string Subnet: description: Subnets of the network. type: object properties: name: description: The subnet name. type: string friendlyName: description: The subnet friendly name. type: string addressList: description: The list of addresses for the subnet. type: array items: type: string SupportedOperatingSystems: description: Supported operating systems. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/SupportedOSProperties' description: The supported operating systems properties. SupportedOSDetails: description: Supported operating system details. type: object properties: osName: description: The name. type: string osType: description: The type. type: string osVersions: description: The list of version for operating system. type: array items: $ref: '#/definitions/OSVersionWrapper' SupportedOSProperties: description: Supported operating systems properties. type: object properties: supportedOsList: description: The supported operating systems property list. type: array items: $ref: '#/definitions/SupportedOSProperty' SupportedOSProperty: description: Supported operating systems property. type: object properties: instanceType: description: The replication provider type. type: string supportedOs: description: The list of supported operating systems. type: array items: $ref: '#/definitions/SupportedOSDetails' SwitchProtectionInput: description: Switch protection input. type: object properties: properties: $ref: '#/definitions/SwitchProtectionInputProperties' description: Switch protection properties. SwitchProtectionInputProperties: description: Switch protection input properties. type: object properties: replicationProtectedItemName: description: The unique replication protected item name. type: string providerSpecificDetails: $ref: '#/definitions/SwitchProtectionProviderSpecificInput' description: Provider specific switch protection input. SwitchProtectionJobDetails: description: This class represents details for switch protection job. type: object allOf: - $ref: '#/definitions/JobDetails' properties: newReplicationProtectedItemId: description: ARM Id of the new replication protected item. type: string x-ms-discriminator-value: SwitchProtectionJobDetails SwitchProtectionProviderSpecificInput: description: Provider specific switch protection input. required: - instanceType type: object properties: instanceType: description: Gets the Instance type. type: string discriminator: instanceType SwitchProviderInput: description: Input definition for switch provider. type: object properties: properties: $ref: '#/definitions/SwitchProviderInputProperties' description: Switch provider input properties. SwitchProviderInputProperties: description: Input definition for switch provider input properties. type: object properties: targetInstanceType: description: Target provider type. type: string providerSpecificDetails: $ref: '#/definitions/SwitchProviderProviderSpecificInput' description: Provider specific settings. SwitchProviderProviderSpecificInput: description: Provider specific switch provider input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType TargetComputeSize: description: Represents applicable recovery vm sizes. type: object properties: id: description: The Id. type: string name: description: The name. type: string type: description: The Type of the object. type: string properties: $ref: '#/definitions/TargetComputeSizeProperties' description: The custom data. TargetComputeSizeCollection: description: Target compute size collection. type: object properties: value: description: The list of target compute sizes. type: array items: $ref: '#/definitions/TargetComputeSize' nextLink: description: The value of next link. type: string TargetComputeSizeProperties: description: Represents applicable recovery vm sizes properties. type: object properties: name: description: Target compute size name. type: string friendlyName: description: Target compute size display name. type: string cpuCoresCount: format: int32 description: The maximum cpu cores count supported by target compute size. type: integer vCPUsAvailable: format: int32 description: The Available vCPUs supported by target compute size. type: integer readOnly: true memoryInGB: format: double description: The maximum memory in GB supported by target compute size. type: number maxDataDiskCount: format: int32 description: The maximum data disks count supported by target compute size. type: integer maxNicsCount: format: int32 description: The maximum Nics count supported by target compute size. type: integer errors: description: >- The reasons why the target compute size is not applicable for the protected item. type: array items: $ref: '#/definitions/ComputeSizeErrorDetails' highIopsSupported: description: >- The value indicating whether the target compute size supports high Iops. type: string hyperVGenerations: description: The supported HyperV Generations. type: array items: type: string TaskTypeDetails: description: Task details based on specific task type. required: - instanceType type: object properties: instanceType: description: The type of task details. type: string discriminator: instanceType TestFailoverCleanupInput: description: Input definition for test failover cleanup. required: - properties type: object properties: properties: $ref: '#/definitions/TestFailoverCleanupInputProperties' description: Test failover cleanup input properties. TestFailoverCleanupInputProperties: description: Input definition for test failover cleanup input properties. type: object properties: comments: description: Test failover cleanup comments. maxLength: 1024 type: string TestFailoverInput: description: Input definition for test failover. required: - properties type: object properties: properties: $ref: '#/definitions/TestFailoverInputProperties' description: Test failover input properties. TestFailoverInputProperties: description: Input definition for test failover input properties. type: object properties: failoverDirection: description: Test failover direction. type: string networkType: description: Network type to be used for test failover. type: string networkId: description: The id of the network to be used for test failover. type: string providerSpecificDetails: $ref: '#/definitions/TestFailoverProviderSpecificInput' description: Provider specific settings. TestFailoverJobDetails: description: This class represents the details for a test failover job. type: object allOf: - $ref: '#/definitions/JobDetails' properties: testFailoverStatus: description: The test failover status. type: string comments: description: The test failover comments. type: string networkName: description: The test network name. type: string networkFriendlyName: description: The test network friendly name. type: string networkType: description: >- The test network type (see TestFailoverInput enum for possible values). type: string protectedItemDetails: description: The test VM details. type: array items: $ref: '#/definitions/FailoverReplicationProtectedItemDetails' x-ms-discriminator-value: TestFailoverJobDetails TestFailoverProviderSpecificInput: description: Provider specific test failover input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType TestMigrateCleanupInput: description: Input for test migrate cleanup. required: - properties type: object properties: properties: $ref: '#/definitions/TestMigrateCleanupInputProperties' description: Test migrate cleanup input properties. TestMigrateCleanupInputProperties: description: Test migrate cleanup input properties. type: object properties: comments: description: Test migrate cleanup comments. maxLength: 1024 type: string TestMigrateInput: description: Input for test migrate. required: - properties type: object properties: properties: $ref: '#/definitions/TestMigrateInputProperties' description: Test migrate input properties. TestMigrateInputProperties: description: Test migrate input properties. required: - providerSpecificDetails type: object properties: providerSpecificDetails: $ref: '#/definitions/TestMigrateProviderSpecificInput' description: The provider specific details. TestMigrateProviderSpecificInput: description: Test migrate provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType UnplannedFailoverInput: description: Input definition for unplanned failover. required: - properties type: object properties: properties: $ref: '#/definitions/UnplannedFailoverInputProperties' description: Unplanned failover input properties. UnplannedFailoverInputProperties: description: Input definition for unplanned failover input properties. type: object properties: failoverDirection: description: Failover direction. type: string sourceSiteOperations: description: Source site operations status. type: string providerSpecificDetails: $ref: '#/definitions/UnplannedFailoverProviderSpecificInput' description: Provider specific settings. UnplannedFailoverProviderSpecificInput: description: Provider specific unplanned failover input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType UpdateApplianceForReplicationProtectedItemInput: description: Update appliance for replication protected item input. required: - properties type: object properties: properties: $ref: >- #/definitions/UpdateApplianceForReplicationProtectedItemInputProperties description: Update appliance replication protected item properties. UpdateApplianceForReplicationProtectedItemInputProperties: description: Update appliance for protected item input properties. required: - targetApplianceId - providerSpecificDetails type: object properties: targetApplianceId: description: The target appliance Id. type: string providerSpecificDetails: $ref: >- #/definitions/UpdateApplianceForReplicationProtectedItemProviderSpecificInput description: The provider specific input to update replication protected item. UpdateApplianceForReplicationProtectedItemProviderSpecificInput: description: Update replication protected item provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType UpdateDiskInput: description: Disk input for update. required: - diskId type: object properties: diskId: description: The disk Id. type: string targetDiskName: description: The target disk name. type: string UpdateMigrationItemInput: description: Update migration item input. type: object properties: properties: $ref: '#/definitions/UpdateMigrationItemInputProperties' description: Update migration item input properties. UpdateMigrationItemInputProperties: description: Update migration item input properties. required: - providerSpecificDetails type: object properties: providerSpecificDetails: $ref: '#/definitions/UpdateMigrationItemProviderSpecificInput' description: The provider specific input to update migration item. UpdateMigrationItemProviderSpecificInput: description: Update migration item provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType UpdateMobilityServiceRequest: description: Request to update the mobility service on a protected item. type: object properties: properties: $ref: '#/definitions/UpdateMobilityServiceRequestProperties' description: The properties of the update mobility service request. UpdateMobilityServiceRequestProperties: description: The properties of an update mobility service request. type: object properties: runAsAccountId: description: The CS run as account Id. type: string UpdateNetworkMappingInput: description: Update network mapping input. type: object properties: properties: $ref: '#/definitions/UpdateNetworkMappingInputProperties' description: The input properties needed to update network mapping. UpdateNetworkMappingInputProperties: description: Common input details for network mapping operation. type: object properties: recoveryFabricName: description: Recovery fabric name. type: string recoveryNetworkId: description: Recovery network Id. type: string fabricSpecificDetails: $ref: '#/definitions/FabricSpecificUpdateNetworkMappingInput' description: Fabrics specific input network Id. UpdatePolicyInput: description: Update policy input. type: object properties: properties: $ref: '#/definitions/UpdatePolicyInputProperties' description: The ReplicationProviderSettings. UpdatePolicyInputProperties: description: Policy update properties. type: object properties: replicationProviderSettings: $ref: '#/definitions/PolicyProviderSpecificInput' description: The ReplicationProviderSettings. UpdateProtectionContainerMappingInput: description: Container pairing update input. type: object properties: properties: $ref: '#/definitions/UpdateProtectionContainerMappingInputProperties' description: Update protection container mapping input properties. UpdateProtectionContainerMappingInputProperties: description: Container pairing update input. type: object properties: providerSpecificInput: $ref: '#/definitions/ReplicationProviderSpecificUpdateContainerMappingInput' description: Provider specific input for updating protection container mapping. UpdateRecoveryPlanInput: description: Update recovery plan input class. type: object properties: properties: $ref: '#/definitions/UpdateRecoveryPlanInputProperties' description: Recovery plan update properties. UpdateRecoveryPlanInputProperties: description: Recovery plan update properties. type: object properties: groups: description: The recovery plan groups. type: array items: $ref: '#/definitions/RecoveryPlanGroup' UpdateReplicationProtectedItemInput: description: Update replication protected item input. type: object properties: properties: $ref: '#/definitions/UpdateReplicationProtectedItemInputProperties' description: Update replication protected item properties. UpdateReplicationProtectedItemInputProperties: description: Update protected item input properties. type: object properties: recoveryAzureVMName: description: Target Azure VM name given by the user. type: string recoveryAzureVMSize: description: Target Azure VM size. type: string selectedRecoveryAzureNetworkId: description: Target Azure Network Id. type: string selectedTfoAzureNetworkId: description: The Azure Network Id for test failover. type: string selectedSourceNicId: description: >- The selected source nic Id which will be used as the primary nic during failover. type: string enableRdpOnTargetOption: description: >- The selected option to enable RDP\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum. type: string vmNics: description: The list of VM nic details. type: array items: $ref: '#/definitions/VMNicInputDetails' licenseType: description: License type. enum: - NotSpecified - NoLicenseType - WindowsServer type: string x-ms-enum: name: LicenseType modelAsString: true recoveryAvailabilitySetId: description: The target availability set Id. type: string providerSpecificDetails: $ref: '#/definitions/UpdateReplicationProtectedItemProviderInput' description: The provider specific input to update replication protected item. UpdateReplicationProtectedItemProviderInput: description: Update replication protected item provider specific input. required: - instanceType type: object properties: instanceType: description: The class type. type: string discriminator: instanceType UpdateVCenterRequest: description: Input required to update vCenter. type: object properties: properties: $ref: '#/definitions/UpdateVCenterRequestProperties' description: The update VCenter Request Properties. UpdateVCenterRequestProperties: description: The properties of an update vCenter request. type: object properties: friendlyName: description: The friendly name of the vCenter. type: string ipAddress: description: The IP address of the vCenter to be discovered. type: string processServerId: description: The process server Id from where the update can be orchestrated. type: string port: description: The port number for discovery. type: string runAsAccountId: description: The CS account Id which has privileges to update the vCenter. type: string VaultHealthDetails: description: Vault health details definition. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/VaultHealthProperties' description: The vault health related data. VaultHealthProperties: description: class to define the health summary of the Vault. type: object properties: vaultErrors: description: The list of errors on the vault. type: array 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: description: Vault setting. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/VaultSettingProperties' description: The vault setting properties. VaultSettingCollection: description: Vault setting collection. type: object properties: value: description: The list of vault setting. type: array items: $ref: '#/definitions/VaultSetting' nextLink: description: The value of next link. type: string VaultSettingCreationInput: description: Input to create vault setting. required: - properties type: object properties: properties: $ref: '#/definitions/VaultSettingCreationInputProperties' description: Vault setting creation input properties. VaultSettingCreationInputProperties: description: Input to create vault setting. type: object properties: migrationSolutionId: description: The migration solution Id. type: string vmwareToAzureProviderType: description: VMware to Azure provider type. type: string VaultSettingProperties: description: Vault setting properties. type: object properties: migrationSolutionId: description: The migration solution ARM Id. type: string vmwareToAzureProviderType: description: VMware to Azure provider type. type: string VCenter: description: vCenter definition. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/VCenterProperties' description: VCenter related data. VCenterCollection: description: Collection of vCenter details. type: object properties: value: description: The vCenter details. type: array items: $ref: '#/definitions/VCenter' nextLink: description: The value of next link. type: string VCenterProperties: description: vCenter properties. type: object properties: friendlyName: description: Friendly name of the vCenter. type: string internalId: description: VCenter internal ID. type: string lastHeartbeat: format: date-time description: The time when the last heartbeat was received by vCenter. type: string discoveryStatus: description: The VCenter discovery status. type: string processServerId: description: The process server Id. type: string ipAddress: description: The IP address of the vCenter. type: string infrastructureId: description: The infrastructure Id of vCenter. type: string port: description: The port number for discovery. type: string runAsAccountId: description: The account Id which has privileges to discover the vCenter. type: string fabricArmResourceName: description: The ARM resource name of the fabric containing this VCenter. type: string healthErrors: description: The health errors for this VCenter. type: array items: $ref: '#/definitions/HealthError' VersionDetails: description: Version related details. type: object properties: version: description: The agent version. type: string expiryDate: format: date-time description: Version expiry date. type: string status: description: A value indicating whether security update required. enum: - Supported - NotSupported - Deprecated - UpdateRequired - SecurityUpdateRequired type: string x-ms-enum: name: AgentVersionStatus modelAsString: true VirtualMachineTaskDetails: description: This class represents the virtual machine task details. type: object allOf: - $ref: '#/definitions/JobTaskDetails' properties: skippedReason: description: The skipped reason. type: string skippedReasonString: description: The skipped reason string. type: string x-ms-discriminator-value: VirtualMachineTaskDetails VmmDetails: description: VMM fabric specific details. type: object allOf: - $ref: '#/definitions/FabricSpecificDetails' properties: {} x-ms-discriminator-value: VMM VmmToAzureCreateNetworkMappingInput: description: >- Create network mappings input properties/behavior specific to Vmm to Azure Network mapping. type: object allOf: - $ref: '#/definitions/FabricSpecificCreateNetworkMappingInput' properties: {} x-ms-discriminator-value: VmmToAzure VmmToAzureNetworkMappingSettings: description: E2A Network Mapping fabric specific settings. type: object allOf: - $ref: '#/definitions/NetworkMappingFabricSpecificSettings' properties: {} x-ms-discriminator-value: VmmToAzure VmmToAzureUpdateNetworkMappingInput: description: >- Update network mappings input properties/behavior specific to vmm to azure. type: object allOf: - $ref: '#/definitions/FabricSpecificUpdateNetworkMappingInput' properties: {} x-ms-discriminator-value: VmmToAzure VmmToVmmCreateNetworkMappingInput: description: >- Create network mappings input properties/behavior specific to vmm to vmm Network mapping. type: object allOf: - $ref: '#/definitions/FabricSpecificCreateNetworkMappingInput' properties: {} x-ms-discriminator-value: VmmToVmm VmmToVmmNetworkMappingSettings: description: E2E Network Mapping fabric specific settings. type: object allOf: - $ref: '#/definitions/NetworkMappingFabricSpecificSettings' properties: {} x-ms-discriminator-value: VmmToVmm VmmToVmmUpdateNetworkMappingInput: description: Update network mappings input properties/behavior specific to vmm to vmm. type: object allOf: - $ref: '#/definitions/FabricSpecificUpdateNetworkMappingInput' properties: {} x-ms-discriminator-value: VmmToVmm VmmVirtualMachineDetails: description: VMM fabric provider specific VM settings. type: object allOf: - $ref: '#/definitions/HyperVVirtualMachineDetails' properties: {} x-ms-discriminator-value: VmmVirtualMachine VMNicDetails: description: Hyper V VM network details. type: object properties: nicId: description: The nic Id. type: string replicaNicId: description: The replica nic Id. type: string sourceNicArmId: description: The source nic ARM Id. type: string vMNetworkName: description: VM network name. type: string recoveryVMNetworkId: description: Recovery VM network Id. type: string ipConfigs: description: The IP configurations of the NIC. type: array items: $ref: '#/definitions/IPConfigDetails' selectionType: description: Selection type for failover. type: string recoveryNetworkSecurityGroupId: description: The id of the NSG associated with the NIC. type: string enableAcceleratedNetworkingOnRecovery: description: A value indicating whether the NIC has accelerated networking enabled. type: boolean tfoVMNetworkId: description: The network to be used by NIC during test failover. type: string tfoNetworkSecurityGroupId: description: The NSG to be used by NIC during test failover. type: string enableAcceleratedNetworkingOnTfo: description: Whether the TFO NIC has accelerated networking enabled. type: boolean recoveryNicName: description: The name of the NIC to be used when creating target NICs. type: string recoveryNicResourceGroupName: description: The resource group of the NIC to be used when creating target NICs. type: string reuseExistingNic: description: >- A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. type: boolean default: false tfoRecoveryNicName: description: The name of the NIC to be used when creating target NICs in TFO. type: string tfoRecoveryNicResourceGroupName: description: >- The resource group of the NIC to be used when creating target NICs in TFO. type: string tfoReuseExistingNic: description: >- A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. type: boolean default: false targetNicName: description: Target NIC name. type: string VMNicInputDetails: description: Hyper V VM network input details. type: object properties: nicId: description: The nic Id. type: string ipConfigs: description: >- The IP configurations to be used by NIC during test failover and failover. type: array items: $ref: '#/definitions/IPConfigInputDetails' selectionType: description: Selection type for failover. type: string recoveryNetworkSecurityGroupId: description: The id of the NSG associated with the NIC. type: string enableAcceleratedNetworkingOnRecovery: description: Whether the NIC has accelerated networking enabled. type: boolean tfoNetworkSecurityGroupId: description: The NSG to be used by NIC during test failover. type: string enableAcceleratedNetworkingOnTfo: description: Whether the test NIC has accelerated networking enabled. type: boolean recoveryNicName: description: The name of the NIC to be used when creating target NICs. type: string recoveryNicResourceGroupName: description: The resource group of the NIC to be used when creating target NICs. type: string reuseExistingNic: description: >- A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. type: boolean tfoNicName: description: The name of the NIC to be used when creating target NICs in TFO. type: string tfoNicResourceGroupName: description: >- The resource group of the NIC to be used when creating target NICs in TFO. type: string tfoReuseExistingNic: description: >- A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. type: boolean targetNicName: description: Target NIC name. type: string VmNicUpdatesTaskDetails: description: This class represents the vm NicUpdates task details. type: object allOf: - $ref: '#/definitions/TaskTypeDetails' properties: vmId: description: Virtual machine Id. type: string nicId: description: Nic Id. type: string name: description: Name of the Nic. type: string x-ms-discriminator-value: VmNicUpdatesTaskDetails VMwareCbtContainerCreationInput: description: VMwareCbt container creation input. type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificContainerCreationInput' properties: {} x-ms-discriminator-value: VMwareCbt VMwareCbtContainerMappingInput: description: VMwareCbt container mapping input. required: - storageAccountId - targetLocation type: object allOf: - $ref: '#/definitions/ReplicationProviderSpecificContainerMappingInput' properties: keyVaultId: description: The target key vault ARM Id. type: string keyVaultUri: description: The target key vault URL. type: string storageAccountId: description: The storage account ARM Id. type: string storageAccountSasSecretName: description: The secret name of the storage account. type: string serviceBusConnectionStringSecretName: description: The secret name of the service bus connection string. type: string targetLocation: description: The target location. type: string x-ms-discriminator-value: VMwareCbt VMwareCbtDiskInput: description: VMwareCbt disk input. required: - diskId - isOSDisk - logStorageAccountId - logStorageAccountSasSecretName type: object properties: diskId: description: The disk Id. type: string diskType: description: The disk type. enum: - Standard_LRS - Premium_LRS - StandardSSD_LRS type: string x-ms-enum: name: DiskAccountType modelAsString: true isOSDisk: description: A value indicating whether the disk is the OS disk. type: string logStorageAccountId: description: The log storage account ARM Id. type: string logStorageAccountSasSecretName: description: The key vault secret name of the log storage account. type: string diskEncryptionSetId: description: The DiskEncryptionSet ARM Id. type: string VMwareCbtEnableMigrationInput: description: VMwareCbt specific enable migration input. required: - vmwareMachineId - disksToInclude - dataMoverRunAsAccountId - snapshotRunAsAccountId - targetResourceGroupId - targetNetworkId - instanceType type: object allOf: - $ref: '#/definitions/EnableMigrationProviderSpecificInput' properties: vmwareMachineId: description: The ARM Id of the VM discovered in VMware. type: string disksToInclude: description: The disks to include list. minLength: 1 type: array items: $ref: '#/definitions/VMwareCbtDiskInput' licenseType: description: License type. enum: - NotSpecified - NoLicenseType - WindowsServer type: string x-ms-enum: name: LicenseType modelAsString: true sqlServerLicenseType: description: The SQL Server license type. enum: - NotSpecified - NoLicenseType - PAYG - AHUB type: string x-ms-enum: name: SqlServerLicenseType modelAsString: true performSqlBulkRegistration: description: A value indicating whether bulk SQL RP registration to be done. type: string dataMoverRunAsAccountId: description: The data mover run as account Id. type: string snapshotRunAsAccountId: description: The snapshot run as account Id. type: string targetVmName: description: The target VM name. type: string targetVmSize: description: The target VM size. type: string targetResourceGroupId: description: The target resource group ARM Id. type: string targetNetworkId: description: The target network ARM Id. type: string testNetworkId: description: The selected test network ARM Id. type: string targetSubnetName: description: The target subnet name. type: string testSubnetName: description: The selected test subnet name. type: string targetAvailabilitySetId: description: The target availability set ARM Id. type: string targetAvailabilityZone: description: The target availability zone. type: string targetProximityPlacementGroupId: description: The target proximity placement group ARM Id. type: string confidentialVmKeyVaultId: description: The confidential VM key vault Id for ADE installation. type: string targetVmSecurityProfile: $ref: '#/definitions/VMwareCbtSecurityProfileProperties' description: The target VM security profile. targetBootDiagnosticsStorageAccountId: description: The target boot diagnostics storage account ARM Id. type: string performAutoResync: description: A value indicating whether auto resync is to be done. type: string targetVmTags: description: The target VM tags. maxLength: 50 type: object additionalProperties: type: string seedDiskTags: description: The tags for the seed disks. maxLength: 49 type: object additionalProperties: type: string targetDiskTags: description: The tags for the target disks. maxLength: 49 type: object additionalProperties: type: string targetNicTags: description: The tags for the target NICs. maxLength: 50 type: object additionalProperties: type: string x-ms-discriminator-value: VMwareCbt VMwareCbtEventDetails: description: Event details for VMwareCbt provider. type: object allOf: - $ref: '#/definitions/EventProviderSpecificDetails' properties: migrationItemName: description: The migration item name. type: string readOnly: true x-ms-discriminator-value: VMwareCbt VMwareCbtMigrateInput: description: VMwareCbt specific migrate input. required: - performShutdown - instanceType type: object allOf: - $ref: '#/definitions/MigrateProviderSpecificInput' properties: performShutdown: description: A value indicating whether VM is to be shutdown. type: string osUpgradeVersion: description: A value indicating the inplace OS Upgrade version. type: string x-ms-discriminator-value: VMwareCbt VMwareCbtMigrationDetails: description: VMwareCbt provider specific settings. type: object allOf: - $ref: '#/definitions/MigrationProviderSpecificSettings' properties: vmwareMachineId: description: The ARM Id of the VM discovered in VMware. type: string readOnly: true osType: description: The type of the OS on the VM. type: string readOnly: true osName: description: The name of the OS on the VM. type: string readOnly: true firmwareType: description: The firmware type. type: string readOnly: true targetGeneration: description: The target generation. type: string readOnly: true licenseType: description: License Type of the VM to be used. type: string sqlServerLicenseType: description: The SQL Server license type. type: string dataMoverRunAsAccountId: description: The data mover run as account Id. type: string readOnly: true snapshotRunAsAccountId: description: The snapshot run as account Id. type: string readOnly: true storageAccountId: description: >- The replication storage account ARM Id. This is applicable only for the blob based replication test hook. type: string readOnly: true targetVmName: description: Target VM name. type: string targetVmSize: description: The target VM size. type: string targetLocation: description: The target location. type: string readOnly: true targetResourceGroupId: description: The target resource group Id. type: string targetAvailabilitySetId: description: The target availability set Id. type: string targetAvailabilityZone: description: The target availability zone. type: string targetProximityPlacementGroupId: description: The target proximity placement group Id. type: string confidentialVmKeyVaultId: description: The confidential VM key vault Id for ADE installation. type: string targetVmSecurityProfile: $ref: '#/definitions/VMwareCbtSecurityProfileProperties' description: The target VM security profile. targetBootDiagnosticsStorageAccountId: description: The target boot diagnostics storage account ARM Id. type: string targetVmTags: description: The target VM tags. type: object additionalProperties: type: string protectedDisks: description: The list of protected disks. type: array items: $ref: '#/definitions/VMwareCbtProtectedDiskDetails' targetNetworkId: description: The target network Id. type: string testNetworkId: description: The test network Id. type: string vmNics: description: The network details. type: array items: $ref: '#/definitions/VMwareCbtNicDetails' targetNicTags: description: The tags for the target NICs. type: object additionalProperties: type: string migrationRecoveryPointId: description: The recovery point Id to which the VM was migrated. type: string readOnly: true lastRecoveryPointReceived: format: date-time description: The last recovery point received time. type: string readOnly: true lastRecoveryPointId: description: The last recovery point Id. type: string readOnly: true initialSeedingProgressPercentage: format: int32 description: The initial seeding progress percentage. type: integer readOnly: true migrationProgressPercentage: format: int32 description: The migration progress percentage. type: integer readOnly: true resyncProgressPercentage: format: int32 description: The resync progress percentage. type: integer readOnly: true resumeProgressPercentage: format: int32 description: The resume progress percentage. type: integer readOnly: true deltaSyncProgressPercentage: format: int32 description: The delta sync progress percentage. type: integer readOnly: true isCheckSumResyncCycle: description: A value indicating whether checksum resync cycle is in progress. type: string readOnly: true initialSeedingRetryCount: format: int64 description: The initial seeding retry count. type: integer readOnly: true resyncRetryCount: format: int64 description: The resync retry count. type: integer readOnly: true resumeRetryCount: format: int64 description: The resume retry count. type: integer readOnly: true deltaSyncRetryCount: format: int64 description: The delta sync retry count. type: integer readOnly: true resyncRequired: description: A value indicating whether resync is required. type: string readOnly: true resyncState: description: The resync state. enum: - None - PreparedForResynchronization - StartedResynchronization type: string readOnly: true x-ms-enum: name: ResyncState modelAsString: true performAutoResync: description: A value indicating whether auto resync is to be done. type: string seedDiskTags: description: The tags for the seed disks. type: object additionalProperties: type: string targetDiskTags: description: The tags for the target disks. type: object additionalProperties: type: string supportedOSVersions: description: A value indicating the inplace OS Upgrade version. type: array 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: description: A value indicating the SRS operation name. type: string readOnly: true x-ms-discriminator-value: VMwareCbt VMwareCbtNicDetails: description: VMwareCbt NIC details. type: object properties: nicId: description: The NIC Id. type: string readOnly: true isPrimaryNic: description: A value indicating whether this is the primary NIC. type: string sourceIPAddress: description: The source IP address. type: string readOnly: true sourceIPAddressType: description: The source IP address type. enum: - Dynamic - Static type: string readOnly: true x-ms-enum: name: EthernetAddressType modelAsString: true sourceNetworkId: description: Source network Id. type: string readOnly: true targetIPAddress: description: The target IP address. type: string targetIPAddressType: description: The target IP address type. enum: - Dynamic - Static type: string x-ms-enum: name: EthernetAddressType modelAsString: true targetSubnetName: description: Target subnet name. type: string testNetworkId: description: Source network Id. type: string testSubnetName: description: Test subnet name. type: string testIPAddress: description: The test IP address. type: string testIPAddressType: description: The test IP address type. enum: - Dynamic - Static type: string x-ms-enum: name: EthernetAddressType modelAsString: true targetNicName: description: Target NIC name. type: string isSelectedForMigration: description: A value indicating whether this NIC is selected for migration. type: string VMwareCbtNicInput: description: VMwareCbt NIC input. required: - nicId - isPrimaryNic type: object properties: nicId: description: The NIC Id. type: string isPrimaryNic: description: A value indicating whether this is the primary NIC. type: string targetSubnetName: description: Target subnet name. type: string targetStaticIPAddress: description: The static IP address. type: string isSelectedForMigration: description: A value indicating whether this NIC is selected for migration. type: string targetNicName: description: Target NIC name. type: string testSubnetName: description: The test subnet name. type: string testStaticIPAddress: description: The test static IP address. type: string VMwareCbtPolicyCreationInput: description: VMware Cbt policy creation input. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificInput' properties: recoveryPointHistoryInMinutes: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency (in minutes). type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency (in minutes). type: integer x-ms-discriminator-value: VMwareCbt VmwareCbtPolicyDetails: description: VMware Cbt specific policy details. type: object allOf: - $ref: '#/definitions/PolicyProviderSpecificDetails' properties: recoveryPointHistoryInMinutes: format: int32 description: >- The duration in minutes until which the recovery points need to be stored. type: integer appConsistentFrequencyInMinutes: format: int32 description: The app consistent snapshot frequency in minutes. type: integer crashConsistentFrequencyInMinutes: format: int32 description: The crash consistent snapshot frequency in minutes. type: integer x-ms-discriminator-value: VMwareCbt VMwareCbtProtectedDiskDetails: description: VMwareCbt protected disk details. type: object properties: diskId: description: The disk id. type: string readOnly: true diskName: description: The disk name. type: string readOnly: true diskType: description: The disk type. enum: - Standard_LRS - Premium_LRS - StandardSSD_LRS type: string x-ms-enum: name: DiskAccountType modelAsString: true diskPath: description: The disk path. type: string readOnly: true isOSDisk: description: A value indicating whether the disk is the OS disk. type: string readOnly: true capacityInBytes: format: int64 description: The disk capacity in bytes. type: integer readOnly: true logStorageAccountId: description: The log storage account ARM Id. type: string readOnly: true logStorageAccountSasSecretName: description: The key vault secret name of the log storage account. type: string readOnly: true diskEncryptionSetId: description: The DiskEncryptionSet ARM Id. type: string readOnly: true seedManagedDiskId: description: The ARM Id of the seed managed disk. type: string readOnly: true seedBlobUri: description: The uri of the seed blob. type: string readOnly: true targetManagedDiskId: description: The ARM Id of the target managed disk. type: string readOnly: true targetBlobUri: description: The uri of the target blob. type: string readOnly: true targetDiskName: description: The name for the target managed disk. type: string gatewayOperationDetails: $ref: '#/definitions/GatewayOperationDetails' description: A value indicating the gateway operation details. readOnly: true VMwareCbtProtectionContainerMappingDetails: description: VMwareCbt provider specific container mapping details. type: object allOf: - $ref: '#/definitions/ProtectionContainerMappingProviderSpecificDetails' properties: keyVaultId: description: The target key vault ARM Id. type: string readOnly: true keyVaultUri: description: The target key vault URI. type: string readOnly: true storageAccountId: description: The storage account ARM Id. type: string readOnly: true storageAccountSasSecretName: description: The secret name of the storage account. type: string readOnly: true serviceBusConnectionStringSecretName: description: The secret name of the service bus connection string. type: string readOnly: true targetLocation: description: The target location. type: string readOnly: true roleSizeToNicCountMap: description: The role size to NIC count map. type: object additionalProperties: format: int32 type: integer readOnly: true excludedSkus: description: The SKUs to be excluded. type: array items: type: string x-ms-discriminator-value: VMwareCbt VMwareCbtResumeReplicationInput: description: VMwareCbt specific resume replication input. required: - instanceType type: object allOf: - $ref: '#/definitions/ResumeReplicationProviderSpecificInput' properties: deleteMigrationResources: description: A value indicating whether Migration resources to be deleted. type: string x-ms-discriminator-value: VMwareCbt VMwareCbtResyncInput: description: VMwareCbt specific resync input. required: - skipCbtReset - instanceType type: object allOf: - $ref: '#/definitions/ResyncProviderSpecificInput' properties: skipCbtReset: description: A value indicating whether CBT is to be reset. type: string x-ms-discriminator-value: VMwareCbt VMwareCbtSecurityProfileProperties: description: VMwareCbt security profile input. type: object properties: targetVmSecurityType: description: The target VM security type. enum: - None - TrustedLaunch - ConfidentialVM type: string x-ms-enum: name: SecurityType modelAsString: true isTargetVmSecureBootEnabled: description: A value indicating whether secure boot to be enabled. type: string isTargetVmTpmEnabled: description: A value indicating whether trusted platform module to be enabled. type: string isTargetVmIntegrityMonitoringEnabled: description: A value indicating whether integrity monitoring to be enabled. type: string isTargetVmConfidentialEncryptionEnabled: description: >- A value indicating whether confidential compute encryption to be enabled. type: string VMwareCbtTestMigrateInput: description: VMwareCbt specific test migrate input. required: - recoveryPointId - networkId - instanceType type: object allOf: - $ref: '#/definitions/TestMigrateProviderSpecificInput' properties: recoveryPointId: description: The recovery point Id. type: string networkId: description: The test network Id. type: string vmNics: description: The list of NIC details. type: array items: $ref: '#/definitions/VMwareCbtNicInput' x-ms-identifiers: [] osUpgradeVersion: description: A value indicating the inplace OS Upgrade version. type: string x-ms-discriminator-value: VMwareCbt VMwareCbtUpdateDiskInput: description: VMwareCbt disk input for update. required: - diskId type: object properties: diskId: description: The disk Id. type: string targetDiskName: description: The target disk name. type: string isOSDisk: description: A value indicating whether the disk is the OS disk. type: string VMwareCbtUpdateMigrationItemInput: description: VMwareCbt specific update migration item input. type: object allOf: - $ref: '#/definitions/UpdateMigrationItemProviderSpecificInput' properties: targetVmName: description: The target VM name. type: string targetVmSize: description: The target VM size. type: string targetResourceGroupId: description: The target resource group ARM Id. type: string targetAvailabilitySetId: description: The target availability set ARM Id. type: string targetAvailabilityZone: description: The target availability zone. type: string targetProximityPlacementGroupId: description: The target proximity placement group ARM Id. type: string targetBootDiagnosticsStorageAccountId: description: The target boot diagnostics storage account ARM Id. type: string targetNetworkId: description: The target network ARM Id. type: string testNetworkId: description: The test network ARM Id. type: string vmNics: description: The list of NIC details. minLength: 1 type: array items: $ref: '#/definitions/VMwareCbtNicInput' vmDisks: description: The list of disk update properties. minLength: 1 type: array items: $ref: '#/definitions/VMwareCbtUpdateDiskInput' licenseType: description: The license type. enum: - NotSpecified - NoLicenseType - WindowsServer type: string x-ms-enum: name: LicenseType modelAsString: true sqlServerLicenseType: description: The SQL Server license type. enum: - NotSpecified - NoLicenseType - PAYG - AHUB type: string x-ms-enum: name: SqlServerLicenseType modelAsString: true performAutoResync: description: A value indicating whether auto resync is to be done. type: string targetVmTags: description: The target VM tags. maxLength: 50 type: object additionalProperties: type: string targetDiskTags: description: The tags for the target disks. maxLength: 49 type: object additionalProperties: type: string targetNicTags: description: The tags for the target NICs. maxLength: 50 type: object additionalProperties: type: string x-ms-discriminator-value: VMwareCbt VMwareDetails: description: Store the fabric details specific to the VMware fabric. type: object allOf: - $ref: '#/definitions/FabricSpecificDetails' properties: processServers: description: The list of Process Servers associated with the fabric. type: array items: $ref: '#/definitions/ProcessServer' masterTargetServers: description: The list of Master Target servers associated with the fabric. type: array items: $ref: '#/definitions/MasterTargetServer' runAsAccounts: description: The list of run as accounts created on the server. type: array items: $ref: '#/definitions/RunAsAccount' replicationPairCount: description: The number of replication pairs configured in this CS. type: string processServerCount: description: The number of process servers. type: string agentCount: description: The number of source and target servers configured to talk to this CS. type: string protectedServers: description: The number of protected servers. type: string systemLoad: description: The percentage of the system load. type: string systemLoadStatus: description: The system load status. type: string cpuLoad: description: The percentage of the CPU load. type: string cpuLoadStatus: description: The CPU load status. type: string totalMemoryInBytes: format: int64 description: The total memory. type: integer availableMemoryInBytes: format: int64 description: The available memory. type: integer memoryUsageStatus: description: The memory usage status. type: string totalSpaceInBytes: format: int64 description: The total space. type: integer availableSpaceInBytes: format: int64 description: The available space. type: integer spaceUsageStatus: description: The space usage status. type: string webLoad: description: The web load. type: string webLoadStatus: description: The web load status. type: string databaseServerLoad: description: The database server load. type: string databaseServerLoadStatus: description: The database server load status. type: string csServiceStatus: description: The CS service status. type: string ipAddress: description: The IP address. type: string agentVersion: description: The agent Version. type: string hostName: description: The host name. type: string lastHeartbeat: format: date-time description: The last heartbeat received from CS server. type: string versionStatus: description: Version status. type: string sslCertExpiryDate: format: date-time description: CS SSL cert expiry date. type: string sslCertExpiryRemainingDays: format: int32 description: CS SSL cert expiry date. type: integer psTemplateVersion: description: PS template version. type: string agentExpiryDate: format: date-time description: Agent expiry date. type: string agentVersionDetails: $ref: '#/definitions/VersionDetails' description: The agent version details. switchProviderBlockingErrorDetails: description: The switch provider blocking error information. type: array items: $ref: '#/definitions/InMageFabricSwitchProviderBlockingErrorDetails' x-ms-discriminator-value: VMware VMwareV2FabricCreationInput: description: VMwareV2 fabric provider specific settings. required: - migrationSolutionId type: object allOf: - $ref: '#/definitions/FabricSpecificCreationInput' properties: vmwareSiteId: description: The ARM Id of the VMware site. type: string physicalSiteId: description: The ARM Id of the physical site. type: string migrationSolutionId: description: The ARM Id of the migration solution. type: string x-ms-discriminator-value: VMwareV2 VMwareV2FabricSpecificDetails: description: VMwareV2 fabric specific details. type: object allOf: - $ref: '#/definitions/FabricSpecificDetails' properties: vmwareSiteId: description: The ARM Id of the VMware site. type: string readOnly: true physicalSiteId: description: The ARM Id of the physical site. type: string readOnly: true migrationSolutionId: description: The Migration solution ARM Id. type: string readOnly: true serviceEndpoint: description: The service endpoint. type: string readOnly: true serviceResourceId: description: The service resource Id. type: string readOnly: true serviceContainerId: description: The service container Id. type: string readOnly: true processServers: description: The list of process servers. type: array items: $ref: '#/definitions/ProcessServerDetails' readOnly: true x-ms-discriminator-value: VMwareV2 VMwareVirtualMachineDetails: description: VMware provider specific settings. type: object allOf: - $ref: '#/definitions/ConfigurationSettings' properties: agentGeneratedId: description: >- The ID generated by the InMage agent after it gets installed on guest. This is the ID to be used during InMage CreateProtection. type: string agentInstalled: description: The value indicating if InMage scout agent is installed on guest. type: string osType: description: The OsType installed on VM. type: string agentVersion: description: The agent version. type: string ipAddress: description: The IP address. type: string poweredOn: description: The value indicating whether VM is powered on. type: string vCenterInfrastructureId: description: The VCenter infrastructure Id. type: string discoveryType: description: >- A value indicating the discovery type of the machine. Value can be vCenter or physical. type: string diskDetails: description: The disk details. type: array items: $ref: '#/definitions/InMageDiskDetails' validationErrors: description: The validation errors. type: array items: $ref: '#/definitions/HealthError' x-ms-discriminator-value: VMwareVirtualMachine parameters: SubscriptionId: name: subscriptionId in: path description: The subscription Id. required: true type: string ResourceGroupName: name: resourceGroupName in: path description: >- The name of the resource group where the recovery services vault is present. required: true type: string x-ms-parameter-location: client ResourceName: name: resourceName in: path description: The name of the recovery services vault. required: true type: string x-ms-parameter-location: client ApiVersion: name: api-version in: query description: Client Api Version. required: true type: string securityDefinitions: azure_auth: flow: implicit authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize scopes: user_impersonation: impersonate your user account. type: oauth2 description: Azure Active Directory OAuth2 Flow security: - azure_auth: - user_impersonation tags: - name: MigrationRecoveryPoints - name: Operations - name: RecoveryPoints - name: ReplicationAlertSettings - name: ReplicationAppliances - name: ReplicationEligibilityResults - name: ReplicationEvents - name: ReplicationFabrics - name: ReplicationJobs - name: ReplicationLogicalNetworks - name: ReplicationMigrationItems - name: ReplicationNetworkMappings - name: ReplicationNetworks - name: ReplicationPolicies - name: ReplicationProtectableItems - name: ReplicationProtectedItems - name: ReplicationProtectionContainerMappings - name: ReplicationProtectionContainers - name: ReplicationProtectionIntents - name: ReplicationRecoveryPlans - name: ReplicationRecoveryServicesProviders - name: ReplicationStorageClassificationMappings - name: ReplicationStorageClassifications - name: ReplicationVaultHealth - name: ReplicationVaultSetting - name: ReplicationvCenters - name: SupportedOperatingSystems - name: TargetComputeSizes