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

The following fields are returned by SELECT queries:

get_by_resource_group

Successfully retrieved the backup.

Name	Datatype	Description
properties	object	Resource properties.

get

Successfully retrieved the backup.

Name	Datatype	Description
properties	object	Resource properties.

list_by_resource_group_database

Successfully retrieved the list of backups.

Name	Datatype	Description
properties	object	Resource properties.

list_by_database

Successfully retrieved the list of backups.

Name	Datatype	Description
properties	object	Resource properties.

list_by_resource_group_server

Successfully retrieved the list of backups.

Name	Datatype	Description
properties	object	Resource properties.

list_by_server

Successfully retrieved the list of backups.

Name	Datatype	Description
properties	object	Resource properties.

list_by_resource_group_location

Successfully retrieved the list of backups.

Name	Datatype	Description
properties	object	Resource properties.

list_by_location

Successfully retrieved the list of backups.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_resource_group	select	resourceGroupName, locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName, subscriptionId		Gets a long term retention backup.
get	select	locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName, subscriptionId		Gets a long term retention backup.
list_by_resource_group_database	select	resourceGroupName, locationName, longTermRetentionServerName, longTermRetentionDatabaseName, subscriptionId	onlyLatestPerDatabase, databaseState	Lists all long term retention backups for a database based on a particular resource group.
list_by_database	select	locationName, longTermRetentionServerName, longTermRetentionDatabaseName, subscriptionId	onlyLatestPerDatabase, databaseState	Lists all long term retention backups for a database.
list_by_resource_group_server	select	resourceGroupName, locationName, longTermRetentionServerName, subscriptionId	onlyLatestPerDatabase, databaseState	Lists the long term retention backups for a given server based on resource groups.
list_by_server	select	locationName, longTermRetentionServerName, subscriptionId	onlyLatestPerDatabase, databaseState	Lists the long term retention backups for a given server.
list_by_resource_group_location	select	resourceGroupName, locationName, subscriptionId	onlyLatestPerDatabase, databaseState	Lists the long term retention backups for a given location based on resource group.
list_by_location	select	locationName, subscriptionId	onlyLatestPerDatabase, databaseState	Lists the long term retention backups for a given location.
delete_by_resource_group	delete	resourceGroupName, locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName, subscriptionId		Deletes a long term retention backup.
delete	delete	locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName, subscriptionId		Deletes a long term retention backup.
change_access_tier	exec	locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName, subscriptionId, backupStorageAccessTier, operationMode		Change a long term retention backup access tier.
copy	exec	locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName, subscriptionId		Copy an existing long term retention backup.
update	exec	locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName, subscriptionId		Updates an existing long term retention backup.
change_access_tier_by_resource_group	exec	resourceGroupName, locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName, subscriptionId, backupStorageAccessTier, operationMode		Change a long term retention backup access tier.
copy_by_resource_group	exec	resourceGroupName, locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName, subscriptionId		Copy an existing long term retention backup to a different server.
update_by_resource_group	exec	resourceGroupName, locationName, longTermRetentionServerName, longTermRetentionDatabaseName, backupName, subscriptionId		Updates an existing 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
backupName	string	The backup name.
locationName	string	The location of the database.
longTermRetentionDatabaseName	string	The name of the database
longTermRetentionServerName	string	The name of the server
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
databaseState	string	Whether to query against just live databases, just deleted databases, or all databases.
onlyLatestPerDatabase	boolean	Whether or not to only get the latest backup for each database.

SELECT examples

get_by_resource_group

Gets a long term retention backup.

SELECT
properties
FROM azure.sql.long_term_retention_backups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND locationName = '{{ locationName }}' -- required
AND longTermRetentionServerName = '{{ longTermRetentionServerName }}' -- required
AND longTermRetentionDatabaseName = '{{ longTermRetentionDatabaseName }}' -- required
AND backupName = '{{ backupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

get

Gets a long term retention backup.

SELECT
properties
FROM azure.sql.long_term_retention_backups
WHERE locationName = '{{ locationName }}' -- required
AND longTermRetentionServerName = '{{ longTermRetentionServerName }}' -- required
AND longTermRetentionDatabaseName = '{{ longTermRetentionDatabaseName }}' -- required
AND backupName = '{{ backupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group_database

Lists all long term retention backups for a database based on a particular resource group.

SELECT
properties
FROM azure.sql.long_term_retention_backups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND locationName = '{{ locationName }}' -- required
AND longTermRetentionServerName = '{{ longTermRetentionServerName }}' -- required
AND longTermRetentionDatabaseName = '{{ longTermRetentionDatabaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND onlyLatestPerDatabase = '{{ onlyLatestPerDatabase }}'
AND databaseState = '{{ databaseState }}'
;

list_by_database

Lists all long term retention backups for a database.

