Condividi tramite


Web Apps - List Backup Status Secrets

Descrizione per Ottiene lo stato di un backup dell'app Web che potrebbe essere in corso, inclusi i segreti associati al backup, ad esempio l'URL della firma di accesso condiviso di Archiviazione di Azure. È anche possibile usare per aggiornare l'URL di firma di accesso condiviso per il backup se viene passato un nuovo URL nel corpo della richiesta.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list?api-version=2024-04-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
backupId
path True

string

ID del backup.

name
path True

string

Nome dell'app Web.

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+[^\.]$

Nome del gruppo di risorse a cui appartiene la risorsa.

subscriptionId
path True

string

ID sottoscrizione di Azure. Si tratta di una stringa in formato GUID (ad esempio 000000000-0000-0000-0000-000000000000000).

api-version
query True

string

Versione API

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties.storageAccountUrl True

string

URL di firma di accesso condiviso al contenitore.

kind

string

Tipo di risorsa.

properties.backupName

string

Nome del backup.

properties.backupSchedule

BackupSchedule

Pianificare il backup se viene eseguito periodicamente.

properties.databases

DatabaseBackupSetting[]

Database inclusi nel backup.

properties.enabled

boolean

True se la pianificazione del backup è abilitata (deve essere inclusa in questo caso), false se la pianificazione del backup deve essere disabilitata.

Risposte

Nome Tipo Descrizione
200 OK

BackupItem

OK

Other Status Codes

DefaultErrorResponse

Risposta di errore del servizio app.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Get web app backup with secrets

Esempio di richiesta

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345/list?api-version=2024-04-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"
    }
  }
}

Risposta di esempio

{
  "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_2024-04-01",
    "name": "sitef6141_2024-04-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
  }
}

Definizioni

Nome Descrizione
BackupItem

Descrizione del backup.

BackupItemStatus

Stato del backup.

BackupRequest

Descrizione di un backup che verrà eseguito.

BackupSchedule

Descrizione di una pianificazione del backup. Descrive la frequenza con cui deve essere eseguito il backup e quali devono essere i criteri di conservazione.

DatabaseBackupSetting

Impostazioni di backup del database.

DatabaseType

Tipo di database (ad esempio SqlAzure/MySql).

DefaultErrorResponse

Risposta di errore del servizio app.

Details
Error

Modello di errore.

FrequencyUnit

Unità di tempo per la frequenza con cui deve essere eseguito il backup (ad esempio, per il backup settimanale, deve essere impostato su Day e FrequencyInterval deve essere impostato su 7)

BackupItem

Descrizione del backup.

Nome Tipo Descrizione
id

string

ID risorsa.

kind

string

Tipo di risorsa.

name

string

Nome risorsa.

properties.blobName

string

Nome del BLOB che contiene i dati per questo backup.

properties.correlationId

string

Identificatore di correlazione univoco. Usare questo insieme al timestamp durante la comunicazione con il supporto di Azure.

properties.created

string (date-time)

Timestamp della creazione del backup.

properties.databases

DatabaseBackupSetting[]

Elenco di database inclusi nel backup.

properties.finishedTimeStamp

string (date-time)

Timestamp al termine del backup.

properties.id

integer (int32)

ID del backup.

properties.lastRestoreTimeStamp

string (date-time)

Timestamp di un'ultima operazione di ripristino che ha utilizzato il backup.

properties.log

string

Dettagli relativi a questo backup. Potrebbe contenere un messaggio di errore.

properties.name

string

Nome del backup.

properties.scheduled

boolean

True se il backup è stato creato a causa di una pianificazione attivata.

properties.sizeInBytes

integer (int64)

Dimensioni del backup in byte.

properties.status

BackupItemStatus

Stato del backup.

properties.storageAccountUrl

string

URL di firma di accesso condiviso per il contenitore dell'account di archiviazione che contiene questo backup.

properties.websiteSizeInBytes

integer (int64)

Dimensioni dell'app Web originale di cui è stato eseguito il backup.

