Web Apps - Get Backup Status

Referência

Serviço:: App Service

Versão da API:: 2023-12-01

Descrição para Obtém um backup de um aplicativo por sua ID.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
backupId	path	True	string	A ID do backup.
name	path	True	string	Nome do aplicativo.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual pertence o recurso. Padrão Regex: `^[-\w\._\(\)]+[^\.]$`
subscriptionId	path	True	string	Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada em GUID (por exemplo, 00000000-0000-0000-0000-0000000000000000000000).
api-version	query	True	string	Versão da API

Respostas

Nome	Tipo	Description
200 OK	BackupItem	OK
Other Status Codes	DefaultErrorResponse	Serviço de Aplicativo resposta de erro.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get web app backup

Solicitação de exemplo

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


/**
 * Samples for WebApps GetBackupStatus.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-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

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-12-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

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/specification/web/resource-manager/Microsoft.Web/stable/2023-12-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-12-01"),
	// 		BlobName: to.Ptr("sitef6141_2023-12-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 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-12-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

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

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/GetWebAppBackup.json
// this example is just showing the usage of "WebApps_GetBackupStatus" 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://video2.skills-academy.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 WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// get the collection of this SiteBackupResource
SiteBackupCollection collection = webSite.GetSiteBackups();

// invoke the operation
string backupId = "12345";
NullableResponse<SiteBackupResource> response = await collection.GetIfExistsAsync(backupId);
SiteBackupResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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

Resposta de exemplo

Código de status:: 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-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-05T17:33:11.641Z",
    "websiteSizeInBytes": 56091883
  }
}

Definições

Nome	Description
BackupItem	Descrição do backup.
BackupItemStatus	Backup status.
DatabaseBackupSetting	Configurações de backup de banco de dados.
DatabaseType	Tipo de banco de dados (por exemplo, SqlAzure /MySql).
DefaultErrorResponse	Serviço de Aplicativo resposta de erro.
Details
Error	Modelo de erro.

BackupItem

Descrição do backup.

Nome	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 esse backup.
properties.correlationId	string	Identificador de correlação exclusivo. Use isso junto com o carimbo de data/hora durante a comunicação com Suporte do Azure.
properties.created	string	Carimbo de data/hora da criação do backup.
properties.databases	DatabaseBackupSetting[]	Lista de bancos de dados incluídos no backup.
properties.finishedTimeStamp	string	Carimbo de data/hora quando esse backup for concluído.
properties.id	integer	Id do backup.
properties.lastRestoreTimeStamp	string	Carimbo de data/hora de uma última operação de restauração que usou esse backup.
properties.log	string	Detalhes sobre esse backup. Pode conter uma mensagem de erro.
properties.name	string	Nome desse backup.
properties.scheduled	boolean	True se esse backup tiver sido criado devido a uma agenda que está sendo disparada.
properties.sizeInBytes	integer	Tamanho do backup em bytes.
properties.status	BackupItemStatus	Backup status.
properties.storageAccountUrl	string	URL SAS para o contêiner da conta de armazenamento que contém esse backup.
properties.websiteSizeInBytes	integer	Tamanho do aplicativo Web original que foi feito backup.
type	string	Tipo de recurso.

BackupItemStatus

Backup status.

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

DatabaseBackupSetting

Configurações de backup de banco de dados.

Nome	Tipo	Description
connectionString	string	Contém um cadeia de conexão para um banco de dados que está sendo copiado ou restaurado. Se a restauração deve acontecer com um novo banco de dados, o nome do banco de dados dentro será o novo.
connectionStringName	string	Contém um nome cadeia de conexão vinculado ao SiteConfig.ConnectionStrings. Isso é usado durante a restauração com opções de cadeias de conexão de substituição.
databaseType	DatabaseType	Tipo de banco de dados (por exemplo, SqlAzure /MySql).
name	string

DatabaseType

Tipo de banco de dados (por exemplo, SqlAzure /MySql).

Nome	Tipo	Description
LocalMySql	string
MySql	string
PostgreSql	string
SqlAzure	string

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erro.
target	string	Informações detalhadas de descrição e depuração de erro.

Error

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erro.
target	string	Informações detalhadas de descrição e depuração de erro.