Web Apps - List Backups

Referência

Service:: App Service

API Version:: 2023-01-01

Descrição para Obter cópias de segurança existentes de uma aplicação.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Nome da aplicação.
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

Respostas

Name	Tipo	Description
200 OK	BackupItemCollection	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

List web app backups

Sample Request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups?api-version=2023-01-01


/**
 * Samples for WebApps ListBackups.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/ListWebAppBackups.json
     */
    /**
     * Sample code: List web app backups.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listWebAppBackups(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().listBackups("testrg123", "sitef6141",
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_web_app_backups.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.list_backups(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/ListWebAppBackups.json
if __name__ == "__main__":
    main()

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

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/ListWebAppBackups.json
func ExampleWebAppsClient_NewListBackupsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWebAppsClient().NewListBackupsPager("testrg123", "sitef6141", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BackupItemCollection = armappservice.BackupItemCollection{
		// 	Value: []*armappservice.BackupItem{
		// 		{
		// 			Name: to.Ptr("sitef6141"),
		// 			Type: to.Ptr("Microsoft.Web/sites"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345"),
		// 			Properties: &armappservice.BackupItemProperties{
		// 				Name: to.Ptr("sitef6141_2023-01-01"),
		// 				BlobName: to.Ptr("sitef6141_2023-01-01"),
		// 				Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-03T17:33:11.641Z"); return t}()),
		// 				Databases: []*armappservice.DatabaseBackupSetting{
		// 					{
		// 						Name: to.Ptr("backenddb"),
		// 						ConnectionString: to.Ptr("DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"),
		// 						ConnectionStringName: to.Ptr("backend"),
		// 						DatabaseType: to.Ptr(armappservice.DatabaseTypeSQLAzure),
		// 					},
		// 					{
		// 						Name: to.Ptr("statsdb"),
		// 						ConnectionString: to.Ptr("DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"),
		// 						ConnectionStringName: to.Ptr("stats"),
		// 						DatabaseType: to.Ptr(armappservice.DatabaseTypeSQLAzure),
		// 				}},
		// 				FinishedTimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-05T17:33:11.641Z"); return t}()),
		// 				BackupID: to.Ptr[int32](12345),
		// 				LastRestoreTimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-04T17:33:11.641Z"); return t}()),
		// 				Log: to.Ptr("Succeeded"),
		// 				Scheduled: to.Ptr(true),
		// 				SizeInBytes: to.Ptr[int64](56091883),
		// 				Status: to.Ptr(armappservice.BackupItemStatusInProgress),
		// 				StorageAccountURL: to.Ptr("DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>"),
		// 				WebsiteSizeInBytes: to.Ptr[int64](56091883),
		// 			},
		// 	}},
		// }
	}
}

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

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Description for Gets existing backups of an app.
 *
 * @summary Description for Gets existing backups of an app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/ListWebAppBackups.json
 */
async function listWebAppBackups() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.webApps.listBackups(resourceGroupName, name)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "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-01-01",
        "name": "sitef6141_2023-01-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.
BackupItemCollection	Coleção de itens de cópia de segurança.
BackupItemStatus	Estado da cópia de segurança.
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.

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.

BackupItemCollection

Coleção de itens de cópia de segurança.

Name	Tipo	Description
nextLink	string	Ligação para a página seguinte de recursos.
value	BackupItem[]	Coleção de recursos.

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

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.

Web Apps - List Backups

Parâmetros do URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

List web app backups

Sample Request

Sample Response

Definições

BackupItem

BackupItemCollection

BackupItemStatus

DatabaseBackupSetting

DatabaseType

DefaultErrorResponse

Details

Error

Recursos adicionais