Web Apps - List Backup Status Secrets
Description pour Obtient status d’une sauvegarde d’application web qui peut être en cours, y compris les secrets associés à la sauvegarde, tels que l’URL SAS de Stockage Azure. Peut également être utilisé pour mettre à jour l’URL SAP de la sauvegarde si une nouvelle URL est passée dans le corps de la demande.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list?api-version=2023-12-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
backup
|
path | True |
string |
ID de la sauvegarde. |
name
|
path | True |
string |
Nom de l’application web. |
resource
|
path | True |
string |
Nom du groupe de ressources auquel appartient la ressource. Modèle d’expression régulière: |
subscription
|
path | True |
string |
Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 0000000-0000-0000-0000-000000000000000). |
api-version
|
query | True |
string |
Version d'API |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
properties.storageAccountUrl | True |
string |
URL SAS vers le conteneur. |
kind |
string |
Type de ressource. |
|
properties.backupName |
string |
Nom de la sauvegarde. |
|
properties.backupSchedule |
Planifiez la sauvegarde si elle est exécutée régulièrement. |
||
properties.databases |
Bases de données incluses dans la sauvegarde. |
||
properties.enabled |
boolean |
True si la planification de sauvegarde est activée (doit être incluse dans ce cas), false si la planification de sauvegarde doit être désactivée. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok |
|
Other Status Codes |
App Service réponse d’erreur. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
Get web app backup with secrets
Exemple de requête
POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345/list?api-version=2023-12-01
{
"properties": {
"storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
"backupName": "abcdwe",
"enabled": true,
"databases": [
{
"databaseType": "SqlAzure",
"name": "backenddb",
"connectionStringName": "backend",
"connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"
},
{
"databaseType": "SqlAzure",
"name": "statsdb",
"connectionStringName": "stats",
"connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"
}
],
"backupSchedule": {
"frequencyInterval": 7,
"frequencyUnit": "Day",
"keepAtLeastOneBackup": true,
"retentionPeriodInDays": 30,
"startTime": "2022-09-02T17:33:11.641Z"
}
}
}
Exemple de réponse
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345",
"name": "sitef6141",
"type": "Microsoft.Web/sites",
"properties": {
"id": 12345,
"storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
"blobName": "sitef6141_2023-12-01",
"name": "sitef6141_2023-12-01",
"status": "InProgress",
"sizeInBytes": 56091883,
"created": "2022-09-03T17:33:11.641Z",
"log": "Succeeded",
"databases": [
{
"databaseType": "SqlAzure",
"name": "backenddb",
"connectionStringName": "backend",
"connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"
},
{
"databaseType": "SqlAzure",
"name": "statsdb",
"connectionStringName": "stats",
"connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"
}
],
"scheduled": true,
"lastRestoreTimeStamp": "2022-09-04T17:33:11.641Z",
"finishedTimeStamp": "2022-09-05T17:33:11.641Z",
"websiteSizeInBytes": 56091883
}
}
Définitions
Nom | Description |
---|---|
Backup |
Description de la sauvegarde. |
Backup |
État de la sauvegarde. |
Backup |
Description d’une sauvegarde qui sera effectuée. |
Backup |
Description d’une planification de sauvegarde. Décrit la fréquence d’exécution de la sauvegarde et la stratégie de rétention. |
Database |
Paramètres de sauvegarde de base de données. |
Database |
Type de base de données (par exemple, SqlAzure / MySql). |
Default |
App Service réponse d’erreur. |
Details | |
Error |
Modèle d’erreur. |
Frequency |
Unité de temps pour la fréquence à laquelle la sauvegarde doit être exécutée (par exemple, pour la sauvegarde hebdomadaire, cette valeur doit être définie sur Day et FrequencyInterval sur 7) |
BackupItem
Description de la sauvegarde.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource. |
kind |
string |
Type de ressource. |
name |
string |
Nom de la ressource. |
properties.blobName |
string |
Nom de l’objet blob qui contient les données de cette sauvegarde. |
properties.correlationId |
string |
Identificateur de corrélation unique. Utilisez-le avec l’horodatage lors de la communication avec support Azure. |
properties.created |
string |
Horodatage de la création de la sauvegarde. |
properties.databases |
Liste des bases de données incluses dans la sauvegarde. |
|
properties.finishedTimeStamp |
string |
Horodatage à la fin de cette sauvegarde. |
properties.id |
integer |
ID de la sauvegarde. |
properties.lastRestoreTimeStamp |
string |
Horodatage d’une dernière opération de restauration qui a utilisé cette sauvegarde. |
properties.log |
string |
Détails concernant cette sauvegarde. Peut contenir un message d’erreur. |
properties.name |
string |
Nom de cette sauvegarde. |
properties.scheduled |
boolean |
True si cette sauvegarde a été créée en raison d’un déclenchement d’une planification. |
properties.sizeInBytes |
integer |
Taille de la sauvegarde en octets. |
properties.status |
État de la sauvegarde. |
|
properties.storageAccountUrl |
string |
URL SAS pour le conteneur de compte de stockage qui contient cette sauvegarde. |
properties.websiteSizeInBytes |
integer |
Taille de l’application web d’origine sauvegardée. |
type |
string |
Type de ressource. |
BackupItemStatus
État de la sauvegarde.
Nom | Type | Description |
---|---|---|
Created |
string |
|
DeleteFailed |
string |
|
DeleteInProgress |
string |
|
Deleted |
string |
|
Failed |
string |
|
InProgress |
string |
|
PartiallySucceeded |
string |
|
Skipped |
string |
|
Succeeded |
string |
|
TimedOut |
string |
BackupRequest
Description d’une sauvegarde qui sera effectuée.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource. |
kind |
string |
Type de ressource. |
name |
string |
Nom de la ressource. |
properties.backupName |
string |
Nom de la sauvegarde. |
properties.backupSchedule |
Planifiez la sauvegarde si elle est exécutée régulièrement. |
|
properties.databases |
Bases de données incluses dans la sauvegarde. |
|
properties.enabled |
boolean |
True si la planification de sauvegarde est activée (doit être incluse dans ce cas), false si la planification de sauvegarde doit être désactivée. |
properties.storageAccountUrl |
string |
URL SAS vers le conteneur. |
type |
string |
Type de ressource. |
BackupSchedule
Description d’une planification de sauvegarde. Décrit la fréquence d’exécution de la sauvegarde et la stratégie de rétention.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
frequencyInterval |
integer |
7 |
Fréquence à laquelle la sauvegarde doit être exécutée (par exemple, pour la sauvegarde hebdomadaire, elle doit être définie sur 7 et FrequencyUnit sur Jour) |
frequencyUnit | Day |
Unité de temps pour la fréquence à laquelle la sauvegarde doit être exécutée (par exemple, pour la sauvegarde hebdomadaire, cette valeur doit être définie sur Day et FrequencyInterval sur 7) |
|
keepAtLeastOneBackup |
boolean |
True |
True si la stratégie de rétention doit toujours conserver au moins une sauvegarde dans le compte de stockage, quel que soit son âge ; false dans le cas contraire. |
lastExecutionTime |
string |
Dernière fois que cette planification a été déclenchée. |
|
retentionPeriodInDays |
integer |
30 |
Après combien de jours les sauvegardes doivent être supprimées. |
startTime |
string |
Quand la planification doit commencer à fonctionner. |
DatabaseBackupSetting
Paramètres de sauvegarde de base de données.
Nom | Type | Description |
---|---|---|
connectionString |
string |
Contient une chaîne de connexion à une base de données en cours de sauvegarde ou de restauration. Si la restauration doit se produire sur une nouvelle base de données, le nom de la base de données à l’intérieur est la nouvelle. |
connectionStringName |
string |
Contient un nom de chaîne de connexion lié à SiteConfig.ConnectionStrings. Cela est utilisé lors de la restauration avec les options de remplacement des chaînes de connexion. |
databaseType |
Type de base de données (par exemple, SqlAzure / MySql). |
|
name |
string |
DatabaseType
Type de base de données (par exemple, SqlAzure / MySql).
Nom | Type | Description |
---|---|---|
LocalMySql |
string |
|
MySql |
string |
|
PostgreSql |
string |
|
SqlAzure |
string |
DefaultErrorResponse
App Service réponse d’erreur.
Nom | Type | Description |
---|---|---|
error |
Modèle d’erreur. |
Details
Nom | Type | Description |
---|---|---|
code |
string |
Chaîne standardisée pour identifier l’erreur par programmation. |
message |
string |
Description détaillée de l’erreur et informations de débogage. |
target |
string |
Description détaillée de l’erreur et informations de débogage. |
Error
Modèle d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Chaîne standardisée pour identifier l’erreur par programmation. |
details |
Details[] |
Erreurs détaillées. |
innererror |
string |
Informations supplémentaires pour déboguer l’erreur. |
message |
string |
Description détaillée de l’erreur et informations de débogage. |
target |
string |
Description détaillée de l’erreur et informations de débogage. |
FrequencyUnit
Unité de temps pour la fréquence à laquelle la sauvegarde doit être exécutée (par exemple, pour la sauvegarde hebdomadaire, cette valeur doit être définie sur Day et FrequencyInterval sur 7)
Nom | Type | Description |
---|---|---|
Day |
string |
|
Hour |
string |