operations

Creates, updates, deletes, gets or lists an operations resource.

Overview

Name	operations
Type	Resource
Id	azure.synapse.operations

Fields

The following fields are returned by SELECT queries:

get_azure_async_header_result

Name	Datatype	Description
id	string	Operation ID.
name	string	Operation name.
endTime	string (date-time)	Operation start time.
error	object	Errors from the operation.
percentComplete	number	Completion percentage of the operation.
properties	object	Operation properties.
startTime	string (date-time)	Operation start time.
status	string	Operation status. Known values are: "InProgress", "Succeeded", "Failed", and "Canceled".

check_name_availability

Name	Datatype	Description
name	string	Workspace name.
available	boolean	Whether the workspace name is available.
message	string	Validation message.
reason	string	Reason the workspace name is or is not available.

list

Name	Datatype	Description
name	string	Operation name.
display	object	Display properties of the operation.
isDataAction	string	Whether this operation is a data action.
origin	string	Operation origin.
serviceSpecification	object	Operation service specification.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_azure_async_header_result	select	resource_group_name, workspace_name, operation_id, subscription_id		Get operation status. Get the status of an operation.
check_name_availability	select	subscription_id		Check name availability. Check whether a workspace name is available.
list	select			All operations. Get all available operations.
get_location_header_result	exec	resource_group_name, workspace_name, operation_id, subscription_id		Get operation result. Get the result of an operation.

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
operation_id	string	Operation ID. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get_azure_async_header_result

Get operation status. Get the status of an operation.

SELECT
id,
name,
endTime,
error,
percentComplete,
properties,
startTime,
status
FROM azure.synapse.operations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_name_availability

Check name availability. Check whether a workspace name is available.

SELECT
name,
available,
message,
reason
FROM azure.synapse.operations
WHERE subscription_id = '{{ subscription_id }}' -- required
;

list

All operations. Get all available operations.

SELECT
name,
display,
isDataAction,
origin,
serviceSpecification
FROM azure.synapse.operations
;

Lifecycle Methods

get_location_header_result

Get operation result. Get the result of an operation.

EXEC azure.synapse.operations.get_location_header_result 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@operation_id='{{ operation_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;