backup_and_exports

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

Overview

Name	backup_and_exports
Type	Resource
Id	azure.mysql.backup_and_exports

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	subscriptionId, resourceGroupName, serverName, data__backupSettings, data__targetDetails		Exports the backup of the given server by creating a backup if not existing.
validate_backup	exec	subscriptionId, resourceGroupName, serverName		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
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.

INSERT examples

create

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

INSERT INTO azure.mysql.backup_and_exports (
data__backupSettings,
data__targetDetails,
subscriptionId,
resourceGroupName,
serverName
)
SELECT 
'{{ backupSettings }}' /* required */,
'{{ targetDetails }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}'
RETURNING
endTime,
error,
percentComplete,
properties,
startTime,
status
;

Manifest

# Description fields are for documentation purposes
- name: backup_and_exports
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the backup_and_exports resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the backup_and_exports resource.
    - name: serverName
      value: string
      description: Required parameter for the backup_and_exports resource.
    - name: backupSettings
      value: object
      description: |
        Backup Settings
    - name: targetDetails
      value: object
      description: |
        Backup Target Store Details

Lifecycle Methods

validate_backup

Validates if backup can be performed for given server.

EXEC azure.mysql.backup_and_exports.validate_backup 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serverName='{{ serverName }}' --required
;