recoverable_databases

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

Overview

Name	recoverable_databases
Type	Resource
Id	azure.sql.recoverable_databases

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.
edition	string	The edition of the database.
elasticPoolName	string	The elastic pool name of the database.
keys	object	The resource ids of the user assigned identities to use.
lastAvailableBackupDate	string (date-time)	The last available backup date.
serviceLevelObjective	string	The service level objective name of the database.
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_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.
edition	string	The edition of the database.
elasticPoolName	string	The elastic pool name of the database.
keys	object	The resource ids of the user assigned identities to use.
lastAvailableBackupDate	string (date-time)	The last available backup date.
serviceLevelObjective	string	The service level objective name of the database.
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, database_name, subscription_id	$expand, $filter	Gets a recoverable database.
list_by_server	select	resource_group_name, server_name, subscription_id		Gets a list of recoverable databases.

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
database_name	string	The name of the database. 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
$expand	string	The child resources to include in the response. Default value is None.
$filter	string	An OData filter expression that filters elements in the collection. Default value is None.

SELECT examples

get

Gets a recoverable database.

SELECT
id,
name,
edition,
elasticPoolName,
keys,
lastAvailableBackupDate,
serviceLevelObjective,
systemData,
type
FROM azure.sql.recoverable_databases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
AND $filter = '{{ $filter }}'
;

list_by_server

Gets a list of recoverable databases.

SELECT
id,
name,
edition,
elasticPoolName,
keys,
lastAvailableBackupDate,
serviceLevelObjective,
systemData,
type
FROM azure.sql.recoverable_databases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;