Web Apps - List Backup Status Secrets Slot

Tjänst:

App Service

API-version:

2024-04-01

Beskrivning för Hämtar status för en säkerhetskopiering av webbappar som kan vara på gång, inklusive hemligheter som är associerade med säkerhetskopian, till exempel Azure Storage SAS-URL:en. Kan också användas för att uppdatera SAS-URL:en för säkerhetskopian om en ny URL skickas i begärandetexten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
backupId	path	True	string	ID för säkerhetskopiering.
name	path	True	string	Namnet på webbappen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Namnet på resursgruppen som resursen tillhör.
slot	path	True	string	Namnet på webbappens fack. Om den inte anges kommer den som standard att vara produktionsplats.
subscriptionId	path	True	string	Ditt Azure-prenumerations-ID. Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-version

Begärandetext

Name	Obligatorisk	Typ	Description
properties.storageAccountUrl	True	string	SAS-URL till containern.
kind		string	Typ av resurs.
properties.backupName		string	Namnet på säkerhetskopian.
properties.backupSchedule		BackupSchedule	Schemalägg säkerhetskopieringen om den körs med jämna mellanrum.
properties.databases		DatabaseBackupSetting[]	Databaser som ingår i säkerhetskopieringen.
properties.enabled		boolean	Sant om säkerhetskopieringsschemat är aktiverat (måste inkluderas i det fallet), falskt om säkerhetskopieringsschemat ska inaktiveras.

Svar

Name	Typ	Description
200 OK	BackupItem	OKEJ
Other Status Codes	DefaultErrorResponse	App Service-felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Definitioner

Name	Description
BackupItem	Beskrivning av säkerhetskopiering.
BackupItemStatus	Säkerhetskopieringsstatus.
BackupRequest	Beskrivning av en säkerhetskopia som ska utföras.
BackupSchedule	Beskrivning av ett säkerhetskopieringsschema. Beskriver hur ofta säkerhetskopieringen ska utföras och vad som ska vara kvarhållningsprincipen.
DatabaseBackupSetting	Inställningar för databassäkerhetskopiering.
DatabaseType	Databastyp (t.ex. SqlAzure/MySql).
DefaultErrorResponse	App Service-felsvar.
Details
Error	Felmodell.
FrequencyUnit	Tidsenheten för hur ofta säkerhetskopieringen ska köras (t.ex. för veckovis säkerhetskopiering bör detta anges till Dag och FrequencyInterval ska anges till 7)

BackupItem

Objekt

Beskrivning av säkerhetskopiering.

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Typ av resurs.
name	string	Resursnamn.
properties.blobName	string	Namnet på bloben som innehåller data för den här säkerhetskopieringen.
properties.correlationId	string	Unik korrelationsidentifierare. Använd detta tillsammans med tidsstämpeln när du kommunicerar med Azure-supporten.
properties.created	string (date-time)	Tidsstämpel för att skapa säkerhetskopian.
properties.databases	DatabaseBackupSetting[]	Lista över databaser som ingår i säkerhetskopieringen.
properties.finishedTimeStamp	string (date-time)	Tidsstämpel när den här säkerhetskopieringen är klar.
properties.id	integer (int32)	ID för säkerhetskopian.
properties.lastRestoreTimeStamp	string (date-time)	Tidsstämpel för en senaste återställningsåtgärd som använde den här säkerhetskopieringen.
properties.log	string	Information om den här säkerhetskopian. Kan innehålla ett felmeddelande.
properties.name	string	Namnet på den här säkerhetskopian.
properties.scheduled	boolean	Sant om den här säkerhetskopieringen har skapats på grund av ett schema som utlöses.
properties.sizeInBytes	integer (int64)	Storleken på säkerhetskopian i byte.
properties.status	BackupItemStatus	Säkerhetskopieringsstatus.
properties.storageAccountUrl	string	SAS-URL för containern för lagringskontot som innehåller den här säkerhetskopian.
properties.websiteSizeInBytes	integer (int64)	Storleken på den ursprungliga webbappen som har säkerhetskopierats.
type	string	Resurstyp.

BackupItemStatus

Uppräkning

Säkerhetskopieringsstatus.

Värde	Description
Created
DeleteFailed
DeleteInProgress
Deleted
Failed
InProgress
PartiallySucceeded
Skipped
Succeeded
TimedOut

BackupRequest

Objekt

Beskrivning av en säkerhetskopia som ska utföras.

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Typ av resurs.
name	string	Resursnamn.
properties.backupName	string	Namnet på säkerhetskopian.
properties.backupSchedule	BackupSchedule	Schemalägg säkerhetskopieringen om den körs med jämna mellanrum.
properties.databases	DatabaseBackupSetting[]	Databaser som ingår i säkerhetskopieringen.
properties.enabled	boolean	Sant om säkerhetskopieringsschemat är aktiverat (måste inkluderas i det fallet), falskt om säkerhetskopieringsschemat ska inaktiveras.
properties.storageAccountUrl	string	SAS-URL till containern.
type	string	Resurstyp.

BackupSchedule

Objekt

Beskrivning av ett säkerhetskopieringsschema. Beskriver hur ofta säkerhetskopieringen ska utföras och vad som ska vara kvarhållningsprincipen.

Name	Typ	Standardvärde	Description
frequencyInterval	integer (int32)	7	Hur ofta säkerhetskopieringen ska köras (t.ex. för veckovis säkerhetskopiering bör detta anges till 7 och FrequencyUnit ska anges till Dag)
frequencyUnit	FrequencyUnit	Day	Tidsenheten för hur ofta säkerhetskopieringen ska köras (t.ex. för veckovis säkerhetskopiering bör detta anges till Dag och FrequencyInterval ska anges till 7)
keepAtLeastOneBackup	boolean	True	Sant om kvarhållningsprincipen alltid ska behålla minst en säkerhetskopia i lagringskontot, oavsett hur gammal den är. annars falskt.
lastExecutionTime	string (date-time)		Senaste gången det här schemat utlöstes.
retentionPeriodInDays	integer (int32)	30	Efter hur många dagar säkerhetskopieringar ska tas bort.
startTime	string (date-time)		När schemat ska börja fungera.

DatabaseBackupSetting

Objekt

Inställningar för databassäkerhetskopiering.

Name	Typ	Description
connectionString	string	Innehåller en anslutningssträng till en databas som säkerhetskopieras eller återställs. Om återställningen ska ske till en ny databas är databasnamnet inuti det nya.
connectionStringName	string	Innehåller ett namn på anslutningssträngen som är länkat till SiteConfig.ConnectionStrings. Detta används vid återställning med alternativ för att skriva över anslutningssträngar.
databaseType	DatabaseType	Databastyp (t.ex. SqlAzure/MySql).
name	string

DatabaseType

Uppräkning

Databastyp (t.ex. SqlAzure/MySql).

Värde	Description
LocalMySql
MySql
PostgreSql
SqlAzure

DefaultErrorResponse

Objekt

App Service-felsvar.

Name	Typ	Description
error	Error	Felmodell.

Details

Objekt

Name	Typ	Description
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

Error

Objekt

Felmodell.

Name	Typ	Description
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
details	Details[]	Detaljerade fel.
innererror	string	Mer information om felsökningsfel.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

FrequencyUnit

Uppräkning

Tidsenheten för hur ofta säkerhetskopieringen ska köras (t.ex. för veckovis säkerhetskopiering bör detta anges till Dag och FrequencyInterval ska anges till 7)

Värde	Description
Day
Hour