Backup And Export - Create

Service:

MySQL

API Version:

2023-10-01-preview

Exports the backup of the given server by creating a backup if not existing.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backupAndExport?api-version=2023-10-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
serverName	path	True	string pattern: ^[a-z0-9][-a-z0-9]*(?	The name of the server.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
backupSettings	True	BackupSettings	Backup Settings
targetDetails	True	BackupStoreDetails	Backup Target Store Details

Responses

Name	Type	Description
200 OK	BackupAndExportResponse	OK
202 Accepted		Accepted Headers Location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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

Create and Export Backup

Sample request

HTTP

POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backupAndExport?api-version=2023-10-01-preview

{
  "targetDetails": {
    "objectType": "FullBackupStoreDetails",
    "sasUriList": [
      "sasuri1",
      "sasuri2"
    ]
  },
  "backupSettings": {
    "backupName": "customer-backup-name"
  }
}

Java

import com.azure.resourcemanager.mysqlflexibleserver.models.BackupAndExportRequest;
import com.azure.resourcemanager.mysqlflexibleserver.models.BackupSettings;
import com.azure.resourcemanager.mysqlflexibleserver.models.FullBackupStoreDetails;
import java.util.Arrays;

/**
 * Samples for BackupAndExport Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/preview/2023-10-01-preview/examples/
     * BackupAndExport.json
     */
    /**
     * Sample code: Create and Export Backup.
     * 
     * @param manager Entry point to MySqlManager.
     */
    public static void createAndExportBackup(com.azure.resourcemanager.mysqlflexibleserver.MySqlManager manager) {
        manager.backupAndExports().create("TestGroup", "mysqltestserver",
            new BackupAndExportRequest().withBackupSettings(new BackupSettings().withBackupName("customer-backup-name"))
                .withTargetDetails(new FullBackupStoreDetails().withSasUriList(Arrays.asList("sasuri1", "sasuri2"))),
            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 typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.mysql_flexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-rdbms
# USAGE
    python backup_and_export.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 = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.backup_and_export.begin_create(
        resource_group_name="TestGroup",
        server_name="mysqltestserver",
        parameters={
            "backupSettings": {"backupName": "customer-backup-name"},
            "targetDetails": {"objectType": "FullBackupStoreDetails", "sasUriList": ["sasuri1", "sasuri2"]},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/preview/2023-10-01-preview/examples/BackupAndExport.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 armmysqlflexibleservers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mysql/armmysqlflexibleservers/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b8691fbfca8fcdc5a241a0b501c32fd4a76bb0cd/specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/preview/2023-10-01-preview/examples/BackupAndExport.json
func ExampleBackupAndExportClient_BeginCreate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmysqlflexibleservers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBackupAndExportClient().BeginCreate(ctx, "TestGroup", "mysqltestserver", armmysqlflexibleservers.BackupAndExportRequest{
		BackupSettings: &armmysqlflexibleservers.BackupSettings{
			BackupName: to.Ptr("customer-backup-name"),
		},
		TargetDetails: &armmysqlflexibleservers.FullBackupStoreDetails{
			ObjectType: to.Ptr("FullBackupStoreDetails"),
			SasURIList: []*string{
				to.Ptr("sasuri1"),
				to.Ptr("sasuri2")},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.BackupAndExportResponse = armmysqlflexibleservers.BackupAndExportResponse{
	// 	Error: &armmysqlflexibleservers.ErrorDetail{
	// 		Code: to.Ptr("AggregateException"),
	// 		Message: to.Ptr("System.AggregateException: One or more errors occurred. (Mismatch in count of number of Commited-Blocks from service.)"),
	// 	},
	// 	Name: to.Ptr("custom-backup101"),
	// 	Type: to.Ptr("Microsoft.DBforMySQL/flexibleServers/backupAndExport"),
	// 	ID: to.Ptr("/subscriptions/cb9d743d-2140-4e73-b871-cd31abab1d2f/resourceGroups/mrgsumitkumatest1/providers/Microsoft.DBforMySQL/flexibleServers/servermysql-01/backupAndExport/custom-backup101"),
	// 	EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-29T07:37:05.640Z"); return t}()),
	// 	PercentComplete: to.Ptr[float64](100),
	// 	Properties: &armmysqlflexibleservers.BackupAndExportResponseProperties{
	// 		BackupMetadata: to.Ptr("{\"key1\":\"value1\",\"key2\":\"value2\"}"),
	// 		DataTransferredInBytes: to.Ptr[int64](1024),
	// 		DatasourceSizeInBytes: to.Ptr[int64](1024),
	// 	},
	// 	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-12-29T07:34:02.328Z"); return t}()),
	// 	Status: to.Ptr(armmysqlflexibleservers.OperationStatusFailed),
	// }
}

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 { MySQLManagementFlexibleServerClient } = require("@azure/arm-mysql-flexible");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Exports the backup of the given server by creating a backup if not existing.
 *
 * @summary Exports the backup of the given server by creating a backup if not existing.
 * x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/preview/2023-10-01-preview/examples/BackupAndExport.json
 */
async function createAndExportBackup() {
  const subscriptionId =
    process.env["MYSQL_SUBSCRIPTION_ID"] || "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = process.env["MYSQL_RESOURCE_GROUP"] || "TestGroup";
  const serverName = "mysqltestserver";
  const parameters = {
    backupSettings: { backupName: "customer-backup-name" },
    targetDetails: {
      objectType: "FullBackupStoreDetails",
      sasUriList: ["sasuri1", "sasuri2"],
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new MySQLManagementFlexibleServerClient(credential, subscriptionId);
  const result = await client.backupAndExport.beginCreateAndWait(
    resourceGroupName,
    serverName,
    parameters,
  );
  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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.MySql.FlexibleServers;
using Azure.ResourceManager.MySql.FlexibleServers.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/mysql/resource-manager/Microsoft.DBforMySQL/Backups/preview/2023-10-01-preview/examples/BackupAndExport.json
// this example is just showing the usage of "BackupAndExport_Create" 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 MySqlFlexibleServerResource created on azure
// for more information of creating MySqlFlexibleServerResource, please refer to the document of MySqlFlexibleServerResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "TestGroup";
string serverName = "mysqltestserver";
ResourceIdentifier mySqlFlexibleServerResourceId = MySqlFlexibleServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
MySqlFlexibleServerResource mySqlFlexibleServer = client.GetMySqlFlexibleServerResource(mySqlFlexibleServerResourceId);

// invoke the operation
MySqlFlexibleServerBackupAndExportContent content = new MySqlFlexibleServerBackupAndExportContent(new MySqlFlexibleServerBackupSettings("customer-backup-name"), new MySqlFlexibleServerFullBackupStoreDetails(new string[]
{
"sasuri1","sasuri2"
}));
ArmOperation<MySqlFlexibleServerBackupAndExportResult> lro = await mySqlFlexibleServer.CreateBackupAndExportAsync(WaitUntil.Completed, content);
MySqlFlexibleServerBackupAndExportResult result = lro.Value;

Console.WriteLine($"Succeeded: {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/cb9d743d-2140-4e73-b871-cd31abab1d2f/resourceGroups/mrgsumitkumatest1/providers/Microsoft.DBforMySQL/flexibleServers/servermysql-01/backupAndExport/custom-backup101",
  "name": "custom-backup101",
  "type": "Microsoft.DBforMySQL/flexibleServers/backupAndExport",
  "status": "Failed",
  "startTime": "2022-12-29T07:34:02.328326Z",
  "endTime": "2022-12-29T07:37:05.6406008Z",
  "percentComplete": 100,
  "properties": {
    "datasourceSizeInBytes": 1024,
    "dataTransferredInBytes": 1024,
    "backupMetadata": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
  },
  "error": {
    "code": "AggregateException",
    "message": "System.AggregateException: One or more errors occurred. (Mismatch in count of number of Commited-Blocks from service.)"
  }
}

Status code:

202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DBforMySQL/locations/eastus/azureAsyncOperation/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview

Definitions

Name	Description
BackupAndExportRequest	BackupAndExport API Request
BackupAndExportResponse	Represents BackupAndExport API Response
BackupFormat	Backup Format for the current backup. (CollatedFormat is INTERNAL – DO NOT USE)
BackupSettings	Backup Settings
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
OperationStatus	The operation status
systemData	Metadata pertaining to creation and last modification of the resource.

BackupAndExportRequest

Object

BackupAndExport API Request

Name	Type	Description
backupSettings	BackupSettings	Backup Settings
targetDetails	BackupStoreDetails	Backup Target Store Details

BackupAndExportResponse

Object

Represents BackupAndExport API Response

Name	Type	Description
endTime	string (date-time)	End time
error	ErrorDetail	The error object.
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
percentComplete	number (double) minimum: 0 maximum: 100	Operation progress (0-100).
properties.backupMetadata	string	Metadata related to backup to be stored for restoring resource in key-value pairs.
properties.dataTransferredInBytes	integer (int64)	Data transferred in bytes
properties.datasourceSizeInBytes	integer (int64)	Size of datasource in bytes
startTime	string (date-time)	Start time
status	OperationStatus	The operation status
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BackupFormat

Enumeration

Backup Format for the current backup. (CollatedFormat is INTERNAL – DO NOT USE)

Value	Description
CollatedFormat
Raw

BackupSettings

Object

Backup Settings

Name	Type	Description
backupFormat	BackupFormat	Backup Format for the current backup. (CollatedFormat is INTERNAL – DO NOT USE)
backupName	string pattern: (^[a-z0-9]$)|(^[a-z0-9][a-z0-9-]*[a-z0-9]$)	The name of the backup.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

OperationStatus

Enumeration

The operation status

Value	Description
Pending	The operation has been accepted but hasn't started.
InProgress	The operation is running
Succeeded	The operation Succeeded
Failed	The operation Failed
CancelInProgress	The cancellation in progress
Canceled	The operation has been Canceled

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.