environment_operations
Creates, updates, deletes, gets or lists an environment_operations resource.
Overview​
| Name | environment_operations |
| Type | Resource |
| Id | databricks_workspace.environments.environment_operations |
Fields​
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
name | string | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the ``name`` should be a resource name ending with ``operations/{unique_id}``. |
done | boolean | If the value is ``false``, it means the operation is still in progress. If ``true``, the operation is completed, and either ``error`` or ``response`` is available. |
error | object | The error result of the operation in case of failure or cancellation. |
metadata | object | Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. |
response | object | The normal, successful response of the operation. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | name, deployment_name, workspace_domain | Gets the status of a long-running operation. Clients can use this method to poll the operation result. |
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 |
|---|---|---|
deployment_name | string | The Databricks workspace deployment name: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the session. (default: dbc-abcd0123-a1bc, x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME) |
name | string | The name of the operation resource. |
workspace_domain | string | The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws). (default: cloud.databricks.com, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"cloud.databricks.com","azure":"azuredatabricks.net","gcp":"gcp.databricks.com"}}) |
SELECT examples​
- get
Gets the status of a long-running operation. Clients can use this method to poll the operation result.
SELECT
name,
done,
error,
metadata,
response
FROM databricks_workspace.environments.environment_operations
WHERE name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;