Microsoft Azure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Microsoft Azure DataProtectionBackupClient Backup Instances…

19 actions 19 updates phrasing extends openapi/microsoft-azure-backupinstances-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 19 · first 16 shown; the file carries all of them

$.info
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}'].put
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}'].delete
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateForModifyBackup'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId}'].get
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/crossRegionRestore'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/validateCrossRegionRestore'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection'].post
$.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection'].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 DataProtectionBackupClient Backup Instances…
  version: 1.0.0
extends: openapi/microsoft-azure-backupinstances-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 18
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances'].get
  update:
    x-apievangelist-phrasing:
      intent: List backup instances in a Backup vault
      effect: read
      questions:
      - Which backup instances are protected in my Backup vault?
      - Can I list every data source a Backup vault is protecting?
      instructions:
      - text: List backup instances in vault {vault}.
        slots:
          vault: path.vaultName
      - text: Show all protected items in Backup vault {vault}.
        slots:
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a backup instance
      effect: read
      questions:
      - How do I check the configuration and protection state of one backup instance?
      - What details come back for a single backup instance?
      instructions:
      - text: Get backup instance {instance} in vault {vault}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      - text: Show the protection details for {instance} in {vault}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure backup for a data source
      effect: write
      questions:
      - How do I configure backup protection for a new data source in a Backup vault?
      - Can I change the settings of an existing backup instance by writing it again?
      instructions:
      - text: Create backup instance {instance} in vault {vault} with properties {properties}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
          properties: requestBody.properties
      - text: Configure protection as backup instance {instance} in {vault}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a backup instance
      effect: destructive
      questions:
      - How do I remove a backup instance from a vault?
      - Can I delete a backup instance for a data source I no longer need to protect?
      instructions:
      - text: Delete backup instance {instance} from vault {vault}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      - text: Remove protected item {instance} from {vault} entirely.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger an on-demand backup
      effect: write
      questions:
      - Can I run a backup right now instead of waiting for the schedule?
      - Which backup rule does an ad hoc backup use?
      instructions:
      - text: Trigger an ad hoc backup of {instance} in vault {vault} with rule options {rule_options}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
          rule_options: requestBody.backupRuleOptions
      - text: Back up {instance} in {vault} immediately.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a data source can be backed up
      effect: read
      questions:
      - Before I configure protection, can I check whether backup of a data source will succeed?
      - What does the validate-for-backup check tell me about a new backup instance?
      instructions:
      - text: Validate that backup instance definition {backup_instance} can be protected in vault {vault}.
        slots:
          backup_instance: requestBody.backupInstance
          vault: path.vaultName
      - text: Check backup readiness of a new data source in {vault} before configuring it.
        slots:
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateForModifyBackup'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a change to a backup instance will work
      effect: read
      questions:
      - Will my planned change to an existing backup instance succeed?
      - Is there a way to test an update to a backup instance before applying it?
      instructions:
      - text: Validate modifying backup instance {instance} in vault {vault} to {backup_instance}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
          backup_instance: requestBody.backupInstance
      - text: Test whether the updated definition for {instance} in {vault} is acceptable.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a backup instance creation
      effect: read
      questions:
      - Did my backup instance setup operation finish?
      - Where can I check the outcome of a backup instance creation operation?
      instructions:
      - text: Get the result of operation {operation} for backup instance {instance} in vault {vault}.
        slots:
          operation: path.operationId
          instance: path.backupInstanceName
          vault: path.vaultName
      - text: Check the status of creation operation {operation} on {instance}.
        slots:
          operation: path.operationId
          instance: path.backupInstanceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/crossRegionRestore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a backup into the secondary region
      effect: write
      questions:
      - How do I restore a backup instance into the paired secondary region?
      - Can I start a cross region restore when the primary region is unavailable?
      instructions:
      - text: Trigger a cross region restore in {location} with restore request {restore_request} and cross-region details {crr_details}.
        slots:
          location: path.location
          restore_request: requestBody.restoreRequestObject
          crr_details: requestBody.crossRegionRestoreDetails
      - text: Start restoring into the secondary region using {restore_request} and {crr_details}.
        slots:
          restore_request: requestBody.restoreRequestObject
          crr_details: requestBody.crossRegionRestoreDetails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/validateCrossRegionRestore'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a cross region restore can run
      effect: read
      questions:
      - Can I verify a cross region restore will work before starting it?
      - What gets validated ahead of a cross region restore for a data source?
      instructions:
      - text: Validate cross region restore request {restore_request} in {location} with details {crr_details}.
        slots:
          location: path.location
          restore_request: requestBody.restoreRequestObject
          crr_details: requestBody.crossRegionRestoreDetails
      - text: Confirm whether a secondary-region restore using {restore_request} and {crr_details} is allowed.
        slots:
          restore_request: requestBody.restoreRequestObject
          crr_details: requestBody.crossRegionRestoreDetails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rehydrate an archived recovery point
      effect: write
      questions:
      - How do I rehydrate an archived recovery point so I can restore from it?
      - Can I set the rehydration priority and how long rehydrated data is kept?
      instructions:
      - text: Rehydrate recovery point {recovery_point} of {instance} in vault {vault} and keep it for {duration}.
        slots:
          recovery_point: requestBody.recoveryPointId
          instance: path.backupInstanceName
          vault: path.vaultName
          duration: requestBody.rehydrationRetentionDuration
      - text: Rehydrate {recovery_point} on {instance} in {vault} at {priority} priority for {duration}.
        slots:
          recovery_point: requestBody.recoveryPointId
          instance: path.backupInstanceName
          vault: path.vaultName
          priority: requestBody.rehydrationPriority
          duration: requestBody.rehydrationRetentionDuration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore data from a backup instance
      effect: write
      questions:
      - How do I restore data from a backup instance to a target?
      - Can I choose which data store a restore reads from?
      instructions:
      - text: Restore {instance} in vault {vault} to {target} from data store {source_store} using request type {object_type}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
          target: requestBody.restoreTargetInfo
          source_store: requestBody.sourceDataStoreType
          object_type: requestBody.objectType
      - text: Start a restore of {instance} in {vault} to target {target}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
          target: requestBody.restoreTargetInfo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume suspended backups
      effect: write
      questions:
      - Can I restart scheduled backups on an instance after suspending them?
      - What brings a backup instance with suspended backups back to its schedule?
      instructions:
      - text: Resume backups for {instance} in vault {vault}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      - text: Restart the suspended backups of {instance} in {vault}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume protection for a stopped backup instance
      effect: write
      questions:
      - How do I turn protection back on for a backup instance that was stopped?
      - Can a backup instance whose protection was stopped be protected again?
      instructions:
      - text: Resume protection for stopped backup instance {instance} in vault {vault}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      - text: Re-enable protection on {instance} in {vault}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop protecting a backup instance
      effect: destructive
      questions:
      - Is it possible to stop protecting a data source but keep its existing backups?
      - What happens to backup data when I stop protection on an instance?
      instructions:
      - text: Stop protection for backup instance {instance} in vault {vault}, keeping its data indefinitely.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      - text: Stop protecting {instance} in {vault}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups'].post
  update:
    x-apievangelist-phrasing:
      intent: Suspend backups for a backup instance
      effect: write
      questions:
      - Can I pause backups on an instance while keeping data per its policy?
      - Which recovery point is kept forever when backups are suspended?
      instructions:
      - text: Suspend backups for {instance} in vault {vault}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      - text: Pause scheduled backups on {instance} in {vault}, retaining data per the policy.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed operation on a backup instance
      effect: write
      questions:
      - My backup instance is in a failed state - can I retry the last failed operation?
      - What does syncing a backup instance do?
      instructions:
      - text: Sync backup instance {instance} in vault {vault} to retry its last failed operation.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
      - text: Resync {instance} in {vault} with sync type {sync_type}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
          sync_type: requestBody.syncType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a restore can be triggered
      effect: read
      questions:
      - Can I check whether a restore will succeed before triggering it?
      - Which restore request details get validated for a backup instance?
      instructions:
      - text: Validate restore request {restore_request} for {instance} in vault {vault}.
        slots:
          restore_request: requestBody.restoreRequestObject
          instance: path.backupInstanceName
          vault: path.vaultName
      - text: Check if {instance} in {vault} can be restored with {restore_request}.
        slots:
          instance: path.backupInstanceName
          vault: path.vaultName
          restore_request: requestBody.restoreRequestObject
      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-backupinstances-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.

GitHub Google LinkedIn

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