canonical: https://jentic.com/apis/azure.com/azure-siterecoverymanagementclient

# Microsoft Azure SiteRecoveryManagementClient

Jentic publishes the only available OpenAPI specification for SiteRecoveryManagementClient, keeping it validated and agent-ready. The Azure Site Recovery API exposes the replication surface of the Microsoft.RecoveryServices resource provider so agents can configure fabrics, protection containers, replication policies, recovery plans, network mappings, and individual replicated items. It supports the full disaster-recovery and migration lifecycle - protecting VMs, running planned and unplanned failovers, executing test failovers, committing migrations, and managing alerts and events on a Recovery Services vault.

## For AI agents

Configure replication fabrics, protect VMs, run test and planned failovers, and manage recovery plans on an Azure Recovery Services vault.

## Scope

Does not run point-in-time backups, manage individual VM disks, or provision target VM resources outside the failover flow - use for Site Recovery replication, failover, and migration only.

## Capabilities

- Register replication fabrics under a Recovery Services vault
- Create protection containers and the replication policies applied to them
- Discover protectable items in a fabric and enroll them for replication
- Run test failovers without affecting the source workload
- Execute planned and unplanned failovers as part of a recovery plan
- Commit a migration once a workload has cut over to the target
- Configure replication alert settings and read replication events from the vault

## Use cases

### Disaster Recovery Drills

Resilience teams run scheduled DR drills without disrupting production. The testMigrate and testFailover endpoints spin up isolated copies of replicated workloads in the target region, give the team time to validate the runbook, and the test cleanup endpoints tear the test environment down - all driven by an agent following a runbook rather than an analyst clicking through the portal.

Example prompt: Call testFailover on a recoveryPlan with the target network, verify the test items come up healthy, then call testFailoverCleanup

### Workload Replication Onboarding

Migration teams enroll on-premises or cross-region VMs for replication into Azure. The replicationProtectionContainers/discoverProtectableItem endpoint scans a fabric for items that can be protected, and the replicationProtectedItems endpoints enroll the chosen item into a replication policy, so an agent can onboard a fleet of VMs in a single batched flow.

Example prompt: Call discoverProtectableItem on the protection container, then PUT replicationProtectedItems entries enrolling each discovered VM into the chosen policy

### Migration Cutover Automation

Cloud migration teams cut over workloads from on-premises VMware or AWS into Azure as part of a planned migration window. The replicationMigrationItems migrate endpoint promotes the replicated item to the target region and the testMigrate endpoint validates the cutover plan first, so an agent can drive a sequence of migrations against the calendar.

Example prompt: Call testMigrate on each migrationItem to validate, then on the migration window call migrate to commit each item to the target

### AI Agent DR Orchestration

An agent built on Jentic drives a DR orchestration runbook end-to-end. It discovers protectable items, applies the relevant replication policy, schedules the test failover, parses replicationEvents to confirm health, and pages an analyst with a structured summary - without anyone opening the Site Recovery blade.

Example prompt: Search Jentic for run azure site recovery test failover, load the schemas for testFailover and replicationEvents, and execute a test failover then summarise the events back to the user

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics | List replication fabrics in a vault |
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName} | Register a replication fabric |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/discoverProtectableItem | Discover items in a fabric that can be protected |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrate | Commit a migration to the target region |
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrate | Run a test migration without committing |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationEvents | List replication events for the vault |

## Key resources

- **replicationFabrics** — Register on-premises sites and Azure regions as replication sources or targets
- **replicationProtectionContainers** — Group items for replication and apply a replication policy
- **replicationPolicies** — Define replication retention, recovery point frequency, and crash-consistent intervals
- **replicationProtectedItems** — Enroll individual VMs or workloads for replication
- **recoveryPlans** — Group protected items into ordered failover plans with custom scripts
- **replicationMigrationItems** — Manage items being migrated to Azure rather than replicated for DR
- **replicationAlertSettings** — Configure email notifications for replication health and event alerts
- **replicationEvents** — Read replication health and operational events from the vault

## Why Jentic

- **Setup:** Wiring the Microsoft.RecoveryServices replication surface by hand means registering an Azure AD app, running the OAuth2 token exchange, and polling the asyncOperation URLs that its predominantly long-running failover and migration operations return. Through Jentic you install once, import Site Recovery Management from the API Directory, store the Azure AD service principal credential once, and your agent calls it.
- **Permission scoping:** Site Recovery puts the subscription, resource group, and Recovery Services vault in the URL path (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/...), so a rule can pin your agent to one vault and its fabrics and protected items. You choose the operations it may call, so a failover or a migration commit are not included unless you add them.
- **Credential handling:** Your Azure AD service principal credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context, which matters when a DR runbook runs from a chat-driven workflow.
- **Discovery method:** Agents search Jentic by intent such as 'run an Azure Site Recovery test failover' or 'enroll a VM for replication', and Jentic returns the matching Microsoft.RecoveryServices replication operation with its input schema so the agent calls the right endpoint without reading the ARM reference.

## Related APIs

- **Azure Recovery Services Backup** — Backup and restore on the same Recovery Services vault
- **Recovery Services Vault Management** — Manages the parent Recovery Services vault that hosts ASR and backup
- **Azure Migrate** — Higher-level migration assessment and orchestration product built on top of Site Recovery

## FAQ

### Why is there no official OpenAPI spec for SiteRecoveryManagementClient?

Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call SiteRecoveryManagementClient via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Site Recovery API use?

It uses Azure AD OAuth 2.0 with the implicit flow against https://login.microsoftonline.com/common/oauth2/authorize and the user_impersonation scope. When called through Jentic, your AAD service principal credentials live in your Jentic One instance and the agent receives only a short-lived bearer token scoped to the Recovery Services vault.

### Can I run a test failover with this API?

Yes. POST to /.../replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrate or the equivalent testFailover endpoint on a recovery plan. The test runs against an isolated network and the matching cleanup endpoint tears it down without affecting production.

### How do I migrate a workload to Azure with this API?

Discover the protectable item via /.../discoverProtectableItem, enroll it as a replicationMigrationItem with a policy, validate with testMigrate, then POST migrate on the migrationItem to commit the cutover. Each step is async and returns an asyncOperation URL to poll.

### What are the rate limits for this API?

Azure Resource Manager throttles around 12,000 reads and 1,200 writes per hour per principal at subscription scope, surfaced via x-ms-ratelimit-remaining-subscription-reads and x-ms-ratelimit-remaining-subscription-writes headers. Site Recovery operations are predominantly async with poll-based completion via asyncOperation URLs.

### How do I orchestrate a DR drill through Jentic?

Search Jentic for run azure site recovery test failover, load the schemas for the testFailover and testFailoverCleanup operations on the recovery plan, and execute them in sequence around the drill window. The Jentic Python SDK ships the search, load, execute pattern after pip install jentic.

### Does this API also handle backup?

No - backup lives under the related Recovery Services Backup API surface. Site Recovery handles replication and failover; backup handles point-in-time backup and restore. Both share the same Recovery Services vault as the parent resource.