Web Apps - List Backup Status Secrets Slot

Serviço:

App Service

Versão da API:

2024-11-01

Descrição para Obter o status de um backup de aplicativo Web que pode estar em andamento, incluindo segredos associados ao backup, como a URL SAS do Armazenamento do Azure. Também pode ser usado para atualizar a URL sas para o backup se uma nova URL for passada no corpo da solicitação.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
backupId	path	True	string	ID do backup.
name	path	True	string	Nome do aplicativo Web.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
slot	path	True	string	Nome do slot do aplicativo Web. Se não for especificado, o padrão será o slot de produção.
subscriptionId	path	True	string	Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versão da API

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.storageAccountUrl	True	string	URL SAS para o contêiner.
kind		string	Tipo de recurso.
properties.backupName		string	Nome do backup.
properties.backupSchedule		BackupSchedule	Agende para o backup se ele for executado periodicamente.
properties.databases		DatabaseBackupSetting[]	Bancos de dados incluídos no backup.
properties.enabled		boolean	True se o agendamento de backup estiver habilitado (deve ser incluído nesse caso), false se o agendamento de backup deve ser desabilitado.

Respostas

Nome	Tipo	Description
200 OK	BackupItem	OKEY
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Definições

Nome	Description
BackupItem	Descrição do backup.
BackupItemStatus	Status do backup.
BackupRequest	Descrição de um backup que será executado.
BackupSchedule	Descrição de um agendamento de backup. Descreve a frequência com que o backup deve ser executado e o que deve ser a política de retenção.
DatabaseBackupSetting	Configurações de backup de banco de dados.
DatabaseType	Tipo de banco de dados (por exemplo, SqlAzure/MySql).
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
FrequencyUnit	A unidade de tempo para a frequência com que o backup deve ser executado (por exemplo, para backup semanal, isso deve ser definido como Dia e FrequencyInterval deve ser definido como 7)

BackupItem

Objeto

Descrição do backup.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.blobName	string	Nome do blob que contém dados para esse backup.
properties.correlationId	string	Identificador de correlação exclusivo. Use isso junto com o carimbo de data/hora durante a comunicação com o suporte do Azure.
properties.created	string (date-time)	Carimbo de data/hora da criação do backup.
properties.databases	DatabaseBackupSetting[]	Lista de bancos de dados incluídos no backup.
properties.finishedTimeStamp	string (date-time)	Carimbo de data/hora quando esse backup terminou.
properties.id	integer (int32)	ID do backup.
properties.lastRestoreTimeStamp	string (date-time)	Carimbo de data/hora de uma última operação de restauração que usou esse backup.
properties.log	string	Detalhes sobre esse backup. Pode conter uma mensagem de erro.
properties.name	string	Nome desse backup.
properties.scheduled	boolean	True se esse backup tiver sido criado devido a uma agenda que está sendo disparada.
properties.sizeInBytes	integer (int64)	Tamanho do backup em bytes.
properties.status	BackupItemStatus	Status do backup.
properties.storageAccountUrl	string	URL SAS para o contêiner da conta de armazenamento que contém esse backup.
properties.websiteSizeInBytes	integer (int64)	Tamanho do aplicativo Web original que foi feito backup.
type	string	Tipo de recurso.

BackupItemStatus

Enumeração

Status do backup.

Valor	Description
Created
DeleteFailed
DeleteInProgress
Deleted
Failed
InProgress
PartiallySucceeded
Skipped
Succeeded
TimedOut

BackupRequest

Objeto

Descrição de um backup que será executado.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.backupName	string	Nome do backup.
properties.backupSchedule	BackupSchedule	Agende para o backup se ele for executado periodicamente.
properties.databases	DatabaseBackupSetting[]	Bancos de dados incluídos no backup.
properties.enabled	boolean	True se o agendamento de backup estiver habilitado (deve ser incluído nesse caso), false se o agendamento de backup deve ser desabilitado.
properties.storageAccountUrl	string	URL SAS para o contêiner.
type	string	Tipo de recurso.

BackupSchedule

Objeto

Descrição de um agendamento de backup. Descreve a frequência com que o backup deve ser executado e o que deve ser a política de retenção.

Nome	Tipo	Valor padrão	Description
frequencyInterval	integer (int32)	7	Com que frequência o backup deve ser executado (por exemplo, para backup semanal, isso deve ser definido como 7 e FrequencyUnit deve ser definido como Dia)
frequencyUnit	FrequencyUnit	Day	A unidade de tempo para a frequência com que o backup deve ser executado (por exemplo, para backup semanal, isso deve ser definido como Dia e FrequencyInterval deve ser definido como 7)
keepAtLeastOneBackup	boolean	True	True se a política de retenção sempre deve manter pelo menos um backup na conta de armazenamento, independentemente da idade; false caso contrário.
lastExecutionTime	string (date-time)		Última vez em que essa agenda foi disparada.
retentionPeriodInDays	integer (int32)	30	Após quantos dias os backups devem ser excluídos.
startTime	string (date-time)		Quando o agendamento deve começar a funcionar.

DatabaseBackupSetting

Objeto

Configurações de backup de banco de dados.

Nome	Tipo	Description
connectionString	string	Contém uma cadeia de conexão para um banco de dados que está sendo feito backup ou restaurado. Se a restauração acontecer com um novo banco de dados, o nome do banco de dados dentro será o novo.
connectionStringName	string	Contém um nome de cadeia de conexão vinculado ao SiteConfig.ConnectionStrings. Isso é usado durante a restauração com opções de cadeias de conexão de substituição.
databaseType	DatabaseType	Tipo de banco de dados (por exemplo, SqlAzure/MySql).
name	string

DatabaseType

Enumeração

Tipo de banco de dados (por exemplo, SqlAzure/MySql).

Valor	Description
LocalMySql
MySql
PostgreSql
SqlAzure

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

FrequencyUnit

Enumeração

A unidade de tempo para a frequência com que o backup deve ser executado (por exemplo, para backup semanal, isso deve ser definido como Dia e FrequencyInterval deve ser definido como 7)

Valor	Description
Day
Hour