backups

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

Overview

Name	backups
Type	Resource
Id	azure.mysql_flexible_servers.backups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
backupType	string	Backup type.
completedTime	string (date-time)	Backup completed time (ISO8601 format).
source	string	Backup source.
systemData	object	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".

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
backupType	string	Backup type.
completedTime	string (date-time)	Backup completed time (ISO8601 format).
source	string	Backup source.
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, backup_name, subscription_id		List all the backups for a given server.
list_by_server	select	resource_group_name, server_name, subscription_id		List all the backups for a given server.
put	exec	resource_group_name, server_name, backup_name, subscription_id		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
backup_name	string	The name of the backup. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

List all the backups for a given server.

SELECT
id,
name,
backupType,
completedTime,
source,
systemData,
type
FROM azure.mysql_flexible_servers.backups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND backup_name = '{{ backup_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

List all the backups for a given server.

SELECT
id,
name,
backupType,
completedTime,
source,
systemData,
type
FROM azure.mysql_flexible_servers.backups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

put

Create backup for a given server with specified backup name.

EXEC azure.mysql_flexible_servers.backups.put 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@backup_name='{{ backup_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;