long_term_retention_managed_instance_backups

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

Overview

Name	long_term_retention_managed_instance_backups
Type	Resource
Id	azure.sql.long_term_retention_managed_instance_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_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, managedInstanceName, databaseName, backupName, subscriptionId		Gets a long term retention backup for a managed database.
get	select	locationName, managedInstanceName, databaseName, backupName, subscriptionId		Gets a long term retention backup for a managed database.
list_by_resource_group_database	select	resourceGroupName, locationName, managedInstanceName, databaseName, subscriptionId	onlyLatestPerDatabase, databaseState	Lists all long term retention backups for a managed database.
list_by_database	select	locationName, managedInstanceName, databaseName, subscriptionId	onlyLatestPerDatabase, databaseState	Lists all long term retention backups for a managed database.
list_by_resource_group_location	select	resourceGroupName, locationName, subscriptionId	onlyLatestPerDatabase, databaseState	Lists the long term retention backups for managed databases in a given location.
list_by_location	select	locationName, subscriptionId	onlyLatestPerDatabase, databaseState	Lists the long term retention backups for managed databases in a given location.
delete_by_resource_group	delete	resourceGroupName, locationName, managedInstanceName, databaseName, backupName, subscriptionId		Deletes a long term retention backup.
delete	delete	locationName, managedInstanceName, databaseName, backupName, subscriptionId		Deletes 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
backupName	string	The backup name.
databaseName	string	The name of the managed database.
locationName	string	The location of the database.
managedInstanceName	string	The name of the managed instance.
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 for a managed database.

SELECT
properties
FROM azure.sql.long_term_retention_managed_instance_backups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND locationName = '{{ locationName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND backupName = '{{ backupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

get

Gets a long term retention backup for a managed database.

SELECT
properties
FROM azure.sql.long_term_retention_managed_instance_backups
WHERE locationName = '{{ locationName }}' -- required
AND managedInstanceName = '{{ managedInstanceName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND backupName = '{{ backupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group_database

Lists all long term retention backups for a managed database.

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

list_by_database

Lists all long term retention backups for a managed database.

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

list_by_resource_group_location

Lists the long term retention backups for managed databases in a given location.

SELECT
properties
FROM azure.sql.long_term_retention_managed_instance_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 managed databases in a given location.

SELECT
properties
FROM azure.sql.long_term_retention_managed_instance_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_managed_instance_backups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND locationName = '{{ locationName }}' --required
AND managedInstanceName = '{{ managedInstanceName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND backupName = '{{ backupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

delete

Deletes a long term retention backup.

DELETE FROM azure.sql.long_term_retention_managed_instance_backups
WHERE locationName = '{{ locationName }}' --required
AND managedInstanceName = '{{ managedInstanceName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND backupName = '{{ backupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;