Web Apps - List Backup Status Secrets

Referencia

Servicio:: App Service

Versión de la API:: 2024-11-01

Descripción de Obtiene el estado de una copia de seguridad de una aplicación web que puede estar en curso, incluidos los secretos asociados a la copia de seguridad, como la dirección URL de SAS de Azure Storage. También se puede usar para actualizar la dirección URL de SAS de la copia de seguridad si se pasa una nueva dirección URL en el cuerpo de la solicitud.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
backupId	path	True	string	Id. de copia de seguridad.
name	path	True	string	Nombre de la aplicación web.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Nombre del grupo de recursos al que pertenece el recurso.
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-0000-00000000000000).
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	De acuerdo
Other Status Codes	DefaultErrorResponse	Respuesta de error de App Service.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get web app backup with secrets

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/GetWebAppBackupWithSecrets.json
// this example is just showing the usage of "WebApps_ListBackupStatusSecrets" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SiteBackupResource created on azure
// for more information of creating SiteBackupResource, please refer to the document of SiteBackupResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
string backupId = "12345";
ResourceIdentifier siteBackupResourceId = SiteBackupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, backupId);
SiteBackupResource siteBackup = client.GetSiteBackupResource(siteBackupResourceId);

// invoke the operation
WebAppBackupInfo info = new WebAppBackupInfo
{
    BackupName = "abcdwe",
    IsEnabled = true,
    StorageAccountUri = new Uri("DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>"),
    BackupSchedule = new WebAppBackupSchedule(7, BackupFrequencyUnit.Day, true, 30)
    {
        StartOn = DateTimeOffset.Parse("2022-09-02T17:33:11.641Z"),
    },
    Databases = {new AppServiceDatabaseBackupSetting(AppServiceDatabaseType.SqlAzure)
    {
    Name = "backenddb",
    ConnectionStringName = "backend",
    ConnectionString = "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]",
    }, new AppServiceDatabaseBackupSetting(AppServiceDatabaseType.SqlAzure)
    {
    Name = "statsdb",
    ConnectionStringName = "stats",
    ConnectionString = "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]",
    }},
};
SiteBackupResource result = await siteBackup.GetBackupStatusSecretsAsync(info);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
WebAppBackupData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

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

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	Respuesta de error de App Service.
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, debe establecerse en Día y FrequencyInterval debe establecerse en 7).

BackupItem

Object

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 el soporte técnico de Azure.
properties.created	string (date-time)	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 (date-time)	Marca de tiempo cuando finalice esta copia de seguridad.
properties.id	integer (int32)	Identificador de la copia de seguridad.
properties.lastRestoreTimeStamp	string (date-time)	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 desencadena.
properties.sizeInBytes	integer (int64)	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 (int64)	Tamaño de la aplicación web original de la que se ha realizado una copia de seguridad.
type	string	Tipo de recurso.

BackupItemStatus

Enumeración

Estado de copia de seguridad.

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

BackupRequest

Object

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

Object

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 (int32)	7	Frecuencia con la que se debe ejecutar la copia de seguridad (por ejemplo, para la copia de seguridad semanal, debe establecerse 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, debe establecerse 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 que tenga; False en caso contrario.
lastExecutionTime	string (date-time)		Última vez que se desencadenó esta programación.
retentionPeriodInDays	integer (int32)	30	Después de cuántos días se deben eliminar las copias de seguridad.
startTime	string (date-time)		Cuando la programación debe empezar a funcionar.

DatabaseBackupSetting

Object

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 de cadena de conexión que está vinculado a SiteConfig.ConnectionStrings. Esto se usa durante la restauración con opciones de cadenas de conexión sobrescritura.
databaseType	DatabaseType	Tipo de base de datos (por ejemplo, SqlAzure /MySql).
name	string

DatabaseType

Enumeración

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

Valor	Description
LocalMySql
MySql
PostgreSql
SqlAzure

DefaultErrorResponse

Object

Respuesta de error de App Service.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Object

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

Object

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

Enumeración

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

Valor	Description
Day
Hour

Compartir a través de

Web Apps - List Backup Status Secrets

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Get web app backup with secrets

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BackupItem

BackupItemStatus

BackupRequest

BackupSchedule

DatabaseBackupSetting

DatabaseType

DefaultErrorResponse

Details

Error

FrequencyUnit