managed_instance_operations

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

Overview

Name	managed_instance_operations
Type	Resource
Id	azure.sql.managed_instance_operations

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.
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.
managedInstanceName	string	The name of the managed instance the operation is being performed on.
operation	string	The name of operation.
operationFriendlyName	string	The friendly name of operation.
operationParameters	object	The operation parameters.
operationSteps	object	The operation steps.
percentComplete	integer	The percentage of the operation completed.
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".

list_by_managed_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.
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.
managedInstanceName	string	The name of the managed instance the operation is being performed on.
operation	string	The name of operation.
operationFriendlyName	string	The friendly name of operation.
operationParameters	object	The operation parameters.
operationSteps	object	The operation steps.
percentComplete	integer	The percentage of the operation completed.
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
get	select	resource_group_name, managed_instance_name, operation_id, subscription_id		Gets a management operation on a managed instance.
list_by_managed_instance	select	resource_group_name, managed_instance_name, subscription_id		Gets a list of operations performed on the managed instance.
cancel	exec	resource_group_name, managed_instance_name, operation_id, subscription_id		Cancels the asynchronous operation on the managed instance.

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
managed_instance_name	string	The name of the managed instance. Required.
operation_id	string	Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a management operation on a managed instance.

SELECT
id,
name,
description,
errorCode,
errorDescription,
errorSeverity,
estimatedCompletionTime,
isCancellable,
isUserError,
managedInstanceName,
operation,
operationFriendlyName,
operationParameters,
operationSteps,
percentComplete,
startTime,
state,
systemData,
type
FROM azure.sql.managed_instance_operations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_managed_instance

Gets a list of operations performed on the managed instance.

SELECT
id,
name,
description,
errorCode,
errorDescription,
errorSeverity,
estimatedCompletionTime,
isCancellable,
isUserError,
managedInstanceName,
operation,
operationFriendlyName,
operationParameters,
operationSteps,
percentComplete,
startTime,
state,
systemData,
type
FROM azure.sql.managed_instance_operations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

cancel

Cancels the asynchronous operation on the managed instance.

EXEC azure.sql.managed_instance_operations.cancel 
@resource_group_name='{{ resource_group_name }}' --required, 
@managed_instance_name='{{ managed_instance_name }}' --required, 
@operation_id='{{ operation_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;