backups_long_term_retention

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

Overview

Name	backups_long_term_retention
Type	Resource
Id	azure.postgresql_flexible_servers.backups_long_term_retention

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.
backupMetadata	string	Metadata to be stored in RP. Store everything that will be required to perform a successful restore using this Recovery point. e.g. Versions, DataFormat etc.
backupName	string	Name of Backup operation.
dataTransferredInBytes	integer	Data transferred in bytes.
datasourceSizeInBytes	integer	Size of datasource in bytes.
endTime	string (date-time)	End time of the operation.
errorCode	string	Error code.
errorMessage	string	Error message.
percentComplete	number	Percentage completed.
startTime	string (date-time)	Start time of the operation. Required.
status	string	Service-set extensible enum indicating the status of operation. Required. Known values are: "Running", "Cancelled", "Failed", and "Succeeded". (Running, Cancelled, Failed, Succeeded)
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".

check_prerequisites

Name	Datatype	Description
numberOfContainers	integer	Number of storage containers the plugin will use during backup. More than one containers may be used for size limitations, parallelism, or redundancy etc. Required.

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.
backupMetadata	string	Metadata to be stored in RP. Store everything that will be required to perform a successful restore using this Recovery point. e.g. Versions, DataFormat etc.
backupName	string	Name of Backup operation.
dataTransferredInBytes	integer	Data transferred in bytes.
datasourceSizeInBytes	integer	Size of datasource in bytes.
endTime	string (date-time)	End time of the operation.
errorCode	string	Error code.
errorMessage	string	Error message.
percentComplete	number	Percentage completed.
startTime	string (date-time)	Start time of the operation. Required.
status	string	Service-set extensible enum indicating the status of operation. Required. Known values are: "Running", "Cancelled", "Failed", and "Succeeded". (Running, Cancelled, Failed, Succeeded)
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 the results of a long retention backup operation for a server.
check_prerequisites	select	resource_group_name, server_name, subscription_id		Performs all checks required for a long term retention backup operation to succeed.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists the results of the long term retention backup operations for a server.
start	exec	resource_group_name, server_name, subscription_id, backupSettings, targetDetails		Initiates a long term retention 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
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

Gets the results of a long retention backup operation for a server.

SELECT
id,
name,
backupMetadata,
backupName,
dataTransferredInBytes,
datasourceSizeInBytes,
endTime,
errorCode,
errorMessage,
percentComplete,
startTime,
status,
systemData,
type
FROM azure.postgresql_flexible_servers.backups_long_term_retention
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
;

check_prerequisites

Performs all checks required for a long term retention backup operation to succeed.

SELECT
numberOfContainers
FROM azure.postgresql_flexible_servers.backups_long_term_retention
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists the results of the long term retention backup operations for a server.

SELECT
id,
name,
backupMetadata,
backupName,
dataTransferredInBytes,
datasourceSizeInBytes,
endTime,
errorCode,
errorMessage,
percentComplete,
startTime,
status,
systemData,
type
FROM azure.postgresql_flexible_servers.backups_long_term_retention
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

start

Initiates a long term retention backup.

EXEC azure.postgresql_flexible_servers.backups_long_term_retention.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"backupSettings": "{{ backupSettings }}", 
"targetDetails": "{{ targetDetails }}"
}'
;