database_operations

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

Overview

Name	database_operations
Type	Resource
Id	azure.sql.database_operations

Fields

The following fields are returned by SELECT queries:

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.
databaseName	string	The name of the database the operation is being performed on.
description	string	The operation description.
errorCode	integer	The operation error code.
errorDescription	string	The operation error description.
errorSeverity	integer	The operation error severity.
estimatedCompletionTime	string (date-time)	The estimated completion time of the operation.
isCancellable	boolean	Whether the operation can be cancelled.
isUserError	boolean	Whether or not the error is a user error.
operation	string	The name of operation.
operationFriendlyName	string	The friendly name of operation.
operationPhaseDetails	object	The operation phase details.
percentComplete	integer	The percentage of the operation completed.
serverName	string	The name of the server.
startTime	string (date-time)	The operation start time.
state	string	The operation state. Known values are: "Pending", "InProgress", "Succeeded", "Failed", "CancelInProgress", and "Cancelled". (Pending, InProgress, Succeeded, Failed, CancelInProgress, Cancelled)
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
list_by_database	select	resource_group_name, server_name, database_name, subscription_id		Gets a list of operations performed on the database.
cancel	exec	resource_group_name, server_name, database_name, operation_id, subscription_id		Cancels the asynchronous operation on the database.

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.
operation_id	string	The operation identifier. 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

SELECT examples

list_by_database

Gets a list of operations performed on the database.

SELECT
id,
name,
databaseName,
description,
errorCode,
errorDescription,
errorSeverity,
estimatedCompletionTime,
isCancellable,
isUserError,
operation,
operationFriendlyName,
operationPhaseDetails,
percentComplete,
serverName,
startTime,
state,
systemData,
type
FROM azure.sql.database_operations
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
;

Lifecycle Methods

cancel

Cancels the asynchronous operation on the database.

EXEC azure.sql.database_operations.cancel 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@database_name='{{ database_name }}' --required, 
@operation_id='{{ operation_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;