POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot/?api-version=2023-01-01
Description for Restores a web app from a snapshot.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of web app. |
slot |
String | Yes |
Name of web app slot. If not specified then will default to production slot. |
subscriptionId |
String | Yes |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
resourceGroupName |
String | Yes |
Name of the resource group to which the resource belongs. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id. |
name |
String | No |
Resource Name. |
properties |
Object | No |
SnapshotRestoreRequest resource specific properties |
properties.ignoreConflictingHostNames |
Boolean | No |
If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. |
properties.overwrite |
Boolean | Yes |
If |
properties.recoverConfiguration |
Boolean | No |
If true, site configuration, in addition to content, will be reverted. |
properties.snapshotTime |
String | No |
Point in time in which the app restore should be done, formatted as a DateTime string. |
properties.recoverySource |
Object | No |
Specifies the web app that snapshot contents will be retrieved from. |
properties.recoverySource.id |
String | No |
ARM resource ID of the source app. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. |
properties.recoverySource.location |
String | No |
Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS |
properties.useDRSecondary |
Boolean | No |
If true, the snapshot is retrieved from DRSecondary endpoint. |
type |
String | No |
Resource type. |
kind |
String | No |
Kind of resource. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.