backups

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

Overview

Name	backups
Type	Resource
Id	azure.postgresql.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		Get specific backup for a given server.
list_by_server	select	subscriptionId, resourceGroupName, serverName		List all the backups for a given server.
create	insert	subscriptionId, resourceGroupName, serverName, backupName		Create a specific backup for PostgreSQL flexible server.
delete	delete	subscriptionId, resourceGroupName, serverName, backupName		Deletes a specific backup.

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

Get specific backup for a given server.

SELECT
properties
FROM azure.postgresql.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.postgresql.backups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
;

INSERT examples

create

Create a specific backup for PostgreSQL flexible server.

INSERT INTO azure.postgresql.backups (
subscriptionId,
resourceGroupName,
serverName,
backupName
)
SELECT 
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ backupName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: backups
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the backups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the backups resource.
    - name: serverName
      value: string
      description: Required parameter for the backups resource.
    - name: backupName
      value: string
      description: Required parameter for the backups resource.

DELETE examples

delete

Deletes a specific backup.

DELETE FROM azure.postgresql.backups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND backupName = '{{ backupName }}' --required
;