backup_and_export

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

Overview

Name	backup_and_export
Type	Resource
Id	azure.mysql_flexible_servers.backup_and_export

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	resource_group_name, server_name, subscription_id, backupSettings, targetDetails		Exports the backup of the given server by creating a backup if not existing.
validate_backup	exec	resource_group_name, server_name, subscription_id		Validates if backup can be performed for given server.

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

INSERT examples

create

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

INSERT INTO azure.mysql_flexible_servers.backup_and_export (
backupSettings,
targetDetails,
resource_group_name,
server_name,
subscription_id
)
SELECT 
'{{ backupSettings }}' /* required */,
'{{ targetDetails }}' /* required */,
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
endTime,
error,
percentComplete,
properties,
startTime,
status,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: backup_and_export
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the backup_and_export resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the backup_and_export resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the backup_and_export resource.
  - name: backupSettings
    description: |
      Backup Settings. Required.
    value:
      backupName: "{{ backupName }}"
      backupFormat: "{{ backupFormat }}"
  - name: targetDetails
    description: |
      Backup Target Store Details. Required.
    value:
      objectType: "{{ objectType }}"

Lifecycle Methods

validate_backup

Validates if backup can be performed for given server.

EXEC azure.mysql_flexible_servers.backup_and_export.validate_backup 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;