Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure SiteRecoveryManagementClient Replication…

23 actions 23 updates phrasing extends openapi/microsoft-azure-replicationprotecteditems-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Azure's API. It is a proposal applied on top of the contract, not a document Microsoft Azure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 23 · first 16 shown; the file carries all of them

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}'].patch
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure SiteRecoveryManagementClient Replication…
  version: 1.0.0
extends: openapi/microsoft-azure-replicationprotecteditems-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 22
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems'].get
  update:
    x-apievangelist-phrasing:
      intent: List protected items in a protection container
      effect: read
      questions:
      - Which VMs are being replicated inside one Site Recovery protection container?
      - Can I see only the protected items that belong to a single container rather than the whole vault?
      instructions:
      - text: List replication protected items in container {container} of fabric {fabric} in vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
      - text: Show what is replicating in protection container {container}.
        slots:
          container: path.protectionContainerName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a replication protected item's details
      effect: read
      questions:
      - What is the replication health and state of one protected VM in Azure Site Recovery?
      - How can I check the current failover state of a single replicated item?
      instructions:
      - text: Get details of protected item {item} in container {container}, fabric {fabric}, vault {vault}, group {rg}, subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Show the replication status of {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable replication for a machine
      effect: write
      questions:
      - How do I turn on Site Recovery replication for a virtual machine?
      - Can I start protecting a new machine in an existing protection container?
      instructions:
      - text: Enable replication for {item} in container {container}, fabric {fabric}, vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Start protecting machine {item} with vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Force-purge a replication protected item
      effect: destructive
      questions:
      - What happens if I force delete a protected item instead of disabling replication cleanly?
      - Is there a way to purge a stuck replication protected item from the vault?
      instructions:
      - text: Purge protected item {item} from container {container}, fabric {fabric}, vault {vault}, group {rg}, subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Force delete the replication item {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update recovery settings of a protected item
      effect: write
      questions:
      - Can I change the recovery settings of a VM that is already replicating?
      - Where do I edit the failover configuration of an existing protected item?
      instructions:
      - text: Update recovery settings of {item} in container {container}, fabric {fabric}, vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Change the recovery configuration for protected item {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add disks to a protected item
      effect: write
      questions:
      - I attached a new data disk to a replicated VM - how do I include it in replication?
      - Can extra disks be added to protection after replication is already enabled?
      instructions:
      - text: Add disks to protected item {item} in container {container}, fabric {fabric}, vault {vault}, group {rg}, subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Include the new disks of {item} in replication for vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the recovery point of a failed-over item
      effect: write
      questions:
      - After failover, can I switch the VM to a different recovery point?
      - How do I apply an older recovery point to a machine that has already failed over?
      instructions:
      - text: Apply a different recovery point to {item} in container {container}, fabric {fabric}, vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Change the recovery point used by failed-over item {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a failover of a protected item
      effect: destructive
      questions:
      - Can I cancel a failover that is in progress for a replicated VM?
      - How do I back out of a failover before committing it?
      instructions:
      - text: Cancel failover of {item} in container {container}, fabric {fabric}, vault {vault}, group {rg}, subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Abort the pending failover for {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit a failover of a protected item
      effect: destructive
      questions:
      - How do I make a failover permanent once the recovered VM looks good?
      - What finalizes a Site Recovery failover so it can no longer be cancelled?
      instructions:
      - text: Commit failover for {item} in container {container}, fabric {fabric}, vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Finalize the failover of {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a planned failover
      effect: write
      questions:
      - How do I run a planned failover with no data loss for a replicated VM?
      - Can I schedule a planned failover of a single protected machine for maintenance?
      instructions:
      - text: Run a planned failover of {item} in container {container}, fabric {fabric}, vault {vault}, group {rg}, subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Start a planned failover for protected item {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable replication and remove the item
      effect: destructive
      questions:
      - How do I stop protecting a VM and clean it out of Site Recovery properly?
      - Does disabling replication also remove the protected item from the container?
      instructions:
      - text: Disable replication for {item} in container {container}, fabric {fabric}, vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Stop protecting {item} in vault {vault} and remove it cleanly.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove disks from a protected item
      effect: write
      questions:
      - Can I exclude a disk from replication on a VM that is already protected?
      - How do I stop replicating one of a protected machine's disks?
      instructions:
      - text: Remove disks from protected item {item} in container {container}, fabric {fabric}, vault {vault}, group {rg}, subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Exclude disks of {item} from replication in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication'].post
  update:
    x-apievangelist-phrasing:
      intent: Resynchronize a protected item's replication
      effect: write
      questions:
      - My replicated VM says resynchronization required - how do I fix it?
      - Can I trigger a repair of broken replication for one protected item?
      instructions:
      - text: Resynchronize replication for {item} in container {container}, fabric {fabric}, vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Repair replication on {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect'].post
  update:
    x-apievangelist-phrasing:
      intent: Reprotect a failed-over item (reverse replicate)
      effect: write
      questions:
      - After failing over, how do I start replicating back to the original site?
      - What sets up reverse replication for a machine that has been failed over?
      instructions:
      - text: Reprotect {item} in container {container}, fabric {fabric}, vault {vault}, group {rg}, subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Reverse replicate failed-over item {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve health errors on a protected item
      effect: write
      questions:
      - How can I clear health warnings reported on a replicated VM?
      - Is there an operation to mark replication health issues as resolved?
      instructions:
      - text: Resolve health errors on {item} in container {container}, fabric {fabric}, vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Clear the replication health issues for {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/switchProvider'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch the replication provider of an item
      effect: write
      questions:
      - Can I move a protected VM to a different Site Recovery replication provider?
      - What does switching provider do for a replicated machine?
      instructions:
      - text: Switch the replication provider for {item} in container {container}, fabric {fabric}, vault {vault}, group {rg}, subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Move protected item {item} in vault {vault} to another replication provider.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a test failover
      effect: write
      questions:
      - How do I rehearse disaster recovery without affecting production replication?
      - Can I spin up a test failover of one VM into an isolated network?
      instructions:
      - text: Run a test failover of {item} in container {container}, fabric {fabric}, vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Do a DR drill for {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup'].post
  update:
    x-apievangelist-phrasing:
      intent: Clean up after a test failover
      effect: destructive
      questions:
      - Once a DR drill is done, how do I tear down the test failover VM?
      - What removes the resources created by a test failover?
      instructions:
      - text: Clean up the test failover of {item} in container {container}, fabric {fabric}, vault {vault}, group {rg}, subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Tear down the DR drill for {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an unplanned failover
      effect: write
      questions:
      - My primary site is down - how do I fail a replicated VM over right now?
      - Can I trigger an emergency failover for a single protected item?
      instructions:
      - text: Run an unplanned failover of {item} in container {container}, fabric {fabric}, vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Fail over {item} in vault {vault} immediately after an outage.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateAppliance'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the replication appliance of an item
      effect: write
      questions:
      - Can I move a protected machine to a different replication appliance?
      - How do I reassign which appliance handles replication for one VM?
      instructions:
      - text: Update the appliance for {item} in container {container}, fabric {fabric}, vault {vault}, group {rg}, subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Assign a new replication appliance to {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateMobilityService'].post
  update:
    x-apievangelist-phrasing:
      intent: Push a Mobility service update to an item
      effect: write
      questions:
      - How do I upgrade the Mobility service agent on a replicated machine to the latest version?
      - Can Site Recovery push the newest mobility agent to one protected server?
      instructions:
      - text: Update the Mobility service on {item} in container {container}, fabric {fabric}, vault {vault} ({rg}), subscription {subscription}.
        slots:
          subscription: path.subscriptionId
          vault: path.resourceName
          rg: path.resourceGroupName
          fabric: path.fabricName
          container: path.protectionContainerName
          item: path.replicatedProtectedItemName
      - text: Upgrade the mobility agent on protected item {item} in vault {vault}.
        slots:
          item: path.replicatedProtectedItemName
          vault: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationProtectedItems'].get
  update:
    x-apievangelist-phrasing:
      intent: List all protected items in a vault
      effect: read
      questions:
      - Which machines are protected across my whole Recovery Services vault?
      - Can I filter the vault-wide list of replicated items and page through it?
      instructions:
      - text: List every replication protected item in vault {vault} in group {rg}, subscription {subscription}.
        slots:
          vault: path.resourceName
          rg: path.resourceGroupName
          subscription: path.subscriptionId
      - text: List protected items in vault {vault} ({rg}) matching {filter}.
        slots:
          vault: path.resourceName
          rg: path.resourceGroupName
          filter: query.$filter
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/microsoft-azure-replicationprotecteditems-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.