POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list/?api-version=2023-01-01
Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name of web app. |
backupId |
String | Yes |
ID of backup. |
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 |
BackupRequest resource specific properties |
properties.backupName |
String | No |
Name of the backup. |
properties.databases[] |
Array | No |
Databases included in the backup. |
properties.databases[].connectionStringName |
String | No |
Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. |
properties.databases[].name |
String | No | |
properties.databases[].connectionString |
String | No |
Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. |
properties.databases[].databaseType |
String | Yes |
Database type (e.g. SqlAzure / MySql). Possible values:
|
properties.storageAccountUrl |
String | Yes |
SAS URL to the container. |
properties.backupSchedule |
Object | No |
Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. |
properties.backupSchedule.startTime |
String | No |
When the schedule should start working. |
properties.backupSchedule.frequencyUnit |
String | Yes |
The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) Possible values:
Default value: "Day" |
properties.backupSchedule.keepAtLeastOneBackup |
Boolean | Yes |
True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. Default value: true |
properties.backupSchedule.frequencyInterval |
Integer | Yes |
How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) Default value: 7 |
properties.backupSchedule.lastExecutionTime |
String | No |
Last time when this schedule was triggered. |
properties.backupSchedule.retentionPeriodInDays |
Integer | Yes |
After how many days backups should be deleted. Default value: 30 |
properties.enabled |
Boolean | No |
True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. |
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.