backups_automatic_and_on_demand

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

Overview

Name	backups_automatic_and_on_demand
Type	Resource
Id	azure.postgresql_flexible_servers.backups_automatic_and_on_demand

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
backupType	string	Type of backup. Known values are: "Full" and "Customer On-Demand". (Full, Customer On-Demand)
completedTime	string (date-time)	Time(ISO8601 format) at which the backup was completed.
source	string	Source of the backup.
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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
backupType	string	Type of backup. Known values are: "Full" and "Customer On-Demand". (Full, Customer On-Demand)
completedTime	string (date-time)	Time(ISO8601 format) at which the backup was completed.
source	string	Source of the backup.
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		Gets information of an on demand backup, given its name.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists all available backups of a server.
create	insert	resource_group_name, server_name, backup_name, subscription_id		Creates an on demand backup of a server.
delete	delete	resource_group_name, server_name, backup_name, subscription_id		Deletes a specific backup, given its 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	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

Gets information of an on demand backup, given its name.

SELECT
id,
name,
backupType,
completedTime,
source,
systemData,
type
FROM azure.postgresql_flexible_servers.backups_automatic_and_on_demand
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

Lists all available backups of a server.

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

INSERT examples

create

Creates an on demand backup of a server.

INSERT INTO azure.postgresql_flexible_servers.backups_automatic_and_on_demand (
resource_group_name,
server_name,
backup_name,
subscription_id
)
SELECT 
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ backup_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: backups_automatic_and_on_demand
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the backups_automatic_and_on_demand resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the backups_automatic_and_on_demand resource.
  - name: backup_name
    value: "{{ backup_name }}"
    description: Required parameter for the backups_automatic_and_on_demand resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the backups_automatic_and_on_demand resource.

DELETE examples

delete

Deletes a specific backup, given its name.

DELETE FROM azure.postgresql_flexible_servers.backups_automatic_and_on_demand
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
;