SELECT
properties
FROM azure.sql.long_term_retention_backups
WHERE locationName = '{{ locationName }}' -- required
AND longTermRetentionServerName = '{{ longTermRetentionServerName }}' -- required
AND longTermRetentionDatabaseName = '{{ longTermRetentionDatabaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND onlyLatestPerDatabase = '{{ onlyLatestPerDatabase }}'
AND databaseState = '{{ databaseState }}'
;

list_by_resource_group_server

Lists the long term retention backups for a given server based on resource groups.

SELECT
properties
FROM azure.sql.long_term_retention_backups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND locationName = '{{ locationName }}' -- required
AND longTermRetentionServerName = '{{ longTermRetentionServerName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND onlyLatestPerDatabase = '{{ onlyLatestPerDatabase }}'
AND databaseState = '{{ databaseState }}'
;

list_by_server

Lists the long term retention backups for a given server.

SELECT
properties
FROM azure.sql.long_term_retention_backups
WHERE locationName = '{{ locationName }}' -- required
AND longTermRetentionServerName = '{{ longTermRetentionServerName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND onlyLatestPerDatabase = '{{ onlyLatestPerDatabase }}'
AND databaseState = '{{ databaseState }}'
;

list_by_resource_group_location

Lists the long term retention backups for a given location based on resource group.

SELECT
properties
FROM azure.sql.long_term_retention_backups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND locationName = '{{ locationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND onlyLatestPerDatabase = '{{ onlyLatestPerDatabase }}'
AND databaseState = '{{ databaseState }}'
;

list_by_location

Lists the long term retention backups for a given location.

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

DELETE examples

delete_by_resource_group

Deletes a long term retention backup.

DELETE FROM azure.sql.long_term_retention_backups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND locationName = '{{ locationName }}' --required
AND longTermRetentionServerName = '{{ longTermRetentionServerName }}' --required
AND longTermRetentionDatabaseName = '{{ longTermRetentionDatabaseName }}' --required
AND backupName = '{{ backupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

delete

Deletes a long term retention backup.

DELETE FROM azure.sql.long_term_retention_backups
WHERE locationName = '{{ locationName }}' --required
AND longTermRetentionServerName = '{{ longTermRetentionServerName }}' --required
AND longTermRetentionDatabaseName = '{{ longTermRetentionDatabaseName }}' --required
AND backupName = '{{ backupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

change_access_tier

Change a long term retention backup access tier.

EXEC azure.sql.long_term_retention_backups.change_access_tier 
@locationName='{{ locationName }}' --required, 
@longTermRetentionServerName='{{ longTermRetentionServerName }}' --required, 
@longTermRetentionDatabaseName='{{ longTermRetentionDatabaseName }}' --required, 
@backupName='{{ backupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"backupStorageAccessTier": "{{ backupStorageAccessTier }}", 
"operationMode": "{{ operationMode }}"
}'
;

copy

Copy an existing long term retention backup.

EXEC azure.sql.long_term_retention_backups.copy 
@locationName='{{ locationName }}' --required, 
@longTermRetentionServerName='{{ longTermRetentionServerName }}' --required, 
@longTermRetentionDatabaseName='{{ longTermRetentionDatabaseName }}' --required, 
@backupName='{{ backupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update

Updates an existing long term retention backup.

EXEC azure.sql.long_term_retention_backups.update 
@locationName='{{ locationName }}' --required, 
@longTermRetentionServerName='{{ longTermRetentionServerName }}' --required, 
@longTermRetentionDatabaseName='{{ longTermRetentionDatabaseName }}' --required, 
@backupName='{{ backupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

change_access_tier_by_resource_group

Change a long term retention backup access tier.

EXEC azure.sql.long_term_retention_backups.change_access_tier_by_resource_group 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@locationName='{{ locationName }}' --required, 
@longTermRetentionServerName='{{ longTermRetentionServerName }}' --required, 
@longTermRetentionDatabaseName='{{ longTermRetentionDatabaseName }}' --required, 
@backupName='{{ backupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"backupStorageAccessTier": "{{ backupStorageAccessTier }}", 
"operationMode": "{{ operationMode }}"
}'
;

copy_by_resource_group

Copy an existing long term retention backup to a different server.

EXEC azure.sql.long_term_retention_backups.copy_by_resource_group 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@locationName='{{ locationName }}' --required, 
@longTermRetentionServerName='{{ longTermRetentionServerName }}' --required, 
@longTermRetentionDatabaseName='{{ longTermRetentionDatabaseName }}' --required, 
@backupName='{{ backupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_by_resource_group

Updates an existing long term retention backup.

EXEC azure.sql.long_term_retention_backups.update_by_resource_group 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@locationName='{{ locationName }}' --required, 
@longTermRetentionServerName='{{ longTermRetentionServerName }}' --required, 
@longTermRetentionDatabaseName='{{ longTermRetentionDatabaseName }}' --required, 
@backupName='{{ backupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;