Web Apps - Backup

Referencia

Service:: App Service

API Version:: 2023-12-01

Descripción para Crea una copia de seguridad de una aplicación.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre de la aplicación.
resourceGroupName	path	True	string	Nombre del grupo de recursos al que pertenece el recurso. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versión de la API

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.storageAccountUrl	True	string	Dirección URL de SAS al contenedor.
kind		string	Tipo de recurso.
properties.backupName		string	Nombre de la copia de seguridad.
properties.backupSchedule		BackupSchedule	Programe la copia de seguridad si se ejecuta periódicamente.
properties.databases		DatabaseBackupSetting[]	Bases de datos incluidas en la copia de seguridad.
properties.enabled		boolean	True si la programación de copia de seguridad está habilitada (debe incluirse en ese caso), false si se debe deshabilitar la programación de copia de seguridad.

Respuestas

Nombre	Tipo	Description
200 OK	BackupItem	Aceptar
Other Status Codes	DefaultErrorResponse	App Service respuesta de error.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Backup web app

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backup?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",
  "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-02T17:33:11.641Z",
    "websiteSizeInBytes": 56091883
  }
}

Definiciones

Nombre	Description
BackupItem	Descripción de la copia de seguridad.
BackupItemStatus	Estado de copia de seguridad.
BackupRequest	Descripción de una copia de seguridad que se realizará.
BackupSchedule	Descripción de una programación de copia de seguridad. Describe la frecuencia con la que se debe realizar la copia de seguridad y cuál debe ser la directiva de retención.
DatabaseBackupSetting	Configuración de copia de seguridad de la base de datos.
DatabaseType	Tipo de base de datos (por ejemplo, SqlAzure /MySql).
DefaultErrorResponse	App Service respuesta de error.
Details
Error	Modelo de error.
FrequencyUnit	Unidad de tiempo para la frecuencia con la que se debe ejecutar la copia de seguridad (por ejemplo, para la copia de seguridad semanal, se debe establecer en Día y FrequencyInterval debe establecerse en 7).

BackupItem

Descripción de la copia de seguridad.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.blobName	string	Nombre del blob que contiene datos para esta copia de seguridad.
properties.correlationId	string	Identificador de correlación único. Úselo junto con la marca de tiempo mientras se comunica con Soporte técnico de Azure.
properties.created	string	Marca de tiempo de la creación de la copia de seguridad.
properties.databases	DatabaseBackupSetting[]	Lista de bases de datos incluidas en la copia de seguridad.
properties.finishedTimeStamp	string	Marca de tiempo cuando finalice esta copia de seguridad.
properties.id	integer	Identificador de la copia de seguridad.
properties.lastRestoreTimeStamp	string	Marca de tiempo de una última operación de restauración que usó esta copia de seguridad.
properties.log	string	Detalles relacionados con esta copia de seguridad. Puede contener un mensaje de error.
properties.name	string	Nombre de esta copia de seguridad.
properties.scheduled	boolean	True si se ha creado esta copia de seguridad debido a una programación que se está desencadenando.
properties.sizeInBytes	integer	Tamaño de la copia de seguridad en bytes.
properties.status	BackupItemStatus	Estado de copia de seguridad.
properties.storageAccountUrl	string	Dirección URL de SAS para el contenedor de la cuenta de almacenamiento que contiene esta copia de seguridad.
properties.websiteSizeInBytes	integer	Tamaño de la aplicación web original de la que se ha realizado una copia de seguridad.
type	string	Tipo de recurso.

BackupItemStatus

Estado de copia de seguridad.

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

BackupRequest

Descripción de una copia de seguridad que se realizará.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.backupName	string	Nombre de la copia de seguridad.
properties.backupSchedule	BackupSchedule	Programe la copia de seguridad si se ejecuta periódicamente.
properties.databases	DatabaseBackupSetting[]	Bases de datos incluidas en la copia de seguridad.
properties.enabled	boolean	True si la programación de copia de seguridad está habilitada (debe incluirse en ese caso), false si se debe deshabilitar la programación de copia de seguridad.
properties.storageAccountUrl	string	Dirección URL de SAS al contenedor.
type	string	Tipo de recurso.

BackupSchedule

Descripción de una programación de copia de seguridad. Describe la frecuencia con la que se debe realizar la copia de seguridad y cuál debe ser la directiva de retención.

Nombre	Tipo	Valor predeterminado	Description
frequencyInterval	integer	7	Frecuencia con la que se debe ejecutar la copia de seguridad (por ejemplo, para la copia de seguridad semanal, se debe establecer en 7 y FrequencyUnit debe establecerse en Día).
frequencyUnit	FrequencyUnit	Day	Unidad de tiempo para la frecuencia con la que se debe ejecutar la copia de seguridad (por ejemplo, para la copia de seguridad semanal, se debe establecer en Día y FrequencyInterval debe establecerse en 7).
keepAtLeastOneBackup	boolean	True	True si la directiva de retención siempre debe mantener al menos una copia de seguridad en la cuenta de almacenamiento, independientemente de la antigüedad; False en caso contrario.
lastExecutionTime	string		Última vez que se desencadenó esta programación.
retentionPeriodInDays	integer	30	Después de cuántos días se deben eliminar las copias de seguridad.
startTime	string		Cuando la programación debería empezar a funcionar.

DatabaseBackupSetting

Configuración de copia de seguridad de la base de datos.

Nombre	Tipo	Description
connectionString	string	Contiene una cadena de conexión a una base de datos de la que se realiza una copia de seguridad o se restaura. Si la restauración debe producirse en una nueva base de datos, el nombre de la base de datos dentro es el nuevo.
connectionStringName	string	Contiene un nombre cadena de conexión que está vinculado a SiteConfig.ConnectionStrings. Esto se usa durante la restauración con opciones de cadenas de conexión sobrescritas.
databaseType	DatabaseType	Tipo de base de datos (por ejemplo, SqlAzure /MySql).
name	string

DatabaseType

Tipo de base de datos (por ejemplo, SqlAzure /MySql).

Nombre	Tipo	Description
LocalMySql	string
MySql	string
PostgreSql	string
SqlAzure	string

DefaultErrorResponse

App Service respuesta de error.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

Error

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

FrequencyUnit

Unidad de tiempo para la frecuencia con la que se debe ejecutar la copia de seguridad (por ejemplo, para la copia de seguridad semanal, se debe establecer en Día y FrequencyInterval debe establecerse en 7).

Nombre	Tipo	Description
Day	string
Hour	string

Share via