Web Apps - List Backups

Dienst:: App Service

API-Version:: 2025-03-01

Beschreibung für Ruft vorhandene Sicherungen einer App ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der App.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	BackupItemCollection	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	DefaultErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List web app backups

Beispielanforderung

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


/**
 * Samples for WebApps ListBackups.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-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/AppService/stable/2025-03-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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9f4cb2884f1948b879ecfb3f410e8cbc8805c213/specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-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_2025-03-01"),
		// 				BlobName: to.Ptr("sitef6141_2025-03-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");
require("dotenv/config");

/**
 * 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/AppService/stable/2025-03-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 (const 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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "name": "sitef6141",
      "type": "Microsoft.Web/sites",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345",
      "properties": {
        "name": "sitef6141_2024-11-01",
        "blobName": "sitef6141_2024-11-01",
        "created": "2022-09-03T17:33:11.641Z",
        "databases": [
          {
            "name": "backenddb",
            "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]",
            "connectionStringName": "backend",
            "databaseType": "SqlAzure"
          },
          {
            "name": "statsdb",
            "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]",
            "connectionStringName": "stats",
            "databaseType": "SqlAzure"
          }
        ],
        "finishedTimeStamp": "2022-09-05T17:33:11.641Z",
        "id": 12345,
        "lastRestoreTimeStamp": "2022-09-04T17:33:11.641Z",
        "log": "Succeeded",
        "scheduled": true,
        "sizeInBytes": 56091883,
        "status": "InProgress",
        "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
        "websiteSizeInBytes": 56091883
      }
    }
  ]
}

Definitionen

Name	Beschreibung
BackupItem	Beschreibung der Sicherung.
BackupItemCollection	Sammlung von Sicherungselementen.
BackupItemStatus	Status der Sicherung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DatabaseBackupSetting	Einstellungen für die Datenbanksicherung.
DatabaseType	Datenbanktyp (z. B. SqlAzure / MySql).
DefaultErrorResponse	Fehlerantwort des App-Diensts.
DefaultErrorResponseError	Fehlermodell.
DefaultErrorResponseErrorDetailsItem	Detaillierte Fehler.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

BackupItem

Objekt

Beschreibung der Sicherung.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Art der Ressource.
name	string	Der Name der Ressource
properties.blobName	string	Name des Blobs, das Daten für diese Sicherung enthält.
properties.correlationId	string	Eindeutiger Korrelationsidentifikator. Bitte verwenden Sie diesen zusammen mit dem Zeitstempel, wenn Sie mit dem Azure-Support kommunizieren.
properties.created	string (date-time)	Zeitstempel der Backup-Erstellung.
properties.databases	DatabaseBackupSetting[]	Liste der Datenbanken, die in der Sicherung enthalten sind.
properties.finishedTimeStamp	string (date-time)	Zeitstempel, wann diese Sicherung abgeschlossen ist.
properties.id	integer (int32)	ID der Sicherung.
properties.lastRestoreTimeStamp	string (date-time)	Zeitstempel einer letzten Wiederherstellungsoperation, bei der diese Sicherung verwendet wurde.
properties.log	string	Details zu diesem Backup. Enthält möglicherweise eine Fehlermeldung.
properties.name	string	Name dieser Sicherung.
properties.scheduled	boolean	True, wenn diese Sicherung aufgrund eines ausgelösten Zeitplans erstellt wurde.
properties.sizeInBytes	integer (int64)	Größe des Backups in Bytes.
properties.status	BackupItemStatus	Status der Sicherung.
properties.storageAccountUrl	string	SAS-URL für den Speicherkontocontainer, der diese Sicherung enthält.
properties.websiteSizeInBytes	integer (int64)	Größe der ursprünglichen Web-App, die gesichert wurde.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

BackupItemCollection

Objekt

Sammlung von Sicherungselementen.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	BackupItem[]	Die BackupItem-Einträge auf dieser Seite

BackupItemStatus

Enumeration

Status der Sicherung.

Wert	Beschreibung
InProgress
Failed
Succeeded
TimedOut
Created
Skipped
PartiallySucceeded
DeleteInProgress
DeleteFailed
Deleted

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DatabaseBackupSetting

Objekt

Einstellungen für die Datenbanksicherung.

Name	Typ	Beschreibung
connectionString	string	Enthält eine Verbindungszeichenfolge zu einer Datenbank, die gesichert oder wiederhergestellt wird. Wenn die Wiederherstellung mit einer neuen Datenbank geschehen soll, ist der Name der Datenbank in der neuen Datenbank.
connectionStringName	string	Enthält einen Verbindungszeichenfolgennamen, der mit "SiteConfig.ConnectionStrings" verknüpft ist. Dies wird während der Wiederherstellung mit Optionen zum Überschreiben von Verbindungszeichenfolgen verwendet.
databaseType	DatabaseType	Datenbanktyp (z. B. SqlAzure / MySql).
name	string

DatabaseType

Enumeration

Datenbanktyp (z. B. SqlAzure / MySql).

Wert	Beschreibung
SqlAzure
MySql
LocalMySql
PostgreSql

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	DefaultErrorResponseError	Fehlermodell.

DefaultErrorResponseError

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zur programmgesteuerten Identifizierung des Fehlers.
details	DefaultErrorResponseErrorDetailsItem[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.
target	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.

DefaultErrorResponseErrorDetailsItem

Objekt

Detaillierte Fehler.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zur programmgesteuerten Identifizierung des Fehlers.
message	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.
target	string	Detaillierte Fehlerbeschreibung und Informationen zum Debuggen.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Freigeben über

Web Apps - List Backups

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

List web app backups

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BackupItem

BackupItemCollection

BackupItemStatus

createdByType

DatabaseBackupSetting

DatabaseType

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

systemData