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

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.
backupExpirationTime	string (date-time)	The time the long term retention backup will expire.
backupStorageAccessTier	string	The BackupStorageAccessTier for the LTR backup. Known values are: "Hot" and "Archive". (Hot, Archive)
backupStorageRedundancy	string	The storage redundancy type of the backup. Known values are: "Geo", "Local", "Zone", and "GeoZone". (Geo, Local, Zone, GeoZone)
backupTime	string (date-time)	The time the backup was taken.
databaseDeletionTime	string (date-time)	The delete time of the database.
databaseName	string	The name of the database the backup belong to.
managedInstanceCreateTime	string (date-time)	The create time of the instance.
managedInstanceName	string	The managed instance that the backup database belongs to.
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".

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.
backupExpirationTime	string (date-time)	The time the long term retention backup will expire.
backupStorageAccessTier	string	The BackupStorageAccessTier for the LTR backup. Known values are: "Hot" and "Archive". (Hot, Archive)
backupStorageRedundancy	string	The storage redundancy type of the backup. Known values are: "Geo", "Local", "Zone", and "GeoZone". (Geo, Local, Zone, GeoZone)
backupTime	string (date-time)	The time the backup was taken.
databaseDeletionTime	string (date-time)	The delete time of the database.
databaseName	string	The name of the database the backup belong to.
managedInstanceCreateTime	string (date-time)	The create time of the instance.
managedInstanceName	string	The managed instance that the backup database belongs to.
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_resource_group_database

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.
backupExpirationTime	string (date-time)	The time the long term retention backup will expire.
backupStorageAccessTier	string	The BackupStorageAccessTier for the LTR backup. Known values are: "Hot" and "Archive". (Hot, Archive)
backupStorageRedundancy	string	The storage redundancy type of the backup. Known values are: "Geo", "Local", "Zone", and "GeoZone". (Geo, Local, Zone, GeoZone)
backupTime	string (date-time)	The time the backup was taken.
databaseDeletionTime	string (date-time)	The delete time of the database.
databaseName	string	The name of the database the backup belong to.
managedInstanceCreateTime	string (date-time)	The create time of the instance.
managedInstanceName	string	The managed instance that the backup database belongs to.
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_database

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.
backupExpirationTime	string (date-time)	The time the long term retention backup will expire.
backupStorageAccessTier	string	The BackupStorageAccessTier for the LTR backup. Known values are: "Hot" and "Archive". (Hot, Archive)
backupStorageRedundancy	string	The storage redundancy type of the backup. Known values are: "Geo", "Local", "Zone", and "GeoZone". (Geo, Local, Zone, GeoZone)
backupTime	string (date-time)	The time the backup was taken.
databaseDeletionTime	string (date-time)	The delete time of the database.
databaseName	string	The name of the database the backup belong to.
managedInstanceCreateTime	string (date-time)	The create time of the instance.
managedInstanceName	string	The managed instance that the backup database belongs to.
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_resource_group_instance

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.
backupExpirationTime	string (date-time)	The time the long term retention backup will expire.
backupStorageAccessTier	string	The BackupStorageAccessTier for the LTR backup. Known values are: "Hot" and "Archive". (Hot, Archive)
backupStorageRedundancy	string	The storage redundancy type of the backup. Known values are: "Geo", "Local", "Zone", and "GeoZone". (Geo, Local, Zone, GeoZone)
backupTime	string (date-time)	The time the backup was taken.
databaseDeletionTime	string (date-time)	The delete time of the database.
databaseName	string	The name of the database the backup belong to.
managedInstanceCreateTime	string (date-time)	The create time of the instance.
managedInstanceName	string	The managed instance that the backup database belongs to.
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_instance

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.
backupExpirationTime	string (date-time)	The time the long term retention backup will expire.
backupStorageAccessTier	string	The BackupStorageAccessTier for the LTR backup. Known values are: "Hot" and "Archive". (Hot, Archive)
backupStorageRedundancy	string	The storage redundancy type of the backup. Known values are: "Geo", "Local", "Zone", and "GeoZone". (Geo, Local, Zone, GeoZone)
backupTime	string (date-time)	The time the backup was taken.
databaseDeletionTime	string (date-time)	The delete time of the database.
databaseName	string	The name of the database the backup belong to.
managedInstanceCreateTime	string (date-time)	The create time of the instance.
managedInstanceName	string	The managed instance that the backup database belongs to.
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_resource_group_location

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.
backupExpirationTime	string (date-time)	The time the long term retention backup will expire.
backupStorageAccessTier	string	The BackupStorageAccessTier for the LTR backup. Known values are: "Hot" and "Archive". (Hot, Archive)
backupStorageRedundancy	string	The storage redundancy type of the backup. Known values are: "Geo", "Local", "Zone", and "GeoZone". (Geo, Local, Zone, GeoZone)
backupTime	string (date-time)	The time the backup was taken.
databaseDeletionTime	string (date-time)	The delete time of the database.
databaseName	string	The name of the database the backup belong to.
managedInstanceCreateTime	string (date-time)	The create time of the instance.
managedInstanceName	string	The managed instance that the backup database belongs to.
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_location

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.
backupExpirationTime	string (date-time)	The time the long term retention backup will expire.
backupStorageAccessTier	string	The BackupStorageAccessTier for the LTR backup. Known values are: "Hot" and "Archive". (Hot, Archive)
backupStorageRedundancy	string	The storage redundancy type of the backup. Known values are: "Geo", "Local", "Zone", and "GeoZone". (Geo, Local, Zone, GeoZone)
backupTime	string (date-time)	The time the backup was taken.
databaseDeletionTime	string (date-time)	The delete time of the database.
databaseName	string	The name of the database the backup belong to.
managedInstanceCreateTime	string (date-time)	The create time of the instance.
managedInstanceName	string	The managed instance that the backup database belongs to.
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_by_resource_group	select	resource_group_name, location_name, managed_instance_name, database_name, backup_name, subscription_id		Gets a long term retention backup for a managed database.
get	select	location_name, managed_instance_name, database_name, backup_name, subscription_id		Gets a long term retention backup for a managed database.
list_by_resource_group_database	select	resource_group_name, location_name, managed_instance_name, database_name, subscription_id	onlyLatestPerDatabase, databaseState	Lists all long term retention backups for a managed database.
list_by_database	select	location_name, managed_instance_name, database_name, subscription_id	onlyLatestPerDatabase, databaseState	Lists all long term retention backups for a managed database.
list_by_resource_group_instance	select	resource_group_name, location_name, managed_instance_name, subscription_id	onlyLatestPerDatabase, databaseState	Lists the long term retention backups for a given managed instance.
list_by_instance	select	location_name, managed_instance_name, subscription_id	onlyLatestPerDatabase, databaseState	Lists the long term retention backups for a given managed instance.
list_by_resource_group_location	select	resource_group_name, location_name, subscription_id	onlyLatestPerDatabase, databaseState, $skip, $top, $filter	Lists the long term retention backups for managed databases in a given location.
list_by_location	select	location_name, subscription_id	onlyLatestPerDatabase, databaseState, $skip, $top, $filter	Lists the long term retention backups for managed databases in a given location.
delete_by_resource_group	delete	resource_group_name, location_name, managed_instance_name, database_name, backup_name, subscription_id		Deletes a long term retention backup.
delete	delete	location_name, managed_instance_name, database_name, backup_name, subscription_id		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
backup_name	string	The backup name. Required.
database_name	string	The name of the managed database. Required.
location_name	string	The location of the database. Required.
managed_instance_name	string	The name of the managed instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	An OData filter expression that filters elements in the collection. Default value is None.
$skip	integer	The number of elements in the collection to skip. Default value is None.
$top	integer	The number of elements to return from the collection. Default value is None.
databaseState	string	Whether to query against just live databases, just deleted databases, or all databases. Known values are: "All", "Live", and "Deleted". Default value is None.
onlyLatestPerDatabase	boolean	Whether or not to only get the latest backup for each database. Default value is None.

