Web Apps - Get Backup Status

Service:

App Service

API Version:

2023-01-01

Opis pobierania kopii zapasowej aplikacji według jego identyfikatora.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
backupId	path	True	string	Identyfikator kopii zapasowej.
name	path	True	string	Nazwa aplikacji.
resourceGroupName	path	True	string	Nazwa grupy zasobów, do której należy zasób. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-0000000000000000000000000000000000000000 00000).
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BackupItem	OK
Other Status Codes	DefaultErrorResponse	App Service odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get web app backup

Sample Request

HTTP

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

Java

/**
 * Samples for WebApps GetBackupStatus.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetWebAppBackup.json
     */
    /**
     * Sample code: Get web app backup.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getWebAppBackup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getBackupStatusWithResponse("testrg123", "sitef6141",
            "12345", 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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python get_web_app_backup.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.get_backup_status(
        resource_group_name="testrg123",
        name="sitef6141",
        backup_id="12345",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetWebAppBackup.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

Go

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/GetWebAppBackup.json
func ExampleWebAppsClient_GetBackupStatus() {
	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)
	}
	res, err := clientFactory.NewWebAppsClient().GetBackupStatus(ctx, "testrg123", "sitef6141", "12345", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BackupItem = 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

JavaScript

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

/**
 * This sample demonstrates how to Description for Gets a backup of an app by its ID.
 *
 * @summary Description for Gets a backup of an app by its ID.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetWebAppBackup.json
 */
async function getWebAppBackup() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const backupId = "12345";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getBackupStatus(resourceGroupName, name, backupId);
  console.log(result);
}

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

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

Definicje

Nazwa	Opis
BackupItem	Opis kopii zapasowej.
BackupItemStatus	Stan kopii zapasowej.
DatabaseBackupSetting	Ustawienia kopii zapasowej bazy danych.
DatabaseType	Typ bazy danych (np. SqlAzure / MySql).
DefaultErrorResponse	App Service odpowiedź na błąd.
Details
Error	Model błędu.

BackupItem

Opis kopii zapasowej.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.blobName	string	Nazwa obiektu blob zawierającego dane dla tej kopii zapasowej.
properties.correlationId	string	Unikatowy identyfikator korelacji. Użyj tej opcji wraz ze znacznikiem czasu podczas komunikowania się z pomoc techniczna platformy Azure.
properties.created	string	Sygnatura czasowa tworzenia kopii zapasowej.
properties.databases	DatabaseBackupSetting[]	Lista baz danych zawartych w kopii zapasowej.
properties.finishedTimeStamp	string	Sygnatura czasowa po zakończeniu tworzenia kopii zapasowej.
properties.id	integer	Identyfikator kopii zapasowej.
properties.lastRestoreTimeStamp	string	Sygnatura czasowa ostatniej operacji przywracania, która użyła tej kopii zapasowej.
properties.log	string	Szczegóły dotyczące tej kopii zapasowej. Może zawierać komunikat o błędzie.
properties.name	string	Nazwa tej kopii zapasowej.
properties.scheduled	boolean	Prawda, jeśli ta kopia zapasowa została utworzona z powodu wyzwalania harmonogramu.
properties.sizeInBytes	integer	Rozmiar kopii zapasowej w bajtach.
properties.status	BackupItemStatus	Stan kopii zapasowej.
properties.storageAccountUrl	string	Adres URL sygnatury dostępu współdzielonego dla kontenera konta magazynu, który zawiera tę kopię zapasową.
properties.websiteSizeInBytes	integer	Rozmiar oryginalnej aplikacji internetowej, której kopia zapasowa została utworzona.
type	string	Typ zasobu.

BackupItemStatus

Stan kopii zapasowej.

Nazwa	Typ	Opis
Created	string
DeleteFailed	string
DeleteInProgress	string
Deleted	string
Failed	string
InProgress	string
PartiallySucceeded	string
Skipped	string
Succeeded	string
TimedOut	string

DatabaseBackupSetting

Ustawienia kopii zapasowej bazy danych.

Nazwa	Typ	Opis
connectionString	string	Zawiera parametry połączenia bazy danych, która jest tworzona lub przywracana. Jeśli przywracanie powinno nastąpić do nowej bazy danych, nazwa bazy danych wewnątrz to nowa.
connectionStringName	string	Zawiera nazwę parametry połączenia połączoną z elementem SiteConfig.ConnectionStrings. Jest to używane podczas przywracania z opcjami zastąp parametry połączenia.
databaseType	DatabaseType	Typ bazy danych (np. SqlAzure / MySql).
name	string

DatabaseType

Typ bazy danych (np. SqlAzure / MySql).

Nazwa	Typ	Opis
LocalMySql	string
MySql	string
PostgreSql	string
SqlAzure	string

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat błędu debugowania.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.