Web Apps - List Backup Status Secrets

Referência

Service:: App Service

API Version:: 2023-12-01

Descrição de Obtém o estado de uma cópia de segurança de uma aplicação Web que pode estar em curso, incluindo segredos associados à cópia de segurança, como o URL de SAS do Armazenamento do Azure. Também pode ser utilizado para atualizar o URL de SAS para a cópia de segurança se for transmitido um novo URL no corpo do pedido.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
backupId	path	True	string	ID da cópia de segurança.
name	path	True	string	Nome da aplicação Web.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual o recurso pertence. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	O seu ID de subscrição do Azure. Esta é uma cadeia formatada por GUID (por exemplo, 0000000000-0000-0000-0000-00000000000000).
api-version	query	True	string	Versão da API

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.storageAccountUrl	True	string	URL de SAS para o contentor.
kind		string	Tipo de recurso.
properties.backupName		string	Nome da cópia de segurança.
properties.backupSchedule		BackupSchedule	Agendar a cópia de segurança se for executada periodicamente.
properties.databases		DatabaseBackupSetting[]	Bases de dados incluídas na cópia de segurança.
properties.enabled		boolean	Verdadeiro se a agenda de cópias de segurança estiver ativada (tem de ser incluída nesse caso), falso se a agenda de cópias de segurança tiver de ser desativada.

Respostas

Name	Tipo	Description
200 OK	BackupItem	OK
Other Status Codes	DefaultErrorResponse	Serviço de Aplicações resposta de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Get web app backup with secrets

Sample Request

HTTP

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"
    }
  }
}

Sample Response

Status code:: 200

{
  "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
  }
}

Definições

Name	Description
BackupItem	Descrição da cópia de segurança.
BackupItemStatus	Estado da cópia de segurança.
BackupRequest	Descrição de uma cópia de segurança que será efetuada.
BackupSchedule	Descrição de uma agenda de cópia de segurança. Descreve a frequência com que a cópia de segurança deve ser efetuada e qual deve ser a política de retenção.
DatabaseBackupSetting	Definições de cópia de segurança da base de dados.
DatabaseType	Tipo de base de dados (por exemplo, SqlAzure/MySql).
DefaultErrorResponse	Serviço de Aplicações resposta de erro.
Details
Error	Modelo de erro.
FrequencyUnit	A unidade de tempo para a frequência com que a cópia de segurança deve ser executada (por exemplo, para cópia de segurança semanal, esta deve ser definida como Dia e FrequencyInterval deve ser definida como 7)

BackupItem

Descrição da cópia de segurança.

Name	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 esta cópia de segurança.
properties.correlationId	string	Identificador de correlação exclusivo. Utilize-o juntamente com o carimbo de data/hora enquanto comunica com suporte do Azure.
properties.created	string	Carimbo de data/hora da criação da cópia de segurança.
properties.databases	DatabaseBackupSetting[]	Lista de bases de dados incluídas na cópia de segurança.
properties.finishedTimeStamp	string	Carimbo de data/hora quando esta cópia de segurança terminar.
properties.id	integer	ID da cópia de segurança.
properties.lastRestoreTimeStamp	string	Carimbo de data/hora de uma última operação de restauro que utilizou esta cópia de segurança.
properties.log	string	Detalhes sobre esta cópia de segurança. Pode conter uma mensagem de erro.
properties.name	string	Nome desta cópia de segurança.
properties.scheduled	boolean	Verdadeiro se esta cópia de segurança tiver sido criada devido a um agendamento a ser acionado.
properties.sizeInBytes	integer	Tamanho da cópia de segurança em bytes.
properties.status	BackupItemStatus	Estado da cópia de segurança.
properties.storageAccountUrl	string	URL de SAS para o contentor da conta de armazenamento que contém esta cópia de segurança.
properties.websiteSizeInBytes	integer	Tamanho da aplicação Web original que foi criada uma cópia de segurança.
type	string	Tipo de recurso.

BackupItemStatus

Estado da cópia de segurança.

Name	Tipo	Description
Created	string
DeleteFailed	string
DeleteInProgress	string
Deleted	string
Failed	string
InProgress	string
PartiallySucceeded	string
Skipped	string
Succeeded	string
TimedOut	string

BackupRequest

Descrição de uma cópia de segurança que será efetuada.

Name	Tipo	Description
id	string	ID do Recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.backupName	string	Nome da cópia de segurança.
properties.backupSchedule	BackupSchedule	Agendar a cópia de segurança se for executada periodicamente.
properties.databases	DatabaseBackupSetting[]	Bases de dados incluídas na cópia de segurança.
properties.enabled	boolean	Verdadeiro se a agenda de cópias de segurança estiver ativada (tem de ser incluída nesse caso), falso se a agenda de cópias de segurança tiver de ser desativada.
properties.storageAccountUrl	string	URL de SAS para o contentor.
type	string	Tipo de recurso.

BackupSchedule

Descrição de uma agenda de cópia de segurança. Descreve a frequência com que a cópia de segurança deve ser efetuada e qual deve ser a política de retenção.

Name	Tipo	Valor Predefinido	Description
frequencyInterval	integer	7	Com que frequência a cópia de segurança deve ser executada (por exemplo, para cópia de segurança semanal, esta deve ser definida como 7 e FrequencyUnit deve ser definida como Dia)
frequencyUnit	FrequencyUnit	Day	A unidade de tempo para a frequência com que a cópia de segurança deve ser executada (por exemplo, para cópia de segurança semanal, esta deve ser definida como Dia e FrequencyInterval deve ser definida como 7)
keepAtLeastOneBackup	boolean	True	Verdadeiro se a política de retenção deve manter sempre, pelo menos, uma cópia de segurança na conta de armazenamento, independentemente da sua idade; falso de outra forma.
lastExecutionTime	string		A última vez que esta agenda foi acionada.
retentionPeriodInDays	integer	30	Após quantos dias as cópias de segurança devem ser eliminadas.
startTime	string		Quando a agenda deve começar a funcionar.

DatabaseBackupSetting

Definições de cópia de segurança da base de dados.

Name	Tipo	Description
connectionString	string	Contém uma cadeia de ligação a uma base de dados que está a ser efetuada uma cópia de segurança ou restaurada. Se o restauro ocorrer numa nova base de dados, o nome da base de dados no interior é o novo.
connectionStringName	string	Contém um nome cadeia de ligação que está ligado ao SiteConfig.ConnectionStrings. Isto é utilizado durante o restauro com as opções de substituição de cadeias de ligação.
databaseType	DatabaseType	Tipo de base de dados (por exemplo, SqlAzure/MySql).
name	string

DatabaseType

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

Name	Tipo	Description
LocalMySql	string
MySql	string
PostgreSql	string
SqlAzure	string

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Name	Tipo	Description
error	Error	Modelo de erro.

Details

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

Error

Modelo de erro.

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

FrequencyUnit

A unidade de tempo para a frequência com que a cópia de segurança deve ser executada (por exemplo, para cópia de segurança semanal, esta deve ser definida como Dia e FrequencyInterval deve ser definida como 7)

Name	Tipo	Description
Day	string
Hour	string