SELECT examples

get_by_resource_group

Gets a long term retention backup for a managed database.

SELECT
id,
name,
backupExpirationTime,
backupStorageAccessTier,
backupStorageRedundancy,
backupTime,
databaseDeletionTime,
databaseName,
managedInstanceCreateTime,
managedInstanceName,
systemData,
type
FROM azure.sql.long_term_retention_managed_instance_backups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND location_name = '{{ location_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND backup_name = '{{ backup_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets a long term retention backup for a managed database.

SELECT
id,
name,
backupExpirationTime,
backupStorageAccessTier,
backupStorageRedundancy,
backupTime,
databaseDeletionTime,
databaseName,
managedInstanceCreateTime,
managedInstanceName,
systemData,
type
FROM azure.sql.long_term_retention_managed_instance_backups
WHERE location_name = '{{ location_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND backup_name = '{{ backup_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group_database

Lists all long term retention backups for a managed database.

SELECT
id,
name,
backupExpirationTime,
backupStorageAccessTier,
backupStorageRedundancy,
backupTime,
databaseDeletionTime,
databaseName,
managedInstanceCreateTime,
managedInstanceName,
systemData,
type
FROM azure.sql.long_term_retention_managed_instance_backups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND location_name = '{{ location_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND onlyLatestPerDatabase = '{{ onlyLatestPerDatabase }}'
AND databaseState = '{{ databaseState }}'
;

list_by_database

Lists all long term retention backups for a managed database.

SELECT
id,
name,
backupExpirationTime,
backupStorageAccessTier,
backupStorageRedundancy,
backupTime,
databaseDeletionTime,
databaseName,
managedInstanceCreateTime,
managedInstanceName,
systemData,
type
FROM azure.sql.long_term_retention_managed_instance_backups
WHERE location_name = '{{ location_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND onlyLatestPerDatabase = '{{ onlyLatestPerDatabase }}'
AND databaseState = '{{ databaseState }}'
;

list_by_resource_group_instance

Lists the long term retention backups for a given managed instance.

SELECT
id,
name,
backupExpirationTime,
backupStorageAccessTier,
backupStorageRedundancy,
backupTime,
databaseDeletionTime,
databaseName,
managedInstanceCreateTime,
managedInstanceName,
systemData,
type
FROM azure.sql.long_term_retention_managed_instance_backups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND location_name = '{{ location_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND onlyLatestPerDatabase = '{{ onlyLatestPerDatabase }}'
AND databaseState = '{{ databaseState }}'
;

list_by_instance

Lists the long term retention backups for a given managed instance.

SELECT
id,
name,
backupExpirationTime,
backupStorageAccessTier,
backupStorageRedundancy,
backupTime,
databaseDeletionTime,
databaseName,
managedInstanceCreateTime,
managedInstanceName,
systemData,
type
FROM azure.sql.long_term_retention_managed_instance_backups
WHERE location_name = '{{ location_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
backupExpirationTime,
backupStorageAccessTier,
backupStorageRedundancy,
backupTime,
databaseDeletionTime,
databaseName,
managedInstanceCreateTime,
managedInstanceName,
systemData,
type
FROM azure.sql.long_term_retention_managed_instance_backups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND location_name = '{{ location_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND onlyLatestPerDatabase = '{{ onlyLatestPerDatabase }}'
AND databaseState = '{{ databaseState }}'
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

list_by_location

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

SELECT
id,
name,
backupExpirationTime,
backupStorageAccessTier,
backupStorageRedundancy,
backupTime,
databaseDeletionTime,
databaseName,
managedInstanceCreateTime,
managedInstanceName,
systemData,
type
FROM azure.sql.long_term_retention_managed_instance_backups
WHERE location_name = '{{ location_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND onlyLatestPerDatabase = '{{ onlyLatestPerDatabase }}'
AND databaseState = '{{ databaseState }}'
AND $skip = '{{ $skip }}'
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

DELETE examples

delete_by_resource_group

Deletes a long term retention backup.

DELETE FROM azure.sql.long_term_retention_managed_instance_backups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND location_name = '{{ location_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND database_name = '{{ database_name }}' --required
AND backup_name = '{{ backup_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

delete

Deletes a long term retention backup.

DELETE FROM azure.sql.long_term_retention_managed_instance_backups
WHERE location_name = '{{ location_name }}' --required
AND managed_instance_name = '{{ managed_instance_name }}' --required
AND database_name = '{{ database_name }}' --required
AND backup_name = '{{ backup_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;