backups

Creates, updates, deletes, gets or lists a backups resource.

Overview

Name	backups
Type	Resource
Id	azure.mysql.backups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of a server backup.

list_by_server

Name	Datatype	Description
properties	object	The properties of a server backup.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serverName, backupName		List all the backups for a given server.
list_by_server	select	subscriptionId, resourceGroupName, serverName		List all the backups for a given server.
put	replace	subscriptionId, resourceGroupName, serverName, backupName		Create backup for a given server with specified backup name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
backupName	string	The name of the backup.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serverName	string	The name of the server.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

List all the backups for a given server.

SELECT
properties
FROM azure.mysql.backups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND backupName = '{{ backupName }}' -- required
;

list_by_server

List all the backups for a given server.

SELECT
properties
FROM azure.mysql.backups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
;

REPLACE examples

put

Create backup for a given server with specified backup name.

REPLACE azure.mysql.backups
SET 
-- No updatable properties
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND backupName = '{{ backupName }}' --required
RETURNING
properties;