Web Apps - Get Backup Status

Reference

Service:: App Service

API Version:: 2024-04-01

Description for Gets a backup of an app by its ID.

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

URI Parameters

Name	In	Required	Type	Description
backupId	path	True	string	ID of the backup.
name	path	True	string	Name of the app.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	BackupItem	OK
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get web app backup

Sample request

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

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

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

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-04-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://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
SiteBackupResource result = await siteBackup.GetAsync();

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

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

Definitions

Name	Description
BackupItem	Backup description.
BackupItemStatus	Backup status.
DatabaseBackupSetting	Database backup settings.
DatabaseType	Database type (e.g. SqlAzure / MySql).
DefaultErrorResponse	App Service error response.
Details
Error	Error model.

BackupItem

Backup description.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.blobName	string	Name of the blob which contains data for this backup.
properties.correlationId	string	Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
properties.created	string	Timestamp of the backup creation.
properties.databases	DatabaseBackupSetting[]	List of databases included in the backup.
properties.finishedTimeStamp	string	Timestamp when this backup finished.
properties.id	integer	Id of the backup.
properties.lastRestoreTimeStamp	string	Timestamp of a last restore operation which used this backup.
properties.log	string	Details regarding this backup. Might contain an error message.
properties.name	string	Name of this backup.
properties.scheduled	boolean	True if this backup has been created due to a schedule being triggered.
properties.sizeInBytes	integer	Size of the backup in bytes.
properties.status	BackupItemStatus	Backup status.
properties.storageAccountUrl	string	SAS URL for the storage account container which contains this backup.
properties.websiteSizeInBytes	integer	Size of the original web app which has been backed up.
type	string	Resource type.

BackupItemStatus

Backup status.

Name	Type	Description
Created	string
DeleteFailed	string
DeleteInProgress	string
Deleted	string
Failed	string
InProgress	string
PartiallySucceeded	string
Skipped	string
Succeeded	string
TimedOut	string

DatabaseBackupSetting

Database backup settings.

Name	Type	Description
connectionString	string	Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName	string	Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
databaseType	DatabaseType	Database type (e.g. SqlAzure / MySql).
name	string

DatabaseType

Database type (e.g. SqlAzure / MySql).

Name	Type	Description
LocalMySql	string
MySql	string
PostgreSql	string
SqlAzure	string

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Share via