Backups - List By Server

Service:: MySQL

API Version:: 2024-12-30

List all the backups for a given server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backups?api-version=2024-12-30

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 minLength: 1 maxLength: 63 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.

Responses

Name	Type	Description
200 OK	ServerBackupListResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected 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

List backups for a server

Sample request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups?api-version=2024-12-30

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python backups_list_by_server.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.backups.list_by_server(
        resource_group_name="TestGroup",
        server_name="mysqltestserver",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2024-12-30/examples/BackupsListByServer.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

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

// Generated from example definition: 2024-12-30/BackupsListByServer.json
// this example is just showing the usage of "ServerBackup_ListByServer" 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);

// get the collection of this MySqlFlexibleServerBackupResource
MySqlFlexibleServerBackupCollection collection = mySqlFlexibleServer.GetMySqlFlexibleServerBackups();

// invoke the operation and iterate over the result
await foreach (MySqlFlexibleServerBackupResource item in collection.GetAllAsync())
{
    // the variable item 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
    MySqlFlexibleServerBackupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "name": "daily_20210615T160516",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210615T160516",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-15T16:05:19.902522+00:00",
        "source": "Automatic"
      }
    },
    {
      "name": "daily_20210616T160520",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210616T160520",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-16T16:05:23.9243453+00:00",
        "source": "Automatic"
      }
    },
    {
      "name": "daily_20210617T160525",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210617T160525",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-17T16:05:28.1247488+00:00",
        "source": "Automatic"
      }
    },
    {
      "name": "daily_20210618T160529",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210618T160529",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-18T16:05:32.2736701+00:00",
        "source": "Automatic"
      }
    },
    {
      "name": "daily_20210619T160533",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210619T160533",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-19T16:05:36.8603354+00:00",
        "source": "Automatic"
      }
    },
    {
      "name": "daily_20210620T160538",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210620T160538",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-20T16:05:41.9200138+00:00",
        "source": "Automatic"
      }
    },
    {
      "name": "daily_20210621T160543",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210621T160543",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-21T16:05:48.8528447+00:00",
        "source": "Automatic"
      }
    },
    {
      "name": "daily_20210622T160803",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210622T160803",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-22T16:08:06.3121688+00:00",
        "source": "Automatic"
      }
    },
    {
      "name": "daily_20210622T210807",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210622T210807",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-22T21:08:10.5057354+00:00",
        "source": "Automatic"
      }
    },
    {
      "name": "daily_20210623T212413",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210623T212413",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-23T21:24:16.9401531+00:00",
        "source": "Automatic"
      }
    },
    {
      "name": "daily_20210624T061328",
      "type": "Microsoft.DBforMySQL/flexibleServers/backups",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver/backups/daily_20210624T061328",
      "properties": {
        "backupType": "FULL",
        "completedTime": "2021-06-24T06:13:31.4962137+00:00",
        "source": "Automatic"
      }
    }
  ]
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ServerBackup	Server backup properties
ServerBackupListResult	The response of a ServerBackup list operation.
systemData	Metadata pertaining to creation and last modification of the resource.

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.

ServerBackup

Object

Server backup properties

Name	Type	Description
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
properties.backupType	string	Backup type.
properties.completedTime	string (date-time)	Backup completed time (ISO8601 format).
properties.source	string	Backup source
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"

ServerBackupListResult

Object

The response of a ServerBackup list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	ServerBackup[]	The ServerBackup items on this page

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.

Share via

Backups - List By Server

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List backups for a server

Sample request

Sample response

Definitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerBackup

ServerBackupListResult

systemData