long_term_retention_backups

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

Overview

Name	long_term_retention_backups
Type	Resource
Id	azure.sql.long_term_retention_backups

Fields

vw_long_term_retention_backups

Name	Datatype	Description
backupName	text	field from the properties object
backup_expiration_time	text	field from the properties object
backup_storage_access_tier	text	field from the properties object
backup_storage_redundancy	text	field from the properties object
backup_time	text	field from the properties object
database_deletion_time	text	field from the properties object
database_name	text	field from the properties object
is_backup_immutable	text	field from the properties object
locationName	text	field from the properties object
longTermRetentionDatabaseName	text	field from the properties object
longTermRetentionServerName	text	field from the properties object
requested_backup_storage_redundancy	text	field from the properties object
resourceGroupName	text	field from the properties object
server_create_time	text	field from the properties object
server_name	text	field from the properties object
subscriptionId	text	field from the properties object

long_term_retention_backups

Name	Datatype	Description
properties	object	Properties of a long term retention backup

Methods

Name	Accessible by	Required Params	Description
get	SELECT	backupName, locationName, longTermRetentionDatabaseName, longTermRetentionServerName, subscriptionId	Gets a long term retention backup.
get_by_resource_group	SELECT	backupName, locationName, longTermRetentionDatabaseName, longTermRetentionServerName, resourceGroupName, subscriptionId	Gets a long term retention backup.
list_by_database	SELECT	locationName, longTermRetentionDatabaseName, longTermRetentionServerName, subscriptionId	Lists all long term retention backups for a database.
list_by_location	SELECT	locationName, subscriptionId	Lists the long term retention backups for a given location.
list_by_resource_group_database	SELECT	locationName, longTermRetentionDatabaseName, longTermRetentionServerName, resourceGroupName, subscriptionId	Lists all long term retention backups for a database based on a particular resource group.
list_by_resource_group_location	SELECT	locationName, resourceGroupName, subscriptionId	Lists the long term retention backups for a given location based on resource group.
list_by_resource_group_server	SELECT	locationName, longTermRetentionServerName, resourceGroupName, subscriptionId	Lists the long term retention backups for a given server based on resource groups.
list_by_server	SELECT	locationName, longTermRetentionServerName, subscriptionId	Lists the long term retention backups for a given server.
delete	DELETE	backupName, locationName, longTermRetentionDatabaseName, longTermRetentionServerName, subscriptionId	Deletes a long term retention backup.
delete_by_resource_group	DELETE	backupName, locationName, longTermRetentionDatabaseName, longTermRetentionServerName, resourceGroupName, subscriptionId	Deletes a long term retention backup.
change_access_tier	EXEC	backupName, locationName, longTermRetentionDatabaseName, longTermRetentionServerName, subscriptionId, data__backupStorageAccessTier, data__operationMode	Change a long term retention backup access tier.
change_access_tier_by_resource_group	EXEC	backupName, locationName, longTermRetentionDatabaseName, longTermRetentionServerName, resourceGroupName, subscriptionId, data__backupStorageAccessTier, data__operationMode	Change a long term retention backup access tier.
copy	EXEC	backupName, locationName, longTermRetentionDatabaseName, longTermRetentionServerName, subscriptionId	Copy an existing long term retention backup.
copy_by_resource_group	EXEC	backupName, locationName, longTermRetentionDatabaseName, longTermRetentionServerName, resourceGroupName, subscriptionId	Copy an existing long term retention backup to a different server.
update	EXEC	backupName, locationName, longTermRetentionDatabaseName, longTermRetentionServerName, subscriptionId	Updates an existing long term retention backup.
update_by_resource_group	EXEC	backupName, locationName, longTermRetentionDatabaseName, longTermRetentionServerName, resourceGroupName, subscriptionId	Updates an existing long term retention backup.

SELECT examples

Lists the long term retention backups for a given location.

vw_long_term_retention_backups

SELECT
backupName,
backup_expiration_time,
backup_storage_access_tier,
backup_storage_redundancy,
backup_time,
database_deletion_time,
database_name,
is_backup_immutable,
locationName,
longTermRetentionDatabaseName,
longTermRetentionServerName,
requested_backup_storage_redundancy,
resourceGroupName,
server_create_time,
server_name,
subscriptionId
FROM azure.sql.vw_long_term_retention_backups
WHERE locationName = '{{ locationName }}'
AND subscriptionId = '{{ subscriptionId }}';

long_term_retention_backups

SELECT
properties
FROM azure.sql.long_term_retention_backups
WHERE locationName = '{{ locationName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified long_term_retention_backups resource.

/*+ delete */
DELETE FROM azure.sql.long_term_retention_backups
WHERE backupName = '{{ backupName }}'
AND locationName = '{{ locationName }}'
AND longTermRetentionDatabaseName = '{{ longTermRetentionDatabaseName }}'
AND longTermRetentionServerName = '{{ longTermRetentionServerName }}'
AND subscriptionId = '{{ subscriptionId }}';