type

string

Tipo di risorsa.

BackupItemStatus

Stato del backup.

Valore Descrizione
Created
DeleteFailed
DeleteInProgress
Deleted
Failed
InProgress
PartiallySucceeded
Skipped
Succeeded
TimedOut

BackupRequest

Descrizione di un backup che verrà eseguito.

Nome Tipo Descrizione
id

string

ID risorsa.

kind

string

Tipo di risorsa.

name

string

Nome risorsa.

properties.backupName

string

Nome del backup.

properties.backupSchedule

BackupSchedule

Pianificare il backup se viene eseguito periodicamente.

properties.databases

DatabaseBackupSetting[]

Database inclusi nel backup.

properties.enabled

boolean

True se la pianificazione del backup è abilitata (deve essere inclusa in questo caso), false se la pianificazione del backup deve essere disabilitata.

properties.storageAccountUrl

string

URL di firma di accesso condiviso al contenitore.

type

string

Tipo di risorsa.

BackupSchedule

Descrizione di una pianificazione del backup. Descrive la frequenza con cui deve essere eseguito il backup e quali devono essere i criteri di conservazione.

Nome Tipo Valore predefinito Descrizione
frequencyInterval

integer (int32)

7

Frequenza con cui deve essere eseguito il backup (ad esempio, per il backup settimanale, deve essere impostato su 7 e FrequencyUnit deve essere impostato su Giorno)

frequencyUnit

FrequencyUnit

Day

Unità di tempo per la frequenza con cui deve essere eseguito il backup (ad esempio, per il backup settimanale, deve essere impostato su Day e FrequencyInterval deve essere impostato su 7)

keepAtLeastOneBackup

boolean

True

True se i criteri di conservazione devono sempre mantenere almeno un backup nell'account di archiviazione, indipendentemente dalla data in cui è; false in caso contrario.

lastExecutionTime

string (date-time)

Ora dell'ultima attivazione di questa pianificazione.

retentionPeriodInDays

integer (int32)

30

Dopo quanti giorni devono essere eliminati i backup.

startTime

string (date-time)

Quando la pianificazione deve iniziare a funzionare.

DatabaseBackupSetting

Impostazioni di backup del database.

Nome Tipo Descrizione
connectionString

string

Contiene una stringa di connessione a un database di cui viene eseguito il backup o il ripristino. Se il ripristino dovrebbe verificarsi in un nuovo database, il nome del database all'interno è quello nuovo.

connectionStringName

string

Contiene un nome di stringa di connessione collegato a SiteConfig.ConnectionStrings. Viene usato durante il ripristino con le opzioni sovrascrivere le stringhe di connessione.

databaseType

DatabaseType

Tipo di database (ad esempio SqlAzure/MySql).

name

string

DatabaseType

Tipo di database (ad esempio SqlAzure/MySql).

Valore Descrizione
LocalMySql
MySql
PostgreSql
SqlAzure

DefaultErrorResponse

Risposta di errore del servizio app.

Nome Tipo Descrizione
error

Error

Modello di errore.

Details

Nome Tipo Descrizione
code

string

Stringa standardizzata per identificare l'errore a livello di codice.

message

string

Descrizione dettagliata dell'errore e informazioni di debug.

target

string

Descrizione dettagliata dell'errore e informazioni di debug.

Error

Modello di errore.

Nome Tipo Descrizione
code

string

Stringa standardizzata per identificare l'errore a livello di codice.

details

Details[]

Errori dettagliati.

innererror

string

Altre informazioni per eseguire il debug dell'errore.

message

string

Descrizione dettagliata dell'errore e informazioni di debug.

target

string

Descrizione dettagliata dell'errore e informazioni di debug.

FrequencyUnit

Unità di tempo per la frequenza con cui deve essere eseguito il backup (ad esempio, per il backup settimanale, deve essere impostato su Day e FrequencyInterval deve essere impostato su 7)

Valore Descrizione
Day
Hour