From 915295965f82a5e0d91d7e1b7f2301aff793dda2 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Fri, 21 Nov 2025 14:03:54 +0000 Subject: [PATCH 1/5] Regenerate autogenerated files This equalizes a diff with the current version of the templates. --- .../internal/schema/annotations_openapi.yml | 26 ------------ .../schema/annotations_openapi_overrides.yml | 4 ++ bundle/schema/jsonschema.json | 17 +------- cmd/account/workspaces/workspaces.go | 4 +- cmd/workspace/apps/apps.go | 40 +++++++++---------- cmd/workspace/clusters/clusters.go | 4 +- .../model-registry/model-registry.go | 2 +- cmd/workspace/pipelines/pipelines.go | 2 +- cmd/workspace/policies/policies.go | 4 +- cmd/workspace/workspace/workspace.go | 4 +- 10 files changed, 36 insertions(+), 71 deletions(-) diff --git a/bundle/internal/schema/annotations_openapi.yml b/bundle/internal/schema/annotations_openapi.yml index 6e1b1da081..a2704cf7f5 100644 --- a/bundle/internal/schema/annotations_openapi.yml +++ b/bundle/internal/schema/annotations_openapi.yml @@ -1192,8 +1192,6 @@ github.com/databricks/databricks-sdk-go/service/apps.ComputeSize: MEDIUM - |- LARGE - - |- - LIQUID github.com/databricks/databricks-sdk-go/service/apps.ComputeState: "_": "enum": @@ -3761,10 +3759,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: MYSQL - |- POSTGRESQL - - |- - REDSHIFT - - |- - SQLDW - |- SQLSERVER - |- @@ -3789,26 +3783,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: SHAREPOINT - |- DYNAMICS365 - - |- - CONFLUENCE - - |- - META_MARKETING - - |- - GOOGLE_ADS - - |- - TIKTOK_ADS - - |- - SALESFORCE_MARKETING_CLOUD - - |- - HUBSPOT - - |- - WORKDAY_HCM - - |- - GUIDEWIRE - - |- - ZENDESK - - |- - FOREIGN_CATALOG github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger: {} github.com/databricks/databricks-sdk-go/service/pipelines.NotebookLibrary: "path": diff --git a/bundle/internal/schema/annotations_openapi_overrides.yml b/bundle/internal/schema/annotations_openapi_overrides.yml index 72d50bf2ab..51ed3d0db4 100644 --- a/bundle/internal/schema/annotations_openapi_overrides.yml +++ b/bundle/internal/schema/annotations_openapi_overrides.yml @@ -594,6 +594,10 @@ github.com/databricks/cli/bundle/config/resources.SqlWarehousePermissionLevel: CAN_MONITOR - |- CAN_VIEW +github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: + "lifecycle": + "description": |- + PLACEHOLDER github.com/databricks/cli/bundle/config/resources.Volume: "_": "markdown_description": |- diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 3a92b4e929..9c892a15ba 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -3102,8 +3102,7 @@ "type": "string", "enum": [ "MEDIUM", - "LARGE", - "LIQUID" + "LARGE" ] }, { @@ -7090,8 +7089,6 @@ "enum": [ "MYSQL", "POSTGRESQL", - "REDSHIFT", - "SQLDW", "SQLSERVER", "SALESFORCE", "BIGQUERY", @@ -7103,17 +7100,7 @@ "ORACLE", "TERADATA", "SHAREPOINT", - "DYNAMICS365", - "CONFLUENCE", - "META_MARKETING", - "GOOGLE_ADS", - "TIKTOK_ADS", - "SALESFORCE_MARKETING_CLOUD", - "HUBSPOT", - "WORKDAY_HCM", - "GUIDEWIRE", - "ZENDESK", - "FOREIGN_CATALOG" + "DYNAMICS365" ] }, { diff --git a/cmd/account/workspaces/workspaces.go b/cmd/account/workspaces/workspaces.go index 9272b1f8a1..6a360bcd48 100755 --- a/cmd/account/workspaces/workspaces.go +++ b/cmd/account/workspaces/workspaces.go @@ -95,7 +95,7 @@ func newCreate() *cobra.Command { PREMIUM, STANDARD, UNKNOWN, -].`) +]`) cmd.Flags().StringVar(&createReq.PrivateAccessSettingsId, "private-access-settings-id", createReq.PrivateAccessSettingsId, `ID of the workspace's private access settings object.`) cmd.Flags().StringVar(&createReq.StorageConfigurationId, "storage-configuration-id", createReq.StorageConfigurationId, `ID of the workspace's storage configuration object.`) cmd.Flags().StringVar(&createReq.StorageCustomerManagedKeyId, "storage-customer-managed-key-id", createReq.StorageCustomerManagedKeyId, `The ID of the workspace's storage encryption key configuration object.`) @@ -399,7 +399,7 @@ func newUpdate() *cobra.Command { NOT_PROVISIONED, PROVISIONING, RUNNING, -].`) +]`) // TODO: complex arg: gcp_managed_network_config // TODO: complex arg: gke_config cmd.Flags().StringVar(&updateReq.CustomerFacingWorkspace.Location, "location", updateReq.CustomerFacingWorkspace.Location, `The Google Cloud region of the workspace data plane in your Google account (for example, us-east4).`) diff --git a/cmd/workspace/apps/apps.go b/cmd/workspace/apps/apps.go index 8def993cc6..34824ddba0 100755 --- a/cmd/workspace/apps/apps.go +++ b/cmd/workspace/apps/apps.go @@ -86,7 +86,7 @@ func newCreate() *cobra.Command { // TODO: complex arg: active_deployment // TODO: complex arg: app_status cmd.Flags().StringVar(&createReq.App.BudgetPolicyId, "budget-policy-id", createReq.App.BudgetPolicyId, ``) - cmd.Flags().Var(&createReq.App.ComputeSize, "compute-size", `Supported values: [LARGE, LIQUID, MEDIUM]`) + cmd.Flags().Var(&createReq.App.ComputeSize, "compute-size", `Supported values: [LARGE, MEDIUM]`) // TODO: complex arg: compute_status cmd.Flags().StringVar(&createReq.App.Description, "description", createReq.App.Description, `The description of the app.`) // TODO: array: effective_user_api_scopes @@ -97,7 +97,7 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME" cmd.Short = `Create an app.` cmd.Long = `Create an app. - + Creates a new app. Arguments: @@ -205,20 +205,20 @@ func newCreateUpdate() *cobra.Command { cmd.Use = "create-update APP_NAME UPDATE_MASK" cmd.Short = `Create an app update.` cmd.Long = `Create an app update. - + Creates an app update and starts the update process. The update process is asynchronous and the status of the update can be checked with the GetAppUpdate method. Arguments: - APP_NAME: + APP_NAME: UPDATE_MASK: The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the @@ -315,7 +315,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete an app.` cmd.Long = `Delete an app. - + Deletes an app. Arguments: @@ -387,7 +387,7 @@ func newDeploy() *cobra.Command { cmd.Use = "deploy APP_NAME" cmd.Short = `Create an app deployment.` cmd.Long = `Create an app deployment. - + Creates an app deployment for the app with the supplied name. Arguments: @@ -474,7 +474,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get an app.` cmd.Long = `Get an app. - + Retrieves information for the app with the supplied name. Arguments: @@ -530,7 +530,7 @@ func newGetDeployment() *cobra.Command { cmd.Use = "get-deployment APP_NAME DEPLOYMENT_ID" cmd.Short = `Get an app deployment.` cmd.Long = `Get an app deployment. - + Retrieves information for the app deployment with the supplied name and deployment id. @@ -589,7 +589,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels APP_NAME" cmd.Short = `Get app permission levels.` cmd.Long = `Get app permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -645,7 +645,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions APP_NAME" cmd.Short = `Get app permissions.` cmd.Long = `Get app permissions. - + Gets the permissions of an app. Apps can inherit permissions from their root object. @@ -702,7 +702,7 @@ func newGetUpdate() *cobra.Command { cmd.Use = "get-update APP_NAME" cmd.Short = `Get an app update.` cmd.Long = `Get an app update. - + Gets the status of an app update. Arguments: @@ -761,7 +761,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List apps.` cmd.Long = `List apps. - + Lists all apps in the workspace.` cmd.Annotations = make(map[string]string) @@ -812,7 +812,7 @@ func newListDeployments() *cobra.Command { cmd.Use = "list-deployments APP_NAME" cmd.Short = `List app deployments.` cmd.Long = `List app deployments. - + Lists all app deployments for the app with the supplied name. Arguments: @@ -870,7 +870,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions APP_NAME" cmd.Short = `Set app permissions.` cmd.Long = `Set app permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -946,7 +946,7 @@ func newStart() *cobra.Command { cmd.Use = "start NAME" cmd.Short = `Start an app.` cmd.Long = `Start an app. - + Start the last active deployment of the app in the workspace. Arguments: @@ -1027,7 +1027,7 @@ func newStop() *cobra.Command { cmd.Use = "stop NAME" cmd.Short = `Stop an app.` cmd.Long = `Stop an app. - + Stops the active deployment of the app in the workspace. Arguments: @@ -1106,7 +1106,7 @@ func newUpdate() *cobra.Command { // TODO: complex arg: active_deployment // TODO: complex arg: app_status cmd.Flags().StringVar(&updateReq.App.BudgetPolicyId, "budget-policy-id", updateReq.App.BudgetPolicyId, ``) - cmd.Flags().Var(&updateReq.App.ComputeSize, "compute-size", `Supported values: [LARGE, LIQUID, MEDIUM]`) + cmd.Flags().Var(&updateReq.App.ComputeSize, "compute-size", `Supported values: [LARGE, MEDIUM]`) // TODO: complex arg: compute_status cmd.Flags().StringVar(&updateReq.App.Description, "description", updateReq.App.Description, `The description of the app.`) // TODO: array: effective_user_api_scopes @@ -1117,7 +1117,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update an app.` cmd.Long = `Update an app. - + Updates the app with the supplied name. Arguments: @@ -1191,7 +1191,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions APP_NAME" cmd.Short = `Update app permissions.` cmd.Long = `Update app permissions. - + Updates the permissions on an app. Apps can inherit permissions from their root object. diff --git a/cmd/workspace/clusters/clusters.go b/cmd/workspace/clusters/clusters.go index ebaa1e7803..9d99e81062 100755 --- a/cmd/workspace/clusters/clusters.go +++ b/cmd/workspace/clusters/clusters.go @@ -215,7 +215,7 @@ func newCreate() *cobra.Command { NONE, SINGLE_USER, USER_ISOLATION, -].`) +]`) // TODO: complex arg: docker_image cmd.Flags().StringVar(&createReq.DriverInstancePoolId, "driver-instance-pool-id", createReq.DriverInstancePoolId, `The optional ID of the instance pool for the driver of the cluster belongs.`) cmd.Flags().StringVar(&createReq.DriverNodeTypeId, "driver-node-type-id", createReq.DriverNodeTypeId, `The node type of the Spark driver.`) @@ -490,7 +490,7 @@ func newEdit() *cobra.Command { NONE, SINGLE_USER, USER_ISOLATION, -].`) +]`) // TODO: complex arg: docker_image cmd.Flags().StringVar(&editReq.DriverInstancePoolId, "driver-instance-pool-id", editReq.DriverInstancePoolId, `The optional ID of the instance pool for the driver of the cluster belongs.`) cmd.Flags().StringVar(&editReq.DriverNodeTypeId, "driver-node-type-id", editReq.DriverNodeTypeId, `The node type of the Spark driver.`) diff --git a/cmd/workspace/model-registry/model-registry.go b/cmd/workspace/model-registry/model-registry.go index 618b22cce1..8340a80cc9 100755 --- a/cmd/workspace/model-registry/model-registry.go +++ b/cmd/workspace/model-registry/model-registry.go @@ -2148,7 +2148,7 @@ func newTestRegistryWebhook() *cobra.Command { TRANSITION_REQUEST_TO_ARCHIVED_CREATED, TRANSITION_REQUEST_TO_PRODUCTION_CREATED, TRANSITION_REQUEST_TO_STAGING_CREATED, -].`) +]`) cmd.Use = "test-registry-webhook ID" cmd.Short = `Test a webhook.` diff --git a/cmd/workspace/pipelines/pipelines.go b/cmd/workspace/pipelines/pipelines.go index 758c398640..d58dd5f605 100755 --- a/cmd/workspace/pipelines/pipelines.go +++ b/cmd/workspace/pipelines/pipelines.go @@ -763,7 +763,7 @@ func newStartUpdate() *cobra.Command { SCHEMA_CHANGE, SERVICE_UPGRADE, USER_ACTION, -].`) +]`) cmd.Flags().BoolVar(&startUpdateReq.FullRefresh, "full-refresh", startUpdateReq.FullRefresh, `If true, this update will reset all tables before running.`) // TODO: array: full_refresh_selection // TODO: array: refresh_selection diff --git a/cmd/workspace/policies/policies.go b/cmd/workspace/policies/policies.go index 3115ce9a5f..15a45238f9 100755 --- a/cmd/workspace/policies/policies.go +++ b/cmd/workspace/policies/policies.go @@ -93,7 +93,7 @@ func newCreatePolicy() *cobra.Command { STORAGE_CREDENTIAL, TABLE, VOLUME, -].`) +]`) // TODO: complex arg: row_filter cmd.Flags().StringVar(&createPolicyReq.PolicyInfo.WhenCondition, "when-condition", createPolicyReq.PolicyInfo.WhenCondition, `Optional condition when the policy should take effect.`) @@ -432,7 +432,7 @@ func newUpdatePolicy() *cobra.Command { STORAGE_CREDENTIAL, TABLE, VOLUME, -].`) +]`) // TODO: complex arg: row_filter cmd.Flags().StringVar(&updatePolicyReq.PolicyInfo.WhenCondition, "when-condition", updatePolicyReq.PolicyInfo.WhenCondition, `Optional condition when the policy should take effect.`) diff --git a/cmd/workspace/workspace/workspace.go b/cmd/workspace/workspace/workspace.go index 0b4b7e7ddf..502b11fdb7 100755 --- a/cmd/workspace/workspace/workspace.go +++ b/cmd/workspace/workspace/workspace.go @@ -180,7 +180,7 @@ func newExport() *cobra.Command { RAW, R_MARKDOWN, SOURCE, -].`) +]`) cmd.Use = "export PATH" cmd.Short = `Export a workspace object.` @@ -444,7 +444,7 @@ func newImport() *cobra.Command { RAW, R_MARKDOWN, SOURCE, -].`) +]`) cmd.Flags().Var(&importReq.Language, "language", `The language of the object. Supported values: [PYTHON, R, SCALA, SQL]`) cmd.Flags().BoolVar(&importReq.Overwrite, "overwrite", importReq.Overwrite, `The flag that specifies whether to overwrite existing object.`) From 5e218b7f8d2851c5e134dac406e8dce3a4671596 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Fri, 21 Nov 2025 15:39:37 +0100 Subject: [PATCH 2/5] Update acc --- acceptance/cmd/workspace/apps/output.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/acceptance/cmd/workspace/apps/output.txt b/acceptance/cmd/workspace/apps/output.txt index 775a200604..f7d7a7b07b 100644 --- a/acceptance/cmd/workspace/apps/output.txt +++ b/acceptance/cmd/workspace/apps/output.txt @@ -64,7 +64,7 @@ Usage: Flags: --budget-policy-id string - --compute-size ComputeSize Supported values: [LARGE, LIQUID, MEDIUM] + --compute-size ComputeSize Supported values: [LARGE, MEDIUM] --description string The description of the app. -h, --help help for update --json JSON either inline JSON string or @path/to/file.json with request body (default JSON (0 bytes)) From 27ef046fe770f32376756fd6a242a0e124a5f964 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Fri, 21 Nov 2025 15:48:25 +0100 Subject: [PATCH 3/5] Revert annotation overrides --- bundle/internal/schema/annotations_openapi_overrides.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/bundle/internal/schema/annotations_openapi_overrides.yml b/bundle/internal/schema/annotations_openapi_overrides.yml index 51ed3d0db4..72d50bf2ab 100644 --- a/bundle/internal/schema/annotations_openapi_overrides.yml +++ b/bundle/internal/schema/annotations_openapi_overrides.yml @@ -594,10 +594,6 @@ github.com/databricks/cli/bundle/config/resources.SqlWarehousePermissionLevel: CAN_MONITOR - |- CAN_VIEW -github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: - "lifecycle": - "description": |- - PLACEHOLDER github.com/databricks/cli/bundle/config/resources.Volume: "_": "markdown_description": |- From e9e4e9f3e89959e4d64c82dd173666e9880eb4c4 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Fri, 21 Nov 2025 15:34:16 +0100 Subject: [PATCH 4/5] Implement wsfix target to automatically fix whitespace issues - Add --fix flag support to validate_whitespace.py - Add wsfix target to Makefile for automatic whitespace fixing - Fix trailing whitespace and newline issues in 169 files --- .wsignore | 4 - Makefile | 5 +- cmd/account/access-control/access-control.go | 12 +- cmd/account/billable-usage/billable-usage.go | 10 +- cmd/account/budget-policy/budget-policy.go | 10 +- cmd/account/budgets/budgets.go | 10 +- cmd/account/credentials/credentials.go | 14 +- .../csp-enablement-account.go | 6 +- .../custom-app-integration.go | 12 +- .../disable-legacy-features.go | 8 +- .../enable-ip-access-lists.go | 6 +- .../encryption-keys/encryption-keys.go | 20 +-- .../esm-enablement-account.go | 4 +- .../federation-policy/federation-policy.go | 22 +-- cmd/account/groups-v2/groups-v2.go | 14 +- cmd/account/groups/groups.go | 14 +- cmd/account/iam-v2/iam-v2.go | 8 +- .../ip-access-lists/ip-access-lists.go | 44 +++--- .../llm-proxy-partner-powered-account.go | 4 +- .../llm-proxy-partner-powered-enforce.go | 4 +- cmd/account/log-delivery/log-delivery.go | 34 ++--- .../metastore-assignments.go | 10 +- cmd/account/metastores/metastores.go | 10 +- .../network-connectivity.go | 28 ++-- .../network-policies/network-policies.go | 10 +- cmd/account/networks/networks.go | 10 +- .../o-auth-published-apps.go | 2 +- .../personal-compute/personal-compute.go | 8 +- cmd/account/private-access/private-access.go | 10 +- .../published-app-integration.go | 12 +- .../service-principal-federation-policy.go | 30 ++-- .../service-principal-secrets.go | 12 +- .../service-principals-v2.go | 14 +- .../service-principals/service-principals.go | 14 +- cmd/account/settings-v2/settings-v2.go | 6 +- .../storage-credentials.go | 12 +- cmd/account/storage/storage.go | 8 +- .../usage-dashboards/usage-dashboards.go | 4 +- cmd/account/users-v2/users-v2.go | 14 +- cmd/account/users/users.go | 14 +- cmd/account/vpc-endpoints/vpc-endpoints.go | 16 +-- .../workspace-assignment.go | 8 +- .../workspace-network-configuration.go | 4 +- cmd/account/workspaces/workspaces.go | 26 ++-- .../aibi-dashboard-embedding-access-policy.go | 6 +- ...bi-dashboard-embedding-approved-domains.go | 6 +- cmd/workspace/alerts-legacy/alerts-legacy.go | 34 ++--- cmd/workspace/alerts-v2/alerts-v2.go | 16 +-- cmd/workspace/alerts/alerts.go | 14 +- cmd/workspace/apps-settings/apps-settings.go | 10 +- cmd/workspace/apps/apps.go | 36 ++--- .../artifact-allowlists.go | 8 +- .../automatic-cluster-update.go | 4 +- cmd/workspace/catalogs/catalogs.go | 16 +-- .../clean-room-asset-revisions.go | 8 +- .../clean-room-assets/clean-room-assets.go | 28 ++-- .../clean-room-auto-approval-rules.go | 10 +- .../clean-room-task-runs.go | 2 +- cmd/workspace/clean-rooms/clean-rooms.go | 16 +-- .../cluster-policies/cluster-policies.go | 24 ++-- cmd/workspace/clusters/clusters.go | 72 +++++----- .../compliance-security-profile.go | 6 +- cmd/workspace/connections/connections.go | 18 +-- .../consumer-fulfillments.go | 4 +- .../consumer-installations.go | 10 +- .../consumer-listings/consumer-listings.go | 8 +- .../consumer-personalization-requests.go | 6 +- .../consumer-providers/consumer-providers.go | 6 +- .../credentials-manager.go | 2 +- cmd/workspace/credentials/credentials.go | 30 ++-- cmd/workspace/current-user/current-user.go | 2 +- .../dashboard-email-subscriptions.go | 6 +- .../dashboard-widgets/dashboard-widgets.go | 6 +- cmd/workspace/dashboards/dashboards.go | 14 +- cmd/workspace/data-quality/data-quality.go | 128 ++++++++--------- cmd/workspace/data-sources/data-sources.go | 12 +- cmd/workspace/database/database.go | 18 +-- .../default-namespace/default-namespace.go | 10 +- .../default-warehouse-id.go | 6 +- .../disable-legacy-access.go | 8 +- .../disable-legacy-dbfs.go | 10 +- .../enable-export-notebook.go | 4 +- .../enable-notebook-table-clipboard.go | 4 +- .../enable-results-downloading.go | 4 +- .../enhanced-security-monitoring.go | 6 +- .../entity-tag-assignments.go | 32 ++--- cmd/workspace/experiments/experiments.go | 116 +++++++-------- .../external-lineage/external-lineage.go | 12 +- .../external-locations/external-locations.go | 18 +-- .../external-metadata/external-metadata.go | 18 +-- .../feature-engineering.go | 12 +- cmd/workspace/feature-store/feature-store.go | 2 +- cmd/workspace/forecasting/forecasting.go | 4 +- cmd/workspace/functions/functions.go | 20 +-- cmd/workspace/genie/genie.go | 34 ++--- .../git-credentials/git-credentials.go | 14 +- .../global-init-scripts.go | 12 +- cmd/workspace/grants/grants.go | 16 +-- cmd/workspace/groups-v2/groups-v2.go | 14 +- cmd/workspace/groups/groups.go | 14 +- .../instance-pools/instance-pools.go | 24 ++-- .../instance-profiles/instance-profiles.go | 24 ++-- .../ip-access-lists/ip-access-lists.go | 44 +++--- cmd/workspace/jobs/jobs.go | 50 +++---- .../lakeview-embedded/lakeview-embedded.go | 2 +- cmd/workspace/lakeview/lakeview.go | 16 +-- cmd/workspace/libraries/libraries.go | 14 +- .../llm-proxy-partner-powered-workspace.go | 6 +- .../materialized-features.go | 10 +- cmd/workspace/metastores/metastores.go | 28 ++-- .../model-registry/model-registry.go | 116 +++++++-------- .../model-versions/model-versions.go | 28 ++-- .../notification-destinations.go | 10 +- cmd/workspace/online-tables/online-tables.go | 6 +- cmd/workspace/permissions/permissions.go | 10 +- cmd/workspace/pipelines/pipelines.go | 30 ++-- cmd/workspace/policies/policies.go | 20 +-- .../policy-compliance-for-clusters.go | 16 +-- .../policy-compliance-for-jobs.go | 10 +- .../policy-families/policy-families.go | 8 +- .../provider-exchange-filters.go | 8 +- .../provider-exchanges/provider-exchanges.go | 16 +-- .../provider-files/provider-files.go | 8 +- .../provider-listings/provider-listings.go | 10 +- .../provider-personalization-requests.go | 4 +- .../provider-provider-analytics-dashboards.go | 2 +- .../provider-providers/provider-providers.go | 10 +- cmd/workspace/providers/providers.go | 18 +-- .../quality-monitor-v2/quality-monitor-v2.go | 10 +- .../quality-monitors/quality-monitors.go | 54 +++---- .../queries-legacy/queries-legacy.go | 48 +++---- cmd/workspace/queries/queries.go | 16 +-- cmd/workspace/query-history/query-history.go | 4 +- .../query-visualizations-legacy.go | 22 +-- .../query-visualizations.go | 10 +- .../recipient-activation.go | 6 +- .../recipient-federation-policies.go | 16 +-- cmd/workspace/recipients/recipients.go | 24 ++-- .../registered-models/registered-models.go | 44 +++--- cmd/workspace/repos/repos.go | 22 +-- .../resource-quotas/resource-quotas.go | 8 +- .../restrict-workspace-admins.go | 6 +- cmd/workspace/rfa/rfa.go | 16 +-- cmd/workspace/schemas/schemas.go | 14 +- cmd/workspace/secrets/secrets.go | 134 +++++++++--------- .../service-principal-secrets-proxy.go | 12 +- .../service-principals-v2.go | 14 +- .../service-principals/service-principals.go | 14 +- .../serving-endpoints/serving-endpoints.go | 36 ++--- cmd/workspace/shares/shares.go | 26 ++-- .../sql-results-download.go | 6 +- .../storage-credentials.go | 28 ++-- .../system-schemas/system-schemas.go | 10 +- .../table-constraints/table-constraints.go | 12 +- cmd/workspace/tables/tables.go | 38 ++--- cmd/workspace/tag-policies/tag-policies.go | 16 +-- .../temporary-path-credentials.go | 10 +- .../temporary-table-credentials.go | 4 +- .../token-management/token-management.go | 16 +-- cmd/workspace/tokens/tokens.go | 8 +- cmd/workspace/users-v2/users-v2.go | 22 +-- cmd/workspace/users/users.go | 22 +-- .../vector-search-endpoints.go | 12 +- .../vector-search-indexes.go | 20 +-- cmd/workspace/volumes/volumes.go | 34 ++--- cmd/workspace/warehouses/warehouses.go | 26 ++-- .../workspace-bindings/workspace-bindings.go | 20 +-- .../workspace-conf/workspace-conf.go | 4 +- .../workspace-iam-v2/workspace-iam-v2.go | 8 +- .../workspace-settings-v2.go | 6 +- cmd/workspace/workspace/workspace.go | 30 ++-- tools/post-generate.sh | 3 + tools/validate_whitespace.py | 57 +++++++- 173 files changed, 1542 insertions(+), 1497 deletions(-) diff --git a/.wsignore b/.wsignore index 0be6584879..5f9602c5c0 100644 --- a/.wsignore +++ b/.wsignore @@ -20,10 +20,6 @@ acceptance/selftest/record_cloud/volume-io/hello.txt # bundle commands leave empty lines at the end; too many to list individually: acceptance/**/out*.txt -# Extra whitespace in generated commands: -cmd/workspace/**/*.go -cmd/account/**/*.go - # Extra whitespace in generated Python models python/databricks/bundles/*/_models/*.py diff --git a/Makefile b/Makefile index 2c778e782e..bb976362a2 100644 --- a/Makefile +++ b/Makefile @@ -46,6 +46,9 @@ tools/golangci-lint: tools/go.mod tools/go.sum ws: ./tools/validate_whitespace.py +wsfix: + ./tools/validate_whitespace.py --fix + links: ./tools/update_github_links.py @@ -147,4 +150,4 @@ generate: $(GENKIT_BINARY) update-sdk -.PHONY: lint lintfull tidy lintcheck fmt fmtfull test cover showcover build snapshot snapshot-release schema integration integration-short acc-cover acc-showcover docs ws links checks test-update test-update-templates test-update-aws test-update-all generate-validation +.PHONY: lint lintfull tidy lintcheck fmt fmtfull test cover showcover build snapshot snapshot-release schema integration integration-short acc-cover acc-showcover docs ws wsfix links checks test-update test-update-templates test-update-aws test-update-all generate-validation diff --git a/cmd/account/access-control/access-control.go b/cmd/account/access-control/access-control.go index 829dd02a90..e9685e93c1 100755 --- a/cmd/account/access-control/access-control.go +++ b/cmd/account/access-control/access-control.go @@ -61,14 +61,14 @@ func newGetAssignableRolesForResource() *cobra.Command { cmd.Use = "get-assignable-roles-for-resource RESOURCE" cmd.Short = `Get assignable roles for a resource.` cmd.Long = `Get assignable roles for a resource. - + Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the resource can contain an access rule of the role. Arguments: RESOURCE: The resource name for which assignable roles will be listed. - + Examples | Summary :--- | :--- resource=accounts/ | A resource name for the account. resource=accounts//groups/ | A resource name for @@ -127,14 +127,14 @@ func newGetRuleSet() *cobra.Command { cmd.Use = "get-rule-set NAME ETAG" cmd.Short = `Get a rule set.` cmd.Long = `Get a rule set. - + Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the said resource. Currently only a default rule set for each resource is supported. Arguments: NAME: The ruleset name associated with the request. - + Examples | Summary :--- | :--- name=accounts//ruleSets/default | A name for a rule set on the account. @@ -152,7 +152,7 @@ func newGetRuleSet() *cobra.Command { conditions that is get an etag from a GET rule set request, and pass it with the PUT update request to identify the rule set version you are updating. - + Examples | Summary :--- | :--- etag= | An empty etag can only be used in GET to indicate no freshness requirements. etag=RENUAAABhSweA4NvVmmUYdiU717H3Tgy0UJdor3gE4a+mq/oj9NjAf8ZsQ== | An @@ -212,7 +212,7 @@ func newUpdateRuleSet() *cobra.Command { cmd.Use = "update-rule-set" cmd.Short = `Update a rule set.` cmd.Long = `Update a rule set. - + Replace the rules of a rule set. First, use get to read the current version of the rule set before modifying it. This pattern helps prevent conflicts between concurrent updates.` diff --git a/cmd/account/billable-usage/billable-usage.go b/cmd/account/billable-usage/billable-usage.go index 4e7949336d..e7add54857 100755 --- a/cmd/account/billable-usage/billable-usage.go +++ b/cmd/account/billable-usage/billable-usage.go @@ -57,19 +57,19 @@ func newDownload() *cobra.Command { cmd.Use = "download START_MONTH END_MONTH" cmd.Short = `Return billable usage logs.` cmd.Long = `Return billable usage logs. - + Returns billable usage logs in CSV format for the specified account and date range. For the data schema, see: - + - AWS: [CSV file schema]. - GCP: [CSV file schema]. - + Note that this method might take multiple minutes to complete. - + **Warning**: Depending on the queried date range, the number of workspaces in the account, the size of the response and the internet speed of the caller, this API may hit a timeout after a few minutes. If you experience this, try to mitigate by calling the API with narrower date ranges. - + [CSV file schema]: https://docs.gcp.databricks.com/administration-guide/account-settings/usage-analysis.html#csv-file-schema Arguments: diff --git a/cmd/account/budget-policy/budget-policy.go b/cmd/account/budget-policy/budget-policy.go index a921d9ddfd..7525930256 100755 --- a/cmd/account/budget-policy/budget-policy.go +++ b/cmd/account/budget-policy/budget-policy.go @@ -65,7 +65,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a budget policy.` cmd.Long = `Create a budget policy. - + Creates a new policy.` cmd.Annotations = make(map[string]string) @@ -129,7 +129,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete POLICY_ID" cmd.Short = `Delete a budget policy.` cmd.Long = `Delete a budget policy. - + Deletes a policy Arguments: @@ -185,7 +185,7 @@ func newGet() *cobra.Command { cmd.Use = "get POLICY_ID" cmd.Short = `Get a budget policy.` cmd.Long = `Get a budget policy. - + Retrieves a policy by it's ID. Arguments: @@ -246,7 +246,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List policies.` cmd.Long = `List policies. - + Lists all policies. Policies are returned in the alphabetically ascending order of their names.` @@ -304,7 +304,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update POLICY_ID" cmd.Short = `Update a budget policy.` cmd.Long = `Update a budget policy. - + Updates a policy Arguments: diff --git a/cmd/account/budgets/budgets.go b/cmd/account/budgets/budgets.go index 71c4621801..68c3593895 100755 --- a/cmd/account/budgets/budgets.go +++ b/cmd/account/budgets/budgets.go @@ -67,7 +67,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create new budget.` cmd.Long = `Create new budget. - + Create a new budget configuration for an account. For full details, see https://docs.databricks.com/en/admin/account-settings/budgets.html.` @@ -129,7 +129,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete BUDGET_ID" cmd.Short = `Delete budget.` cmd.Long = `Delete budget. - + Deletes a budget configuration for an account. Both account and budget configuration are specified by ID. This cannot be undone. @@ -186,7 +186,7 @@ func newGet() *cobra.Command { cmd.Use = "get BUDGET_ID" cmd.Short = `Get budget.` cmd.Long = `Get budget. - + Gets a budget configuration for an account. Both account and budget configuration are specified by ID. @@ -245,7 +245,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get all budgets.` cmd.Long = `Get all budgets. - + Gets all budgets associated with this account.` cmd.Annotations = make(map[string]string) @@ -296,7 +296,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update BUDGET_ID" cmd.Short = `Modify budget.` cmd.Long = `Modify budget. - + Updates a budget configuration for an account. Both account and budget configuration are specified by ID. diff --git a/cmd/account/credentials/credentials.go b/cmd/account/credentials/credentials.go index 65d5e6bfef..f77d98962d 100755 --- a/cmd/account/credentials/credentials.go +++ b/cmd/account/credentials/credentials.go @@ -67,20 +67,20 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create credential configuration.` cmd.Long = `Create credential configuration. - + Creates a Databricks credential configuration that represents cloud cross-account credentials for a specified account. Databricks uses this to set up network infrastructure properly to host Databricks clusters. For your AWS IAM role, you need to trust the External ID (the Databricks Account API account ID) in the returned credential object, and configure the required access policy. - + Save the response's credentials_id field, which is the ID for your new credential configuration object. - + For information about how to create a new workspace with this API, see [Create a new workspace using the Account API] - + [Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html` cmd.Annotations = make(map[string]string) @@ -141,7 +141,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete CREDENTIALS_ID" cmd.Short = `Delete credential configuration.` cmd.Long = `Delete credential configuration. - + Deletes a Databricks credential configuration object for an account, both specified by ID. You cannot delete a credential that is associated with any workspace. @@ -199,7 +199,7 @@ func newGet() *cobra.Command { cmd.Use = "get CREDENTIALS_ID" cmd.Short = `Get credential configuration.` cmd.Long = `Get credential configuration. - + Gets a Databricks credential configuration object for an account, both specified by ID. @@ -253,7 +253,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List credential configuration.` cmd.Long = `List credential configuration. - + List Databricks credential configuration objects for an account, specified by ID.` diff --git a/cmd/account/csp-enablement-account/csp-enablement-account.go b/cmd/account/csp-enablement-account/csp-enablement-account.go index ce2e00fa48..9463fefbc4 100755 --- a/cmd/account/csp-enablement-account/csp-enablement-account.go +++ b/cmd/account/csp-enablement-account/csp-enablement-account.go @@ -25,7 +25,7 @@ func New() *cobra.Command { to enable it for new workspaces. By default, this account-level setting is disabled for new workspaces. After workspace creation, account admins can enable the compliance security profile individually for each workspace. - + This settings can be disabled so that new workspaces do not have compliance security profile enabled by default.`, RunE: root.ReportUnknownSubcommand, @@ -62,7 +62,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the compliance security profile setting for new workspaces.` cmd.Long = `Get the compliance security profile setting for new workspaces. - + Gets the compliance security profile setting for new workspaces.` cmd.Annotations = make(map[string]string) @@ -116,7 +116,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the compliance security profile setting for new workspaces.` cmd.Long = `Update the compliance security profile setting for new workspaces. - + Updates the value of the compliance security profile setting for new workspaces.` diff --git a/cmd/account/custom-app-integration/custom-app-integration.go b/cmd/account/custom-app-integration/custom-app-integration.go index 7a7f82e814..ae46bae950 100755 --- a/cmd/account/custom-app-integration/custom-app-integration.go +++ b/cmd/account/custom-app-integration/custom-app-integration.go @@ -71,9 +71,9 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create Custom OAuth App Integration.` cmd.Long = `Create Custom OAuth App Integration. - + Create Custom OAuth App Integration. - + You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.` @@ -138,7 +138,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete INTEGRATION_ID" cmd.Short = `Delete Custom OAuth App Integration.` cmd.Long = `Delete Custom OAuth App Integration. - + Delete an existing Custom OAuth App Integration. You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.` @@ -192,7 +192,7 @@ func newGet() *cobra.Command { cmd.Use = "get INTEGRATION_ID" cmd.Short = `Get OAuth Custom App Integration.` cmd.Long = `Get OAuth Custom App Integration. - + Gets the Custom OAuth App Integration for the given integration id. Arguments: @@ -252,7 +252,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get custom oauth app integrations.` cmd.Long = `Get custom oauth app integrations. - + Get the list of custom OAuth app integrations for the specified Databricks account` @@ -309,7 +309,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update INTEGRATION_ID" cmd.Short = `Updates Custom OAuth App Integration.` cmd.Long = `Updates Custom OAuth App Integration. - + Updates an existing custom OAuth App Integration. You can retrieve the custom OAuth app integration via :method:CustomAppIntegration/get.` diff --git a/cmd/account/disable-legacy-features/disable-legacy-features.go b/cmd/account/disable-legacy-features/disable-legacy-features.go index 063a55c743..38536d22ca 100755 --- a/cmd/account/disable-legacy-features/disable-legacy-features.go +++ b/cmd/account/disable-legacy-features/disable-legacy-features.go @@ -22,7 +22,7 @@ func New() *cobra.Command { Use: "disable-legacy-features", Short: `Disable legacy features for new Databricks workspaces.`, Long: `Disable legacy features for new Databricks workspaces. - + For newly created workspaces: 1. Disables the use of DBFS root and mounts. 2. Hive Metastore will not be provisioned. 3. Disables the use of ‘No-isolation clusters’. 4. Disables Databricks Runtime versions prior to 13.3LTS.`, @@ -61,7 +61,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete the disable legacy features setting.` cmd.Long = `Delete the disable legacy features setting. - + Deletes the disable legacy features setting.` cmd.Annotations = make(map[string]string) @@ -114,7 +114,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the disable legacy features setting.` cmd.Long = `Get the disable legacy features setting. - + Gets the value of the disable legacy features setting.` cmd.Annotations = make(map[string]string) @@ -168,7 +168,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the disable legacy features setting.` cmd.Long = `Update the disable legacy features setting. - + Updates the value of the disable legacy features setting.` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/enable-ip-access-lists/enable-ip-access-lists.go b/cmd/account/enable-ip-access-lists/enable-ip-access-lists.go index 5159563179..f4e0362ed0 100755 --- a/cmd/account/enable-ip-access-lists/enable-ip-access-lists.go +++ b/cmd/account/enable-ip-access-lists/enable-ip-access-lists.go @@ -61,7 +61,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete the account IP access toggle setting.` cmd.Long = `Delete the account IP access toggle setting. - + Reverts the value of the account IP access toggle setting to default (ON)` cmd.Annotations = make(map[string]string) @@ -114,7 +114,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the account IP access toggle setting.` cmd.Long = `Get the account IP access toggle setting. - + Gets the value of the account IP access toggle setting.` cmd.Annotations = make(map[string]string) @@ -168,7 +168,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the account IP access toggle setting.` cmd.Long = `Update the account IP access toggle setting. - + Updates the value of the account IP access toggle setting.` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/encryption-keys/encryption-keys.go b/cmd/account/encryption-keys/encryption-keys.go index 5645dec927..143e4875ad 100755 --- a/cmd/account/encryption-keys/encryption-keys.go +++ b/cmd/account/encryption-keys/encryption-keys.go @@ -25,12 +25,12 @@ func New() *cobra.Command { A key configuration encapsulates the AWS KMS key information and some information about how the key configuration can be used. There are two possible uses for key configurations: - + * Managed services: A key configuration can be used to encrypt a workspace's notebook and secret data in the control plane, as well as Databricks SQL queries and query history. * Storage: A key configuration can be used to encrypt a workspace's DBFS and EBS data in the data plane. - + In both of these cases, the key configuration's ID is used when creating a new workspace. This Preview feature is available if your account is on the E2 version of the platform. Updating a running workspace with workspace storage @@ -81,7 +81,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create encryption key configuration.` cmd.Long = `Create encryption key configuration. - + Creates a customer-managed key configuration object for an account, specified by ID. This operation uploads a reference to a customer-managed key to Databricks. If the key is assigned as a workspace's customer-managed key for @@ -91,11 +91,11 @@ func newCreate() *cobra.Command { workspace storage, the key encrypts the workspace's root S3 bucket (which contains the workspace's root DBFS and system data) and, optionally, cluster EBS volume data. - + **Important**: Customer-managed keys are supported only for some deployment types, subscription types, and AWS regions that currently support creation of Databricks workspaces. - + This operation is available only if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.` @@ -158,7 +158,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete CUSTOMER_MANAGED_KEY_ID" cmd.Short = `Delete encryption key configuration.` cmd.Long = `Delete encryption key configuration. - + Deletes a customer-managed key configuration object for an account. You cannot delete a configuration that is associated with a running workspace. @@ -215,7 +215,7 @@ func newGet() *cobra.Command { cmd.Use = "get CUSTOMER_MANAGED_KEY_ID" cmd.Short = `Get encryption key configuration.` cmd.Long = `Get encryption key configuration. - + Gets a customer-managed key configuration object for an account, specified by ID. This operation uploads a reference to a customer-managed key to Databricks. If assigned as a workspace's customer-managed key for managed @@ -225,10 +225,10 @@ func newGet() *cobra.Command { the key encrypts the workspace's root S3 bucket (which contains the workspace's root DBFS and system data) and, optionally, cluster EBS volume data. - + **Important**: Customer-managed keys are supported only for some deployment types, subscription types, and AWS regions. - + This operation is available only if your account is on the E2 version of the platform.", @@ -282,7 +282,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List encryption key configuration.` cmd.Long = `List encryption key configuration. - + Lists Databricks customer-managed key configurations for an account.` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/esm-enablement-account/esm-enablement-account.go b/cmd/account/esm-enablement-account/esm-enablement-account.go index 11e8da461c..831b058121 100755 --- a/cmd/account/esm-enablement-account/esm-enablement-account.go +++ b/cmd/account/esm-enablement-account/esm-enablement-account.go @@ -60,7 +60,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the enhanced security monitoring setting for new workspaces.` cmd.Long = `Get the enhanced security monitoring setting for new workspaces. - + Gets the enhanced security monitoring setting for new workspaces.` cmd.Annotations = make(map[string]string) @@ -114,7 +114,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the enhanced security monitoring setting for new workspaces.` cmd.Long = `Update the enhanced security monitoring setting for new workspaces. - + Updates the value of the enhanced security monitoring setting for new workspaces.` diff --git a/cmd/account/federation-policy/federation-policy.go b/cmd/account/federation-policy/federation-policy.go index d7b2e6c13c..03f320de33 100755 --- a/cmd/account/federation-policy/federation-policy.go +++ b/cmd/account/federation-policy/federation-policy.go @@ -20,23 +20,23 @@ func New() *cobra.Command { Use: "federation-policy", Short: `These APIs manage account federation policies.`, Long: `These APIs manage account federation policies. - + Account federation policies allow users and service principals in your Databricks account to securely access Databricks APIs using tokens from your trusted identity providers (IdPs). - + With token federation, your users and service principals can exchange tokens from your IdP for Databricks OAuth tokens, which can be used to access Databricks APIs. Token federation eliminates the need to manage Databricks secrets, and allows you to centralize management of token issuance policies in your IdP. Databricks token federation is typically used in combination with [SCIM], so users in your IdP are synchronized into your Databricks account. - + Token federation is configured in your Databricks account using an account federation policy. An account federation policy specifies: * which IdP, or issuer, your Databricks account should accept tokens from * how to determine which Databricks user, or subject, a token is issued for - + To configure a federation policy, you provide the following: * The required token __issuer__, as specified in the “iss” claim of your tokens. The issuer is an https URL that identifies your IdP. * The allowed token @@ -51,22 +51,22 @@ func New() *cobra.Command { (recommended), Databricks automatically fetches the public keys from your issuer’s well known endpoint. Databricks strongly recommends relying on your issuer’s well known endpoint for discovering public keys. - + An example federation policy is: issuer: "https://idp.mycompany.com/oidc" - audiences: ["databricks"] subject_claim: "sub" - + audiences: ["databricks"] subject_claim: "sub" + An example JWT token body that matches this policy and could be used to authenticate to Databricks as user username@mycompany.com is: { "iss": "https://idp.mycompany.com/oidc", "aud": "databricks", "sub": - "username@mycompany.com" } - + "username@mycompany.com" } + You may also need to configure your IdP to generate tokens for your users to exchange with Databricks, if your users do not already have the ability to generate tokens that are compatible with your federation policy. - + You do not need to configure an OAuth application in Databricks to use token federation. - + [SCIM]: https://docs.databricks.com/admin/users-groups/scim/index.html`, GroupID: "oauth2", Annotations: map[string]string{ diff --git a/cmd/account/groups-v2/groups-v2.go b/cmd/account/groups-v2/groups-v2.go index a5f79859b3..735ef35013 100755 --- a/cmd/account/groups-v2/groups-v2.go +++ b/cmd/account/groups-v2/groups-v2.go @@ -21,7 +21,7 @@ func New() *cobra.Command { Short: `Groups simplify identity management, making it easier to assign access to Databricks account, data, and other securable objects.`, Long: `Groups simplify identity management, making it easier to assign access to Databricks account, data, and other securable objects. - + It is best practice to assign access to workspaces and access-control policies in Unity Catalog to groups, instead of to users individually. All Databricks account identities can be assigned as members of groups, and members inherit @@ -76,7 +76,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new group.` cmd.Long = `Create a new group. - + Creates a group in the Databricks account with a unique name, using the supplied group details.` @@ -141,7 +141,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a group.` cmd.Long = `Delete a group. - + Deletes a group from the Databricks account. Arguments: @@ -197,7 +197,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get group details.` cmd.Long = `Get group details. - + Gets the information for a specific group in the Databricks account. Arguments: @@ -261,7 +261,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List group details.` cmd.Long = `List group details. - + Gets all details of the groups associated with the Databricks account. As of 08/22/2025, this endpoint will not return members. Instead, members should be retrieved by iterating through Get group details.` @@ -317,7 +317,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update group details.` cmd.Long = `Update group details. - + Partially updates the details of a group. Arguments: @@ -394,7 +394,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace a group.` cmd.Long = `Replace a group. - + Updates the details of a group by replacing the entire group entity. Arguments: diff --git a/cmd/account/groups/groups.go b/cmd/account/groups/groups.go index e446bb04cb..389a5c6677 100755 --- a/cmd/account/groups/groups.go +++ b/cmd/account/groups/groups.go @@ -23,7 +23,7 @@ func New() *cobra.Command { Short: `Groups simplify identity management, making it easier to assign access to Databricks account, data, and other securable objects.`, Long: `Groups simplify identity management, making it easier to assign access to Databricks account, data, and other securable objects. - + It is best practice to assign access to workspaces and access-control policies in Unity Catalog to groups, instead of to users individually. All Databricks account identities can be assigned as members of groups, and members inherit @@ -81,7 +81,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new group.` cmd.Long = `Create a new group. - + Creates a group in the Databricks account with a unique name, using the supplied group details.` @@ -146,7 +146,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a group.` cmd.Long = `Delete a group. - + Deletes a group from the Databricks account. Arguments: @@ -214,7 +214,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get group details.` cmd.Long = `Get group details. - + Gets the information for a specific group in the Databricks account. Arguments: @@ -290,7 +290,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List group details.` cmd.Long = `List group details. - + Gets all details of the groups associated with the Databricks account. As of 08/22/2025, this endpoint will not return members. Instead, members should be retrieved by iterating through Get group details.` @@ -346,7 +346,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update group details.` cmd.Long = `Update group details. - + Partially updates the details of a group. Arguments: @@ -439,7 +439,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace a group.` cmd.Long = `Replace a group. - + Updates the details of a group by replacing the entire group entity. Arguments: diff --git a/cmd/account/iam-v2/iam-v2.go b/cmd/account/iam-v2/iam-v2.go index e1865ead83..a9659508a8 100755 --- a/cmd/account/iam-v2/iam-v2.go +++ b/cmd/account/iam-v2/iam-v2.go @@ -63,7 +63,7 @@ func newGetWorkspaceAccessDetail() *cobra.Command { cmd.Use = "get-workspace-access-detail WORKSPACE_ID PRINCIPAL_ID" cmd.Short = `Get workspace access details for a principal.` cmd.Long = `Get workspace access details for a principal. - + Returns the access details for a principal in a workspace. Allows for checking access details for any provisioned principal (user, service principal, or group) in a workspace. * Provisioned principal here refers to one that has @@ -138,7 +138,7 @@ func newResolveGroup() *cobra.Command { cmd.Use = "resolve-group EXTERNAL_ID" cmd.Short = `Resolve an external group in the Databricks account.` cmd.Long = `Resolve an external group in the Databricks account. - + Resolves a group with the given external ID from the customer's IdP. If the group does not exist, it will be created in the account. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an @@ -221,7 +221,7 @@ func newResolveServicePrincipal() *cobra.Command { cmd.Use = "resolve-service-principal EXTERNAL_ID" cmd.Short = `Resolve an external service principal in the Databricks account.` cmd.Long = `Resolve an external service principal in the Databricks account. - + Resolves an SP with the given external ID from the customer's IdP. If the SP does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error. @@ -303,7 +303,7 @@ func newResolveUser() *cobra.Command { cmd.Use = "resolve-user EXTERNAL_ID" cmd.Short = `Resolve an external user in the Databricks account.` cmd.Long = `Resolve an external user in the Databricks account. - + Resolves a user with the given external ID from the customer's IdP. If the user does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error. diff --git a/cmd/account/ip-access-lists/ip-access-lists.go b/cmd/account/ip-access-lists/ip-access-lists.go index 80b7d72857..717a119b73 100755 --- a/cmd/account/ip-access-lists/ip-access-lists.go +++ b/cmd/account/ip-access-lists/ip-access-lists.go @@ -23,24 +23,24 @@ func New() *cobra.Command { Short: `The Accounts IP Access List API enables account admins to configure IP access lists for access to the account console.`, Long: `The Accounts IP Access List API enables account admins to configure IP access lists for access to the account console. - + Account IP Access Lists affect web application access and REST API access to the account console and account APIs. If the feature is disabled for the account, all access is allowed for this account. There is support for allow lists (inclusion) and block lists (exclusion). - + When a connection is attempted: 1. **First, all block lists are checked.** If the connection IP address matches any block list, the connection is rejected. 2. **If the connection was not rejected by block lists**, the IP address is compared with the allow lists. - + If there is at least one allow list for the account, the connection is allowed only if the IP address matches an allow list. If there are no allow lists for the account, all IP addresses are allowed. - + For all allow lists and block lists combined, the account supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. - + After changes to the account-level IP access lists, it can take a few minutes for changes to take effect.`, GroupID: "settings", @@ -88,25 +88,25 @@ func newCreate() *cobra.Command { cmd.Use = "create LABEL LIST_TYPE" cmd.Short = `Create access list.` cmd.Long = `Create access list. - + Creates an IP access list for the account. - + A list can be an allow list or a block list. See the top of this file for a description of how the server treats allow lists and block lists at runtime. - + When creating or updating an IP access list: - + * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number return error 400 with error_code value QUOTA_EXCEEDED. * If the new list would block the calling user's current IP, error 400 is returned with error_code value INVALID_STATE. - + It can take a few minutes for the changes to take effect. Arguments: LABEL: Label for the IP access list. This **cannot** be empty. - LIST_TYPE: + LIST_TYPE: Supported values: [ALLOW, BLOCK]` cmd.Annotations = make(map[string]string) @@ -187,7 +187,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete IP_ACCESS_LIST_ID" cmd.Short = `Delete access list.` cmd.Long = `Delete access list. - + Deletes an IP access list, specified by its list ID. Arguments: @@ -255,7 +255,7 @@ func newGet() *cobra.Command { cmd.Use = "get IP_ACCESS_LIST_ID" cmd.Short = `Get IP access list.` cmd.Long = `Get IP access list. - + Gets an IP access list, specified by its list ID. Arguments: @@ -320,7 +320,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get access lists.` cmd.Long = `Get access lists. - + Gets all IP access lists for the specified account.` cmd.Annotations = make(map[string]string) @@ -367,9 +367,9 @@ func newReplace() *cobra.Command { cmd.Use = "replace IP_ACCESS_LIST_ID LABEL LIST_TYPE ENABLED" cmd.Short = `Replace access list.` cmd.Long = `Replace access list. - + Replaces an IP access list, specified by its ID. - + A list can include allow lists and block lists. See the top of this file for a description of how the server treats allow lists and block lists at run time. When replacing an IP access list: * For all allow lists and block lists @@ -382,7 +382,7 @@ func newReplace() *cobra.Command { Arguments: IP_ACCESS_LIST_ID: The ID for the corresponding IP access list LABEL: Label for the IP access list. This **cannot** be empty. - LIST_TYPE: + LIST_TYPE: Supported values: [ALLOW, BLOCK] ENABLED: Specifies whether this IP access list is enabled.` @@ -480,20 +480,20 @@ func newUpdate() *cobra.Command { cmd.Use = "update IP_ACCESS_LIST_ID" cmd.Short = `Update access list.` cmd.Long = `Update access list. - + Updates an existing IP access list, specified by its ID. - + A list can include allow lists and block lists. See the top of this file for a description of how the server treats allow lists and block lists at run time. - + When updating an IP access list: - + * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number return error 400 with error_code value QUOTA_EXCEEDED. * If the updated list would block the calling user's current IP, error 400 is returned with error_code value INVALID_STATE. - + It can take a few minutes for the changes to take effect. Arguments: diff --git a/cmd/account/llm-proxy-partner-powered-account/llm-proxy-partner-powered-account.go b/cmd/account/llm-proxy-partner-powered-account/llm-proxy-partner-powered-account.go index ac10c02d56..8727f216af 100755 --- a/cmd/account/llm-proxy-partner-powered-account/llm-proxy-partner-powered-account.go +++ b/cmd/account/llm-proxy-partner-powered-account/llm-proxy-partner-powered-account.go @@ -59,7 +59,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the enable partner powered AI features account setting.` cmd.Long = `Get the enable partner powered AI features account setting. - + Gets the enable partner powered AI features account setting.` cmd.Annotations = make(map[string]string) @@ -113,7 +113,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the enable partner powered AI features account setting.` cmd.Long = `Update the enable partner powered AI features account setting. - + Updates the enable partner powered AI features account setting.` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/llm-proxy-partner-powered-enforce/llm-proxy-partner-powered-enforce.go b/cmd/account/llm-proxy-partner-powered-enforce/llm-proxy-partner-powered-enforce.go index 3571fdcc12..3349a51a70 100755 --- a/cmd/account/llm-proxy-partner-powered-enforce/llm-proxy-partner-powered-enforce.go +++ b/cmd/account/llm-proxy-partner-powered-enforce/llm-proxy-partner-powered-enforce.go @@ -60,7 +60,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the enforcement status of partner powered AI features account setting.` cmd.Long = `Get the enforcement status of partner powered AI features account setting. - + Gets the enforcement status of partner powered AI features account setting.` cmd.Annotations = make(map[string]string) @@ -114,7 +114,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the enforcement status of partner powered AI features account setting.` cmd.Long = `Update the enforcement status of partner powered AI features account setting. - + Updates the enable enforcement status of partner powered AI features account setting.` diff --git a/cmd/account/log-delivery/log-delivery.go b/cmd/account/log-delivery/log-delivery.go index 747d183666..49012f7120 100755 --- a/cmd/account/log-delivery/log-delivery.go +++ b/cmd/account/log-delivery/log-delivery.go @@ -25,26 +25,26 @@ func New() *cobra.Command { supported log types for this API are _billable usage logs_ and _audit logs_. This feature is in Public Preview. This feature works with all account ID types. - + Log delivery works with all account types. However, if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account, you can optionally configure different storage destinations for each workspace. Log delivery status is also provided to know the latest status of log delivery attempts. - + The high-level flow of billable usage delivery: - + 1. **Create storage**: In AWS, [create a new AWS S3 bucket] with a specific bucket policy. Using Databricks APIs, call the Account API to create a [storage configuration object](:method:Storage/Create) that uses the bucket name. - + 2. **Create credentials**: In AWS, create the appropriate AWS IAM role. For full details, including the required IAM role policies and trust relationship, see [Billable usage log delivery]. Using Databricks APIs, call the Account API to create a [credential configuration object](:method:Credentials/Create) that uses the IAM role's ARN. - + 3. **Create log delivery configuration**: Using Databricks APIs, call the Account API to [create a log delivery configuration](:method:LogDelivery/Create) that uses the credential and @@ -55,7 +55,7 @@ func New() *cobra.Command { workspaces plus account level logs, while workspace level log delivery solely delivers logs related to the specified workspaces. You can create multiple types of delivery configurations per account. - + For billable usage delivery: * For more information about billable usage logs, see [Billable usage log delivery]. For the CSV schema, see the [Usage page]. * The delivery location is //billable-usage/csv/, where @@ -67,7 +67,7 @@ func New() *cobra.Command { that delivers logs for all current and future workspaces in your account. * The files are delivered daily by overwriting the month's CSV file for each workspace. - + For audit log delivery: * For more information about about audit log delivery, see [Audit log delivery], which includes information about the used JSON schema. * The delivery location is @@ -80,7 +80,7 @@ func New() *cobra.Command { workspace-level audit logs for all workspaces in the account as well as account-level audit logs. See [Audit log delivery] for details. * Auditable events are typically available in logs within 15 minutes. - + [Audit log delivery]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [Billable usage log delivery]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html [Usage page]: https://docs.databricks.com/administration-guide/account-settings/usage.html @@ -126,17 +126,17 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new log delivery configuration.` cmd.Long = `Create a new log delivery configuration. - + Creates a new Databricks log delivery configuration to enable delivery of the specified type of logs to your storage location. This requires that you already created a [credential object](:method:Credentials/Create) (which encapsulates a cross-account service IAM role) and a [storage configuration object](:method:Storage/Create) (which encapsulates an S3 bucket). - + For full details, including the required IAM role policies and bucket policies, see [Deliver and access billable usage logs] or [Configure audit logging]. - + **Note**: There is a limit on the number of log delivery configurations available per account (each limit applies separately to each log type including billable usage and audit logs). You can create a maximum of two @@ -145,11 +145,11 @@ func newCreate() *cobra.Command { workspace-level delivery configurations per workspace for each log type, which means that the same workspace ID can occur in the workspace filter for no more than two delivery configurations per log type. - + You cannot delete a log delivery configuration, but you can disable it (see [Enable or disable log delivery configuration](:method:LogDelivery/PatchStatus)). - + [Configure audit logging]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [Deliver and access billable usage logs]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html` @@ -211,7 +211,7 @@ func newGet() *cobra.Command { cmd.Use = "get LOG_DELIVERY_CONFIGURATION_ID" cmd.Short = `Get log delivery configuration.` cmd.Long = `Get log delivery configuration. - + Gets a Databricks log delivery configuration object for an account, both specified by ID. @@ -285,7 +285,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get all log delivery configurations.` cmd.Long = `Get all log delivery configurations. - + Gets all Databricks log delivery configurations associated with an account specified by ID.` @@ -337,7 +337,7 @@ func newPatchStatus() *cobra.Command { cmd.Use = "patch-status LOG_DELIVERY_CONFIGURATION_ID STATUS" cmd.Short = `Enable or disable log delivery configuration.` cmd.Long = `Enable or disable log delivery configuration. - + Enables or disables a log delivery configuration. Deletion of delivery configurations is not supported, so disable log delivery configurations that are no longer needed. Note that you can't re-enable a delivery configuration @@ -350,7 +350,7 @@ func newPatchStatus() *cobra.Command { DISABLED (disabled). Defaults to ENABLED. You can [enable or disable the configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration is not supported, so disable a log delivery - configuration that is no longer needed. + configuration that is no longer needed. Supported values: [DISABLED, ENABLED]` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/metastore-assignments/metastore-assignments.go b/cmd/account/metastore-assignments/metastore-assignments.go index b2b6886c75..c7f62b27e7 100755 --- a/cmd/account/metastore-assignments/metastore-assignments.go +++ b/cmd/account/metastore-assignments/metastore-assignments.go @@ -66,7 +66,7 @@ func newCreate() *cobra.Command { cmd.Use = "create WORKSPACE_ID METASTORE_ID" cmd.Short = `Assigns a workspace to a metastore.` cmd.Long = `Assigns a workspace to a metastore. - + Creates an assignment to a metastore for a workspace Arguments: @@ -140,7 +140,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete WORKSPACE_ID METASTORE_ID" cmd.Short = `Delete a metastore assignment.` cmd.Long = `Delete a metastore assignment. - + Deletes a metastore assignment to a workspace, leaving the workspace with no metastore. @@ -203,7 +203,7 @@ func newGet() *cobra.Command { cmd.Use = "get WORKSPACE_ID" cmd.Short = `Gets the metastore assignment for a workspace.` cmd.Long = `Gets the metastore assignment for a workspace. - + Gets the metastore assignment, if any, for the workspace specified by ID. If the workspace is assigned a metastore, the mapping will be returned. If no metastore is assigned to the workspace, the assignment will not be found and a @@ -265,7 +265,7 @@ func newList() *cobra.Command { cmd.Use = "list METASTORE_ID" cmd.Short = `Get all workspaces assigned to a metastore.` cmd.Long = `Get all workspaces assigned to a metastore. - + Gets a list of all Databricks workspace IDs that have been assigned to given metastore. @@ -324,7 +324,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update WORKSPACE_ID METASTORE_ID" cmd.Short = `Updates a metastore assignment to a workspace.` cmd.Long = `Updates a metastore assignment to a workspace. - + Updates an assignment to a metastore for a workspace. Currently, only the default catalog may be updated. diff --git a/cmd/account/metastores/metastores.go b/cmd/account/metastores/metastores.go index fe3aa6a6a1..f058e923c6 100755 --- a/cmd/account/metastores/metastores.go +++ b/cmd/account/metastores/metastores.go @@ -65,7 +65,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create Metastore.` cmd.Long = `Create Metastore. - + Creates a Unity Catalog metastore.` cmd.Annotations = make(map[string]string) @@ -131,7 +131,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete METASTORE_ID" cmd.Short = `Delete a metastore.` cmd.Long = `Delete a metastore. - + Deletes a Unity Catalog metastore for an account, both specified by ID. Arguments: @@ -187,7 +187,7 @@ func newGet() *cobra.Command { cmd.Use = "get METASTORE_ID" cmd.Short = `Get a metastore.` cmd.Long = `Get a metastore. - + Gets a Unity Catalog metastore from an account, both specified by ID. Arguments: @@ -240,7 +240,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get all metastores associated with an account.` cmd.Long = `Get all metastores associated with an account. - + Gets all Unity Catalog metastores associated with an account specified by ID.` cmd.Annotations = make(map[string]string) @@ -287,7 +287,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update METASTORE_ID" cmd.Short = `Update a metastore.` cmd.Long = `Update a metastore. - + Updates an existing Unity Catalog metastore. Arguments: diff --git a/cmd/account/network-connectivity/network-connectivity.go b/cmd/account/network-connectivity/network-connectivity.go index f7e3e66972..20ae977952 100755 --- a/cmd/account/network-connectivity/network-connectivity.go +++ b/cmd/account/network-connectivity/network-connectivity.go @@ -28,7 +28,7 @@ func New() *cobra.Command { provision private endpoints for Databricks to privately connect serverless compute resources to your Azure resources using Azure Private Link. See [configure serverless secure connectivity]. - + [configure serverless secure connectivity]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security`, GroupID: "settings", Annotations: map[string]string{ @@ -77,19 +77,19 @@ func newCreateNetworkConnectivityConfiguration() *cobra.Command { cmd.Use = "create-network-connectivity-configuration NAME REGION" cmd.Short = `Create a network connectivity configuration.` cmd.Long = `Create a network connectivity configuration. - + Creates a network connectivity configuration (NCC), which provides stable Azure service subnets when accessing your Azure Storage accounts. You can also use a network connectivity configuration to create Databricks managed private endpoints so that Databricks serverless compute resources privately access your resources. - + **IMPORTANT**: After you create the network connectivity configuration, you must assign one or more workspaces to the new network connectivity configuration. You can share one network connectivity configuration with multiple workspaces from the same Azure region within the same Databricks account. See [configure serverless secure connectivity]. - + [configure serverless secure connectivity]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security Arguments: @@ -184,16 +184,16 @@ func newCreatePrivateEndpointRule() *cobra.Command { cmd.Use = "create-private-endpoint-rule NETWORK_CONNECTIVITY_CONFIG_ID" cmd.Short = `Create a private endpoint rule.` cmd.Long = `Create a private endpoint rule. - + Create a private endpoint rule for the specified network connectivity config object. Once the object is created, Databricks asynchronously provisions a new Azure private endpoint to your specified Azure resource. - + **IMPORTANT**: You must use Azure portal or other Azure tools to approve the private endpoint to complete the connection. To get the information of the private endpoint created, make a GET request on the new private endpoint rule. See [serverless private link]. - + [serverless private link]: https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security/serverless-private-link Arguments: @@ -261,7 +261,7 @@ func newDeleteNetworkConnectivityConfiguration() *cobra.Command { cmd.Use = "delete-network-connectivity-configuration NETWORK_CONNECTIVITY_CONFIG_ID" cmd.Short = `Delete a network connectivity configuration.` cmd.Long = `Delete a network connectivity configuration. - + Deletes a network connectivity configuration. Arguments: @@ -317,7 +317,7 @@ func newDeletePrivateEndpointRule() *cobra.Command { cmd.Use = "delete-private-endpoint-rule NETWORK_CONNECTIVITY_CONFIG_ID PRIVATE_ENDPOINT_RULE_ID" cmd.Short = `Delete a private endpoint rule.` cmd.Long = `Delete a private endpoint rule. - + Initiates deleting a private endpoint rule. If the connection state is PENDING or EXPIRED, the private endpoint is immediately deleted. Otherwise, the private endpoint is deactivated and will be deleted after seven days of @@ -380,7 +380,7 @@ func newGetNetworkConnectivityConfiguration() *cobra.Command { cmd.Use = "get-network-connectivity-configuration NETWORK_CONNECTIVITY_CONFIG_ID" cmd.Short = `Get a network connectivity configuration.` cmd.Long = `Get a network connectivity configuration. - + Gets a network connectivity configuration. Arguments: @@ -436,7 +436,7 @@ func newGetPrivateEndpointRule() *cobra.Command { cmd.Use = "get-private-endpoint-rule NETWORK_CONNECTIVITY_CONFIG_ID PRIVATE_ENDPOINT_RULE_ID" cmd.Short = `Gets a private endpoint rule.` cmd.Long = `Gets a private endpoint rule. - + Gets the private endpoint rule. Arguments: @@ -496,7 +496,7 @@ func newListNetworkConnectivityConfigurations() *cobra.Command { cmd.Use = "list-network-connectivity-configurations" cmd.Short = `List network connectivity configurations.` cmd.Long = `List network connectivity configurations. - + Gets an array of network connectivity configurations.` cmd.Annotations = make(map[string]string) @@ -546,7 +546,7 @@ func newListPrivateEndpointRules() *cobra.Command { cmd.Use = "list-private-endpoint-rules NETWORK_CONNECTIVITY_CONFIG_ID" cmd.Short = `List private endpoint rules.` cmd.Long = `List private endpoint rules. - + Gets an array of private endpoint rules. Arguments: @@ -607,7 +607,7 @@ func newUpdatePrivateEndpointRule() *cobra.Command { cmd.Use = "update-private-endpoint-rule NETWORK_CONNECTIVITY_CONFIG_ID PRIVATE_ENDPOINT_RULE_ID UPDATE_MASK" cmd.Short = `Update a private endpoint rule.` cmd.Long = `Update a private endpoint rule. - + Updates a private endpoint rule. Currently only a private endpoint rule to customer-managed resources is allowed to be updated. diff --git a/cmd/account/network-policies/network-policies.go b/cmd/account/network-policies/network-policies.go index dd0aa95900..5e0c067f82 100755 --- a/cmd/account/network-policies/network-policies.go +++ b/cmd/account/network-policies/network-policies.go @@ -73,7 +73,7 @@ func newCreateNetworkPolicyRpc() *cobra.Command { cmd.Use = "create-network-policy-rpc" cmd.Short = `Create a network policy.` cmd.Long = `Create a network policy. - + Creates a new network policy to manage which network destinations can be accessed from the Databricks environment.` @@ -138,7 +138,7 @@ func newDeleteNetworkPolicyRpc() *cobra.Command { cmd.Use = "delete-network-policy-rpc NETWORK_POLICY_ID" cmd.Short = `Delete a network policy.` cmd.Long = `Delete a network policy. - + Deletes a network policy. Cannot be called on 'default-policy'. Arguments: @@ -194,7 +194,7 @@ func newGetNetworkPolicyRpc() *cobra.Command { cmd.Use = "get-network-policy-rpc NETWORK_POLICY_ID" cmd.Short = `Get a network policy.` cmd.Long = `Get a network policy. - + Gets a network policy. Arguments: @@ -252,7 +252,7 @@ func newListNetworkPoliciesRpc() *cobra.Command { cmd.Use = "list-network-policies-rpc" cmd.Short = `List network policies.` cmd.Long = `List network policies. - + Gets an array of network policies.` cmd.Annotations = make(map[string]string) @@ -308,7 +308,7 @@ func newUpdateNetworkPolicyRpc() *cobra.Command { cmd.Use = "update-network-policy-rpc NETWORK_POLICY_ID" cmd.Short = `Update a network policy.` cmd.Long = `Update a network policy. - + Updates a network policy. This allows you to modify the configuration of a network policy. diff --git a/cmd/account/networks/networks.go b/cmd/account/networks/networks.go index fc4c4bf586..959521fea9 100755 --- a/cmd/account/networks/networks.go +++ b/cmd/account/networks/networks.go @@ -69,7 +69,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create network configuration.` cmd.Long = `Create network configuration. - + Creates a Databricks network configuration that represents an VPC and its resources. The VPC will be used for new Databricks clusters. This requires a pre-existing VPC and subnets.` @@ -135,11 +135,11 @@ func newDelete() *cobra.Command { cmd.Use = "delete NETWORK_ID" cmd.Short = `Delete a network configuration.` cmd.Long = `Delete a network configuration. - + Deletes a Databricks network configuration, which represents a cloud VPC and its resources. You cannot delete a network that is associated with a workspace. - + This operation is available only if your account is on the E2 version of the platform. @@ -196,7 +196,7 @@ func newGet() *cobra.Command { cmd.Use = "get NETWORK_ID" cmd.Short = `Get a network configuration.` cmd.Long = `Get a network configuration. - + Gets a Databricks network configuration, which represents a cloud VPC and its resources. @@ -250,7 +250,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List network configurations.` cmd.Long = `List network configurations. - + Lists Databricks network configurations for an account.` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/o-auth-published-apps/o-auth-published-apps.go b/cmd/account/o-auth-published-apps/o-auth-published-apps.go index b0e46d7ea1..da3bf8851c 100755 --- a/cmd/account/o-auth-published-apps/o-auth-published-apps.go +++ b/cmd/account/o-auth-published-apps/o-auth-published-apps.go @@ -60,7 +60,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get all the published OAuth apps.` cmd.Long = `Get all the published OAuth apps. - + Get all the available published OAuth apps in Databricks.` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/personal-compute/personal-compute.go b/cmd/account/personal-compute/personal-compute.go index 611b1dc042..8f085de5d6 100755 --- a/cmd/account/personal-compute/personal-compute.go +++ b/cmd/account/personal-compute/personal-compute.go @@ -25,7 +25,7 @@ func New() *cobra.Command { the Personal Compute default policy to create compute resources. By default all users in all workspaces have access (ON), but you can change the setting to instead let individual workspaces configure access control (DELEGATE). - + There is only one instance of this setting per account. Since this setting has a default value, this setting is present on all accounts even though it's never set on a given account. Deletion reverts the value of the setting back @@ -68,7 +68,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete Personal Compute setting.` cmd.Long = `Delete Personal Compute setting. - + Reverts back the Personal Compute setting value to default (ON)` cmd.Annotations = make(map[string]string) @@ -121,7 +121,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get Personal Compute setting.` cmd.Long = `Get Personal Compute setting. - + Gets the value of the Personal Compute setting.` cmd.Annotations = make(map[string]string) @@ -175,7 +175,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update Personal Compute setting.` cmd.Long = `Update Personal Compute setting. - + Updates the value of the Personal Compute setting.` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/private-access/private-access.go b/cmd/account/private-access/private-access.go index c054739604..7f323e2ba5 100755 --- a/cmd/account/private-access/private-access.go +++ b/cmd/account/private-access/private-access.go @@ -68,7 +68,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create private access settings.` cmd.Long = `Create private access settings. - + Creates a private access settings configuration, which represents network access restrictions for workspace resources. Private access settings configure whether workspaces can be accessed from the public internet or only from @@ -135,7 +135,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete PRIVATE_ACCESS_SETTINGS_ID" cmd.Short = `Delete private access settings.` cmd.Long = `Delete private access settings. - + Deletes a Databricks private access settings configuration, both specified by ID.` @@ -189,7 +189,7 @@ func newGet() *cobra.Command { cmd.Use = "get PRIVATE_ACCESS_SETTINGS_ID" cmd.Short = `Get private access settings.` cmd.Long = `Get private access settings. - + Gets a Databricks private access settings configuration, both specified by ID.` cmd.Annotations = make(map[string]string) @@ -239,7 +239,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List private access settings.` cmd.Long = `List private access settings. - + Lists Databricks private access settings for an account.` cmd.Annotations = make(map[string]string) @@ -294,7 +294,7 @@ func newReplace() *cobra.Command { cmd.Use = "replace PRIVATE_ACCESS_SETTINGS_ID" cmd.Short = `Update private access settings.` cmd.Long = `Update private access settings. - + Updates an existing private access settings object, which specifies how your workspace is accessed over AWS PrivateLink. To use AWS PrivateLink, a workspace must have a private access settings object referenced by ID in the diff --git a/cmd/account/published-app-integration/published-app-integration.go b/cmd/account/published-app-integration/published-app-integration.go index 417ceead5f..f0bcb6fb2f 100755 --- a/cmd/account/published-app-integration/published-app-integration.go +++ b/cmd/account/published-app-integration/published-app-integration.go @@ -67,9 +67,9 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create Published OAuth App Integration.` cmd.Long = `Create Published OAuth App Integration. - + Create Published OAuth App Integration. - + You can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.` @@ -134,7 +134,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete INTEGRATION_ID" cmd.Short = `Delete Published OAuth App Integration.` cmd.Long = `Delete Published OAuth App Integration. - + Delete an existing Published OAuth App Integration. You can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.` @@ -188,7 +188,7 @@ func newGet() *cobra.Command { cmd.Use = "get INTEGRATION_ID" cmd.Short = `Get OAuth Published App Integration.` cmd.Long = `Get OAuth Published App Integration. - + Gets the Published OAuth App Integration for the given integration id.` cmd.Annotations = make(map[string]string) @@ -244,7 +244,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get published oauth app integrations.` cmd.Long = `Get published oauth app integrations. - + Get the list of published OAuth app integrations for the specified Databricks account` @@ -298,7 +298,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update INTEGRATION_ID" cmd.Short = `Updates Published OAuth App Integration.` cmd.Long = `Updates Published OAuth App Integration. - + Updates an existing published OAuth App Integration. You can retrieve the published OAuth app integration via :method:PublishedAppIntegration/get.` diff --git a/cmd/account/service-principal-federation-policy/service-principal-federation-policy.go b/cmd/account/service-principal-federation-policy/service-principal-federation-policy.go index e3968e27e9..141f1b6196 100755 --- a/cmd/account/service-principal-federation-policy/service-principal-federation-policy.go +++ b/cmd/account/service-principal-federation-policy/service-principal-federation-policy.go @@ -22,27 +22,27 @@ func New() *cobra.Command { Use: "service-principal-federation-policy", Short: `These APIs manage service principal federation policies.`, Long: `These APIs manage service principal federation policies. - + Service principal federation, also known as Workload Identity Federation, allows your automated workloads running outside of Databricks to securely access Databricks APIs without the need for Databricks secrets. With Workload Identity Federation, your application (or workload) authenticates to Databricks as a Databricks service principal, using tokens provided by the workload runtime. - + Databricks strongly recommends using Workload Identity Federation to authenticate to Databricks from automated workloads, over alternatives such as OAuth client secrets or Personal Access Tokens, whenever possible. Workload Identity Federation is supported by many popular services, including Github Actions, Azure DevOps, GitLab, Terraform Cloud, and Kubernetes clusters, among others. - + Workload identity federation is configured in your Databricks account using a service principal federation policy. A service principal federation policy specifies: * which IdP, or issuer, the service principal is allowed to authenticate from * which workload identity, or subject, is allowed to authenticate as the Databricks service principal - + To configure a federation policy, you provide the following: * The required token __issuer__, as specified in the “iss” claim of workload identity tokens. The issuer is an https URL that identifies the workload identity @@ -58,21 +58,21 @@ func New() *cobra.Command { (recommended), Databricks automatically fetches the public keys from the issuer’s well known endpoint. Databricks strongly recommends relying on the issuer’s well known endpoint for discovering public keys. - + An example service principal federation policy, for a Github Actions workload, is: issuer: "https://token.actions.githubusercontent.com" audiences: ["https://github.com/my-github-org"] subject: - "repo:my-github-org/my-repo:environment:prod" - + "repo:my-github-org/my-repo:environment:prod" + An example JWT token body that matches this policy and could be used to authenticate to Databricks is: { "iss": "https://token.actions.githubusercontent.com", "aud": "https://github.com/my-github-org", "sub": - "repo:my-github-org/my-repo:environment:prod" } - + "repo:my-github-org/my-repo:environment:prod" } + You may also need to configure the workload runtime to generate tokens for your workloads. - + You do not need to configure an OAuth application in Databricks to use token federation.`, GroupID: "oauth2", @@ -122,7 +122,7 @@ func newCreate() *cobra.Command { cmd.Use = "create SERVICE_PRINCIPAL_ID" cmd.Short = `Create service principal federation policy.` cmd.Long = `Create service principal federation policy. - + Create account federation policy. Arguments: @@ -193,7 +193,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete SERVICE_PRINCIPAL_ID POLICY_ID" cmd.Short = `Delete service principal federation policy.` cmd.Long = `Delete service principal federation policy. - + Delete account federation policy. Arguments: @@ -255,7 +255,7 @@ func newGet() *cobra.Command { cmd.Use = "get SERVICE_PRINCIPAL_ID POLICY_ID" cmd.Short = `Get service principal federation policy.` cmd.Long = `Get service principal federation policy. - + Get account federation policy. Arguments: @@ -320,7 +320,7 @@ func newList() *cobra.Command { cmd.Use = "list SERVICE_PRINCIPAL_ID" cmd.Short = `List service principal federation policies.` cmd.Long = `List service principal federation policies. - + List account federation policies. Arguments: @@ -384,7 +384,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update SERVICE_PRINCIPAL_ID POLICY_ID" cmd.Short = `Update service principal federation policy.` cmd.Long = `Update service principal federation policy. - + Update account federation policy. Arguments: diff --git a/cmd/account/service-principal-secrets/service-principal-secrets.go b/cmd/account/service-principal-secrets/service-principal-secrets.go index f811c3f6dd..e558cb8c71 100755 --- a/cmd/account/service-principal-secrets/service-principal-secrets.go +++ b/cmd/account/service-principal-secrets/service-principal-secrets.go @@ -20,16 +20,16 @@ func New() *cobra.Command { Use: "service-principal-secrets", Short: `These APIs enable administrators to manage service principal secrets.`, Long: `These APIs enable administrators to manage service principal secrets. - + You can use the generated secrets to obtain OAuth access tokens for a service principal, which can then be used to access Databricks Accounts and Workspace APIs. For more information, see [Authentication using OAuth tokens for service principals]. - + In addition, the generated secrets can be used to configure the Databricks Terraform Provider to authenticate with the service principal. For more information, see [Databricks Terraform Provider]. - + [Authentication using OAuth tokens for service principals]: https://docs.databricks.com/dev-tools/authentication-oauth.html [Databricks Terraform Provider]: https://github.com/databricks/terraform-provider-databricks/blob/master/docs/index.md#authenticating-with-service-principal`, GroupID: "oauth2", @@ -74,7 +74,7 @@ func newCreate() *cobra.Command { cmd.Use = "create SERVICE_PRINCIPAL_ID" cmd.Short = `Create service principal secret.` cmd.Long = `Create service principal secret. - + Create a secret for the given service principal. Arguments: @@ -142,7 +142,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete SERVICE_PRINCIPAL_ID SECRET_ID" cmd.Short = `Delete service principal secret.` cmd.Long = `Delete service principal secret. - + Delete a secret from the given service principal. Arguments: @@ -203,7 +203,7 @@ func newList() *cobra.Command { cmd.Use = "list SERVICE_PRINCIPAL_ID" cmd.Short = `List service principal secrets.` cmd.Long = `List service principal secrets. - + List all secrets associated with the given service principal. This operation only returns information about the secrets themselves and does not include the secret values. diff --git a/cmd/account/service-principals-v2/service-principals-v2.go b/cmd/account/service-principals-v2/service-principals-v2.go index 512ecaf204..281fa79204 100755 --- a/cmd/account/service-principals-v2/service-principals-v2.go +++ b/cmd/account/service-principals-v2/service-principals-v2.go @@ -75,7 +75,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a service principal.` cmd.Long = `Create a service principal. - + Creates a new service principal in the Databricks account.` cmd.Annotations = make(map[string]string) @@ -139,7 +139,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a service principal.` cmd.Long = `Delete a service principal. - + Delete a single service principal in the Databricks account. Arguments: @@ -195,7 +195,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get service principal details.` cmd.Long = `Get service principal details. - + Gets the details for a single service principal define in the Databricks account. @@ -260,7 +260,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List service principals.` cmd.Long = `List service principals. - + Gets the set of service principals associated with a Databricks account.` cmd.Annotations = make(map[string]string) @@ -314,7 +314,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update service principal details.` cmd.Long = `Update service principal details. - + Partially updates the details of a single service principal in the Databricks account. @@ -392,9 +392,9 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace service principal.` cmd.Long = `Replace service principal. - + Updates the details of a single service principal. - + This action replaces the existing service principal with the same name. Arguments: diff --git a/cmd/account/service-principals/service-principals.go b/cmd/account/service-principals/service-principals.go index e69c976777..00b6cfd5e7 100755 --- a/cmd/account/service-principals/service-principals.go +++ b/cmd/account/service-principals/service-principals.go @@ -80,7 +80,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a service principal.` cmd.Long = `Create a service principal. - + Creates a new service principal in the Databricks account.` cmd.Annotations = make(map[string]string) @@ -144,7 +144,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a service principal.` cmd.Long = `Delete a service principal. - + Delete a single service principal in the Databricks account. Arguments: @@ -212,7 +212,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get service principal details.` cmd.Long = `Get service principal details. - + Gets the details for a single service principal define in the Databricks account. @@ -289,7 +289,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List service principals.` cmd.Long = `List service principals. - + Gets the set of service principals associated with a Databricks account.` cmd.Annotations = make(map[string]string) @@ -343,7 +343,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update service principal details.` cmd.Long = `Update service principal details. - + Partially updates the details of a single service principal in the Databricks account. @@ -437,9 +437,9 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace service principal.` cmd.Long = `Replace service principal. - + Updates the details of a single service principal. - + This action replaces the existing service principal with the same name. Arguments: diff --git a/cmd/account/settings-v2/settings-v2.go b/cmd/account/settings-v2/settings-v2.go index 7afcd5b7e5..c1638a0832 100755 --- a/cmd/account/settings-v2/settings-v2.go +++ b/cmd/account/settings-v2/settings-v2.go @@ -57,7 +57,7 @@ func newGetPublicAccountSetting() *cobra.Command { cmd.Use = "get-public-account-setting NAME" cmd.Short = `Get an account setting.` cmd.Long = `Get an account setting. - + Get a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level.` @@ -115,7 +115,7 @@ func newListAccountSettingsMetadata() *cobra.Command { cmd.Use = "list-account-settings-metadata" cmd.Short = `List valid setting keys and their metadata.` cmd.Long = `List valid setting keys and their metadata. - + List valid setting keys and metadata. These settings are available to be referenced via GET :method:settingsv2/getpublicaccountsetting and PATCH :method:settingsv2/patchpublicaccountsetting APIs` @@ -187,7 +187,7 @@ func newPatchPublicAccountSetting() *cobra.Command { cmd.Use = "patch-public-account-setting NAME" cmd.Short = `Update an account setting.` cmd.Long = `Update an account setting. - + Patch a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level.` diff --git a/cmd/account/storage-credentials/storage-credentials.go b/cmd/account/storage-credentials/storage-credentials.go index c2229d378d..cde27d380a 100755 --- a/cmd/account/storage-credentials/storage-credentials.go +++ b/cmd/account/storage-credentials/storage-credentials.go @@ -65,11 +65,11 @@ func newCreate() *cobra.Command { cmd.Use = "create METASTORE_ID" cmd.Short = `Create a storage credential.` cmd.Long = `Create a storage credential. - + Creates a new storage credential. The request object is specific to the cloud: - **AwsIamRole** for AWS credentials - **AzureServicePrincipal** for Azure credentials - **GcpServiceAccountKey** for GCP credentials - + The caller must be a metastore admin and have the CREATE_STORAGE_CREDENTIAL privilege on the metastore. @@ -140,7 +140,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete METASTORE_ID STORAGE_CREDENTIAL_NAME" cmd.Short = `Delete a storage credential.` cmd.Long = `Delete a storage credential. - + Deletes a storage credential from the metastore. The caller must be an owner of the storage credential. @@ -199,7 +199,7 @@ func newGet() *cobra.Command { cmd.Use = "get METASTORE_ID STORAGE_CREDENTIAL_NAME" cmd.Short = `Gets the named storage credential.` cmd.Long = `Gets the named storage credential. - + Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the storage credential, or have a level of privilege on the storage credential. @@ -259,7 +259,7 @@ func newList() *cobra.Command { cmd.Use = "list METASTORE_ID" cmd.Short = `Get all storage credentials assigned to a metastore.` cmd.Long = `Get all storage credentials assigned to a metastore. - + Gets a list of all storage credentials that have been assigned to given metastore. @@ -319,7 +319,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update METASTORE_ID STORAGE_CREDENTIAL_NAME" cmd.Short = `Updates a storage credential.` cmd.Long = `Updates a storage credential. - + Updates a storage credential on the metastore. The caller must be the owner of the storage credential. If the caller is a metastore admin, only the **owner** credential can be changed. diff --git a/cmd/account/storage/storage.go b/cmd/account/storage/storage.go index 96f4cf9e6b..9d66707a12 100755 --- a/cmd/account/storage/storage.go +++ b/cmd/account/storage/storage.go @@ -70,7 +70,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a storage configuration.` cmd.Long = `Create a storage configuration. - + Creates a Databricks storage configuration for an account.` cmd.Annotations = make(map[string]string) @@ -131,7 +131,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete STORAGE_CONFIGURATION_ID" cmd.Short = `Delete a storage configuration.` cmd.Long = `Delete a storage configuration. - + Deletes a Databricks storage configuration. You cannot delete a storage configuration that is associated with any workspace.` @@ -185,7 +185,7 @@ func newGet() *cobra.Command { cmd.Use = "get STORAGE_CONFIGURATION_ID" cmd.Short = `Get a storage configuration.` cmd.Long = `Get a storage configuration. - + Gets a Databricks storage configuration for an account, both specified by ID.` cmd.Annotations = make(map[string]string) @@ -235,7 +235,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List storage configurations.` cmd.Long = `List storage configurations. - + Lists Databricks storage configurations for an account, specified by ID.` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/usage-dashboards/usage-dashboards.go b/cmd/account/usage-dashboards/usage-dashboards.go index 9a737e999c..d97ae4ff2c 100755 --- a/cmd/account/usage-dashboards/usage-dashboards.go +++ b/cmd/account/usage-dashboards/usage-dashboards.go @@ -64,7 +64,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create new usage dashboard.` cmd.Long = `Create new usage dashboard. - + Create a usage dashboard specified by workspaceId, accountId, and dashboard type.` @@ -132,7 +132,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get usage dashboard.` cmd.Long = `Get usage dashboard. - + Get a usage dashboard specified by workspaceId, accountId, and dashboard type.` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/users-v2/users-v2.go b/cmd/account/users-v2/users-v2.go index 7a44950b6d..6babfcbec1 100755 --- a/cmd/account/users-v2/users-v2.go +++ b/cmd/account/users-v2/users-v2.go @@ -20,7 +20,7 @@ func New() *cobra.Command { Use: "users-v2", Short: `User identities recognized by Databricks and represented by email addresses.`, Long: `User identities recognized by Databricks and represented by email addresses. - + Databricks recommends using SCIM provisioning to sync users and groups automatically from your identity provider to your Databricks account. SCIM streamlines onboarding a new employee or team by using your identity provider @@ -82,7 +82,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new user.` cmd.Long = `Create a new user. - + Creates a new user in the Databricks account. This new user will also be added to the Databricks account.` @@ -147,7 +147,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a user.` cmd.Long = `Delete a user. - + Deletes a user. Deleting a user from a Databricks account also removes objects associated with the user. @@ -212,7 +212,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get user details.` cmd.Long = `Get user details. - + Gets information for a specific user in Databricks account. Arguments: @@ -276,7 +276,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List users.` cmd.Long = `List users. - + Gets details for all the users associated with a Databricks account.` cmd.Annotations = make(map[string]string) @@ -330,7 +330,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update user details.` cmd.Long = `Update user details. - + Partially updates a user resource by applying the supplied operations on specific user attributes. @@ -410,7 +410,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace a user.` cmd.Long = `Replace a user. - + Replaces a user's information with the data supplied in request. Arguments: diff --git a/cmd/account/users/users.go b/cmd/account/users/users.go index 1f9913b7db..966d4330fc 100755 --- a/cmd/account/users/users.go +++ b/cmd/account/users/users.go @@ -22,7 +22,7 @@ func New() *cobra.Command { Use: "users", Short: `User identities recognized by Databricks and represented by email addresses.`, Long: `User identities recognized by Databricks and represented by email addresses. - + Databricks recommends using SCIM provisioning to sync users and groups automatically from your identity provider to your Databricks account. SCIM streamlines onboarding a new employee or team by using your identity provider @@ -87,7 +87,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new user.` cmd.Long = `Create a new user. - + Creates a new user in the Databricks account. This new user will also be added to the Databricks account.` @@ -152,7 +152,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a user.` cmd.Long = `Delete a user. - + Deletes a user. Deleting a user from a Databricks account also removes objects associated with the user. @@ -229,7 +229,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get user details.` cmd.Long = `Get user details. - + Gets information for a specific user in Databricks account. Arguments: @@ -305,7 +305,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List users.` cmd.Long = `List users. - + Gets details for all the users associated with a Databricks account.` cmd.Annotations = make(map[string]string) @@ -359,7 +359,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update user details.` cmd.Long = `Update user details. - + Partially updates a user resource by applying the supplied operations on specific user attributes. @@ -455,7 +455,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace a user.` cmd.Long = `Replace a user. - + Replaces a user's information with the data supplied in request. Arguments: diff --git a/cmd/account/vpc-endpoints/vpc-endpoints.go b/cmd/account/vpc-endpoints/vpc-endpoints.go index 69a771f588..c729122b70 100755 --- a/cmd/account/vpc-endpoints/vpc-endpoints.go +++ b/cmd/account/vpc-endpoints/vpc-endpoints.go @@ -66,16 +66,16 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a VPC endpoint configuration.` cmd.Long = `Create a VPC endpoint configuration. - + Creates a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to communicate privately with Databricks over [AWS PrivateLink]. - + After you create the VPC endpoint configuration, the Databricks [endpoint service] automatically accepts the VPC endpoint. - + Before configuring PrivateLink, read the [Databricks article about PrivateLink]. - + [AWS PrivateLink]: https://aws.amazon.com/privatelink [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html [VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints.html @@ -142,7 +142,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete VPC_ENDPOINT_ID" cmd.Short = `Delete a VPC endpoint configuration.` cmd.Long = `Delete a VPC endpoint configuration. - + Deletes a Databricks VPC endpoint configuration. You cannot delete a VPC endpoint configuration that is associated with any workspace.` @@ -196,10 +196,10 @@ func newGet() *cobra.Command { cmd.Use = "get VPC_ENDPOINT_ID" cmd.Short = `Get a VPC endpoint configuration.` cmd.Long = `Get a VPC endpoint configuration. - + Gets a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to communicate privately with Databricks over [AWS PrivateLink]. - + [AWS PrivateLink]: https://aws.amazon.com/privatelink [VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html @@ -253,7 +253,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List VPC endpoint configurations.` cmd.Long = `List VPC endpoint configurations. - + Lists Databricks VPC endpoint configurations for an account.` cmd.Annotations = make(map[string]string) diff --git a/cmd/account/workspace-assignment/workspace-assignment.go b/cmd/account/workspace-assignment/workspace-assignment.go index 340e11069d..66b326c362 100755 --- a/cmd/account/workspace-assignment/workspace-assignment.go +++ b/cmd/account/workspace-assignment/workspace-assignment.go @@ -61,7 +61,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete WORKSPACE_ID PRINCIPAL_ID" cmd.Short = `Delete permissions assignment.` cmd.Long = `Delete permissions assignment. - + Deletes the workspace permissions assignment in a given account and workspace for the specified principal. @@ -127,7 +127,7 @@ func newGet() *cobra.Command { cmd.Use = "get WORKSPACE_ID" cmd.Short = `List workspace permissions.` cmd.Long = `List workspace permissions. - + Get an array of workspace permissions for the specified account and workspace. Arguments: @@ -186,7 +186,7 @@ func newList() *cobra.Command { cmd.Use = "list WORKSPACE_ID" cmd.Short = `Get permission assignments.` cmd.Long = `Get permission assignments. - + Get the permission assignments for the specified Databricks account and Databricks workspace. @@ -248,7 +248,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update WORKSPACE_ID PRINCIPAL_ID" cmd.Short = `Create or update permissions assignment.` cmd.Long = `Create or update permissions assignment. - + Creates or updates the workspace permissions assignment in a given account and workspace for the specified principal. diff --git a/cmd/account/workspace-network-configuration/workspace-network-configuration.go b/cmd/account/workspace-network-configuration/workspace-network-configuration.go index b01923695c..0d050827f9 100755 --- a/cmd/account/workspace-network-configuration/workspace-network-configuration.go +++ b/cmd/account/workspace-network-configuration/workspace-network-configuration.go @@ -64,7 +64,7 @@ func newGetWorkspaceNetworkOptionRpc() *cobra.Command { cmd.Use = "get-workspace-network-option-rpc WORKSPACE_ID" cmd.Short = `Get workspace network option.` cmd.Long = `Get workspace network option. - + Gets the network option for a workspace. Every workspace has exactly one network policy binding, with 'default-policy' used if no explicit assignment exists. @@ -132,7 +132,7 @@ func newUpdateWorkspaceNetworkOptionRpc() *cobra.Command { cmd.Use = "update-workspace-network-option-rpc WORKSPACE_ID" cmd.Short = `Update workspace network option.` cmd.Long = `Update workspace network option. - + Updates the network option for a workspace. This operation associates the workspace with the specified network policy. To revert to the default policy, specify 'default-policy' as the network_policy_id. diff --git a/cmd/account/workspaces/workspaces.go b/cmd/account/workspaces/workspaces.go index 6a360bcd48..e595a7dfee 100755 --- a/cmd/account/workspaces/workspaces.go +++ b/cmd/account/workspaces/workspaces.go @@ -26,7 +26,7 @@ func New() *cobra.Command { environment for accessing all of your Databricks assets. The workspace organizes objects (notebooks, libraries, and experiments) into folders, and provides access to data and computational resources such as clusters and jobs. - + These endpoints are available if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.`, @@ -104,7 +104,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a workspace.` cmd.Long = `Create a workspace. - + Creates a new workspace using a credential configuration and a storage configuration, an optional network configuration (if using a customer-managed VPC), an optional managed services key configuration (if using @@ -112,7 +112,7 @@ func newCreate() *cobra.Command { configuration (if using customer-managed keys for storage). The key configurations used for managed services and storage encryption can be the same or different. - + Important: This operation is asynchronous. A response with HTTP status code 200 means the request has been accepted and is in progress, but does not mean that the workspace deployed successfully and is running. The initial workspace @@ -120,7 +120,7 @@ func newCreate() *cobra.Command { the response to identify the new workspace and make repeated GET requests with the workspace ID and check its status. The workspace becomes available when the status changes to RUNNING. - + You can share one customer-managed VPC with multiple workspaces in a single account. It is not required to create a new VPC for each workspace. However, you cannot reuse subnets or Security Groups between workspaces. If you plan to @@ -128,18 +128,18 @@ func newCreate() *cobra.Command { subnets accordingly. Because a Databricks Account API network configuration encapsulates this information, you cannot reuse a Databricks Account API network configuration across workspaces. - + For information about how to create a new workspace with this API including error handling, see [Create a new workspace using the Account API]. - + Important: Customer-managed VPCs, PrivateLink, and customer-managed keys are supported on a limited set of deployment and subscription types. If you have questions about availability, contact your Databricks representative. - + This operation is available only if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account. - + [Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html` cmd.Annotations = make(map[string]string) @@ -215,7 +215,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete WORKSPACE_ID" cmd.Short = `Delete a workspace.` cmd.Long = `Delete a workspace. - + Deletes a Databricks workspace, both specified by ID.` cmd.Annotations = make(map[string]string) @@ -271,7 +271,7 @@ func newGet() *cobra.Command { cmd.Use = "get WORKSPACE_ID" cmd.Short = `Get a workspace.` cmd.Long = `Get a workspace. - + Gets information including status for a Databricks workspace, specified by ID. In the response, the workspace_status field indicates the current status. After initial workspace creation (which is asynchronous), make repeated GET @@ -279,7 +279,7 @@ func newGet() *cobra.Command { available when the status changes to RUNNING. For information about how to create a new workspace with this API **including error handling**, see [Create a new workspace using the Account API]. - + [Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html` cmd.Annotations = make(map[string]string) @@ -332,7 +332,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List workspaces.` cmd.Long = `List workspaces. - + Lists Databricks workspaces for an account.` cmd.Annotations = make(map[string]string) @@ -415,7 +415,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update WORKSPACE_ID" cmd.Short = `Update a workspace.` cmd.Long = `Update a workspace. - + Updates a workspace. Arguments: diff --git a/cmd/workspace/aibi-dashboard-embedding-access-policy/aibi-dashboard-embedding-access-policy.go b/cmd/workspace/aibi-dashboard-embedding-access-policy/aibi-dashboard-embedding-access-policy.go index 54a54f5de9..4fca144ece 100755 --- a/cmd/workspace/aibi-dashboard-embedding-access-policy/aibi-dashboard-embedding-access-policy.go +++ b/cmd/workspace/aibi-dashboard-embedding-access-policy/aibi-dashboard-embedding-access-policy.go @@ -59,7 +59,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete the AI/BI dashboard embedding access policy.` cmd.Long = `Delete the AI/BI dashboard embedding access policy. - + Delete the AI/BI dashboard embedding access policy, reverting back to the default.` @@ -113,7 +113,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Retrieve the AI/BI dashboard embedding access policy.` cmd.Long = `Retrieve the AI/BI dashboard embedding access policy. - + Retrieves the AI/BI dashboard embedding access policy. The default setting is ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be embedded on approved domains.` @@ -169,7 +169,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the AI/BI dashboard embedding access policy.` cmd.Long = `Update the AI/BI dashboard embedding access policy. - + Updates the AI/BI dashboard embedding access policy at the workspace level.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/aibi-dashboard-embedding-approved-domains/aibi-dashboard-embedding-approved-domains.go b/cmd/workspace/aibi-dashboard-embedding-approved-domains/aibi-dashboard-embedding-approved-domains.go index 75dfcd900a..2f693a91ac 100755 --- a/cmd/workspace/aibi-dashboard-embedding-approved-domains/aibi-dashboard-embedding-approved-domains.go +++ b/cmd/workspace/aibi-dashboard-embedding-approved-domains/aibi-dashboard-embedding-approved-domains.go @@ -59,7 +59,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete AI/BI dashboard embedding approved domains.` cmd.Long = `Delete AI/BI dashboard embedding approved domains. - + Delete the list of domains approved to host embedded AI/BI dashboards, reverting back to the default empty list.` @@ -113,7 +113,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Retrieve the list of domains approved to host embedded AI/BI dashboards.` cmd.Long = `Retrieve the list of domains approved to host embedded AI/BI dashboards. - + Retrieves the list of domains approved to host embedded AI/BI dashboards.` cmd.Annotations = make(map[string]string) @@ -167,7 +167,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the list of domains approved to host embedded AI/BI dashboards.` cmd.Long = `Update the list of domains approved to host embedded AI/BI dashboards. - + Updates the list of domains approved to host embedded AI/BI dashboards. This update will fail if the current workspace access policy is not ALLOW_APPROVED_DOMAINS.` diff --git a/cmd/workspace/alerts-legacy/alerts-legacy.go b/cmd/workspace/alerts-legacy/alerts-legacy.go index c5cded70f1..fb00ddab5c 100755 --- a/cmd/workspace/alerts-legacy/alerts-legacy.go +++ b/cmd/workspace/alerts-legacy/alerts-legacy.go @@ -26,10 +26,10 @@ func New() *cobra.Command { its result, and notifies one or more users and/or notification destinations if the condition was met. Alerts can be scheduled using the sql_task type of the Jobs API, e.g. :method:jobs/create. - + **Note**: A new version of the Databricks SQL API is now available. Please see the latest version. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html`, GroupID: "sql", Annotations: map[string]string{ @@ -76,14 +76,14 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create an alert.` cmd.Long = `Create an alert. - + Creates an alert. An alert is a Databricks SQL object that periodically runs a query, evaluates a condition of its result, and notifies users or notification destinations if the condition was met. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:alerts/create instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) @@ -144,14 +144,14 @@ func newDelete() *cobra.Command { cmd.Use = "delete ALERT_ID" cmd.Short = `Delete an alert.` cmd.Long = `Delete an alert. - + Deletes an alert. Deleted alerts are no longer accessible and cannot be restored. **Note**: Unlike queries and dashboards, alerts cannot be moved to the trash. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:alerts/delete instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) @@ -204,12 +204,12 @@ func newGet() *cobra.Command { cmd.Use = "get ALERT_ID" cmd.Short = `Get an alert.` cmd.Long = `Get an alert. - + Gets an alert. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:alerts/get instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) @@ -259,12 +259,12 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get alerts.` cmd.Long = `Get alerts. - + Gets a list of alerts. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:alerts/list instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) @@ -314,12 +314,12 @@ func newUpdate() *cobra.Command { cmd.Use = "update ALERT_ID" cmd.Short = `Update an alert.` cmd.Long = `Update an alert. - + Updates an alert. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:alerts/update instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/alerts-v2/alerts-v2.go b/cmd/workspace/alerts-v2/alerts-v2.go index 5101177c24..2cc73d72d2 100755 --- a/cmd/workspace/alerts-v2/alerts-v2.go +++ b/cmd/workspace/alerts-v2/alerts-v2.go @@ -72,14 +72,14 @@ func newCreateAlert() *cobra.Command { cmd.Use = "create-alert DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE" cmd.Short = `Create an alert.` cmd.Long = `Create an alert. - + Create Alert Arguments: DISPLAY_NAME: The display name of the alert. QUERY_TEXT: Text of the query to be run. WAREHOUSE_ID: ID of the SQL warehouse attached to the alert. - EVALUATION: + EVALUATION: SCHEDULE: ` cmd.Annotations = make(map[string]string) @@ -173,7 +173,7 @@ func newGetAlert() *cobra.Command { cmd.Use = "get-alert ID" cmd.Short = `Get an alert.` cmd.Long = `Get an alert. - + Gets an alert.` cmd.Annotations = make(map[string]string) @@ -241,7 +241,7 @@ func newListAlerts() *cobra.Command { cmd.Use = "list-alerts" cmd.Short = `List alerts.` cmd.Long = `List alerts. - + Gets a list of alerts accessible to the user, ordered by creation time.` cmd.Annotations = make(map[string]string) @@ -289,7 +289,7 @@ func newTrashAlert() *cobra.Command { cmd.Use = "trash-alert ID" cmd.Short = `Delete an alert (legacy TrashAlert).` cmd.Long = `Delete an alert (legacy TrashAlert). - + Moves an alert to the trash. Trashed alerts immediately disappear from list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days.` @@ -367,7 +367,7 @@ func newUpdateAlert() *cobra.Command { cmd.Use = "update-alert ID UPDATE_MASK DISPLAY_NAME QUERY_TEXT WAREHOUSE_ID EVALUATION SCHEDULE" cmd.Short = `Update an alert.` cmd.Long = `Update an alert. - + Update alert Arguments: @@ -378,7 +378,7 @@ func newUpdateAlert() *cobra.Command { Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the @@ -386,7 +386,7 @@ func newUpdateAlert() *cobra.Command { DISPLAY_NAME: The display name of the alert. QUERY_TEXT: Text of the query to be run. WAREHOUSE_ID: ID of the SQL warehouse attached to the alert. - EVALUATION: + EVALUATION: SCHEDULE: ` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/alerts/alerts.go b/cmd/workspace/alerts/alerts.go index 4d34182e38..964d868498 100755 --- a/cmd/workspace/alerts/alerts.go +++ b/cmd/workspace/alerts/alerts.go @@ -71,7 +71,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create an alert.` cmd.Long = `Create an alert. - + Creates an alert.` cmd.Annotations = make(map[string]string) @@ -135,7 +135,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete an alert.` cmd.Long = `Delete an alert. - + Moves an alert to the trash. Trashed alerts immediately disappear from searches and list views, and can no longer trigger. You can restore a trashed alert through the UI. A trashed alert is permanently deleted after 30 days.` @@ -202,7 +202,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get an alert.` cmd.Long = `Get an alert. - + Gets an alert.` cmd.Annotations = make(map[string]string) @@ -270,7 +270,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List alerts.` cmd.Long = `List alerts. - + Gets a list of alerts accessible to the user, ordered by creation time. **Warning:** Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.` @@ -326,18 +326,18 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID UPDATE_MASK" cmd.Short = `Update an alert.` cmd.Long = `Update an alert. - + Updates an alert. Arguments: - ID: + ID: UPDATE_MASK: The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the diff --git a/cmd/workspace/apps-settings/apps-settings.go b/cmd/workspace/apps-settings/apps-settings.go index 23a6438e20..88312a110a 100755 --- a/cmd/workspace/apps-settings/apps-settings.go +++ b/cmd/workspace/apps-settings/apps-settings.go @@ -71,7 +71,7 @@ func newCreateCustomTemplate() *cobra.Command { cmd.Use = "create-custom-template NAME GIT_REPO PATH MANIFEST GIT_PROVIDER" cmd.Short = `Create a template.` cmd.Long = `Create a template. - + Creates a custom template. Arguments: @@ -171,7 +171,7 @@ func newDeleteCustomTemplate() *cobra.Command { cmd.Use = "delete-custom-template NAME" cmd.Short = `Delete a template.` cmd.Long = `Delete a template. - + Deletes the custom template with the specified name. Arguments: @@ -227,7 +227,7 @@ func newGetCustomTemplate() *cobra.Command { cmd.Use = "get-custom-template NAME" cmd.Short = `Get a template.` cmd.Long = `Get a template. - + Gets the custom template with the specified name. Arguments: @@ -286,7 +286,7 @@ func newListCustomTemplates() *cobra.Command { cmd.Use = "list-custom-templates" cmd.Short = `List templates.` cmd.Long = `List templates. - + Lists all custom templates in the workspace.` cmd.Annotations = make(map[string]string) @@ -340,7 +340,7 @@ func newUpdateCustomTemplate() *cobra.Command { cmd.Use = "update-custom-template NAME GIT_REPO PATH MANIFEST GIT_PROVIDER" cmd.Short = `Update a template.` cmd.Long = `Update a template. - + Updates the custom template with the specified name. Note that the template name cannot be updated. diff --git a/cmd/workspace/apps/apps.go b/cmd/workspace/apps/apps.go index 34824ddba0..e9c426af87 100755 --- a/cmd/workspace/apps/apps.go +++ b/cmd/workspace/apps/apps.go @@ -97,7 +97,7 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME" cmd.Short = `Create an app.` cmd.Long = `Create an app. - + Creates a new app. Arguments: @@ -205,20 +205,20 @@ func newCreateUpdate() *cobra.Command { cmd.Use = "create-update APP_NAME UPDATE_MASK" cmd.Short = `Create an app update.` cmd.Long = `Create an app update. - + Creates an app update and starts the update process. The update process is asynchronous and the status of the update can be checked with the GetAppUpdate method. Arguments: - APP_NAME: + APP_NAME: UPDATE_MASK: The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the @@ -315,7 +315,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete an app.` cmd.Long = `Delete an app. - + Deletes an app. Arguments: @@ -387,7 +387,7 @@ func newDeploy() *cobra.Command { cmd.Use = "deploy APP_NAME" cmd.Short = `Create an app deployment.` cmd.Long = `Create an app deployment. - + Creates an app deployment for the app with the supplied name. Arguments: @@ -474,7 +474,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get an app.` cmd.Long = `Get an app. - + Retrieves information for the app with the supplied name. Arguments: @@ -530,7 +530,7 @@ func newGetDeployment() *cobra.Command { cmd.Use = "get-deployment APP_NAME DEPLOYMENT_ID" cmd.Short = `Get an app deployment.` cmd.Long = `Get an app deployment. - + Retrieves information for the app deployment with the supplied name and deployment id. @@ -589,7 +589,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels APP_NAME" cmd.Short = `Get app permission levels.` cmd.Long = `Get app permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -645,7 +645,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions APP_NAME" cmd.Short = `Get app permissions.` cmd.Long = `Get app permissions. - + Gets the permissions of an app. Apps can inherit permissions from their root object. @@ -702,7 +702,7 @@ func newGetUpdate() *cobra.Command { cmd.Use = "get-update APP_NAME" cmd.Short = `Get an app update.` cmd.Long = `Get an app update. - + Gets the status of an app update. Arguments: @@ -761,7 +761,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List apps.` cmd.Long = `List apps. - + Lists all apps in the workspace.` cmd.Annotations = make(map[string]string) @@ -812,7 +812,7 @@ func newListDeployments() *cobra.Command { cmd.Use = "list-deployments APP_NAME" cmd.Short = `List app deployments.` cmd.Long = `List app deployments. - + Lists all app deployments for the app with the supplied name. Arguments: @@ -870,7 +870,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions APP_NAME" cmd.Short = `Set app permissions.` cmd.Long = `Set app permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -946,7 +946,7 @@ func newStart() *cobra.Command { cmd.Use = "start NAME" cmd.Short = `Start an app.` cmd.Long = `Start an app. - + Start the last active deployment of the app in the workspace. Arguments: @@ -1027,7 +1027,7 @@ func newStop() *cobra.Command { cmd.Use = "stop NAME" cmd.Short = `Stop an app.` cmd.Long = `Stop an app. - + Stops the active deployment of the app in the workspace. Arguments: @@ -1117,7 +1117,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update an app.` cmd.Long = `Update an app. - + Updates the app with the supplied name. Arguments: @@ -1191,7 +1191,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions APP_NAME" cmd.Short = `Update app permissions.` cmd.Long = `Update app permissions. - + Updates the permissions on an app. Apps can inherit permissions from their root object. diff --git a/cmd/workspace/artifact-allowlists/artifact-allowlists.go b/cmd/workspace/artifact-allowlists/artifact-allowlists.go index 99f52f2334..611d527156 100755 --- a/cmd/workspace/artifact-allowlists/artifact-allowlists.go +++ b/cmd/workspace/artifact-allowlists/artifact-allowlists.go @@ -60,12 +60,12 @@ func newGet() *cobra.Command { cmd.Use = "get ARTIFACT_TYPE" cmd.Short = `Get an artifact allowlist.` cmd.Long = `Get an artifact allowlist. - + Get the artifact allowlist of a certain artifact type. The caller must be a metastore admin or have the **MANAGE ALLOWLIST** privilege on the metastore. Arguments: - ARTIFACT_TYPE: The artifact type of the allowlist. + ARTIFACT_TYPE: The artifact type of the allowlist. Supported values: [INIT_SCRIPT, LIBRARY_JAR, LIBRARY_MAVEN]` cmd.Annotations = make(map[string]string) @@ -124,13 +124,13 @@ func newUpdate() *cobra.Command { cmd.Use = "update ARTIFACT_TYPE" cmd.Short = `Set an artifact allowlist.` cmd.Long = `Set an artifact allowlist. - + Set the artifact allowlist of a certain artifact type. The whole artifact allowlist is replaced with the new allowlist. The caller must be a metastore admin or have the **MANAGE ALLOWLIST** privilege on the metastore. Arguments: - ARTIFACT_TYPE: The artifact type of the allowlist. + ARTIFACT_TYPE: The artifact type of the allowlist. Supported values: [INIT_SCRIPT, LIBRARY_JAR, LIBRARY_MAVEN]` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/automatic-cluster-update/automatic-cluster-update.go b/cmd/workspace/automatic-cluster-update/automatic-cluster-update.go index ad89283db6..a713fcd977 100755 --- a/cmd/workspace/automatic-cluster-update/automatic-cluster-update.go +++ b/cmd/workspace/automatic-cluster-update/automatic-cluster-update.go @@ -57,7 +57,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the automatic cluster update setting.` cmd.Long = `Get the automatic cluster update setting. - + Gets the automatic cluster update setting.` cmd.Annotations = make(map[string]string) @@ -111,7 +111,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the automatic cluster update setting.` cmd.Long = `Update the automatic cluster update setting. - + Updates the automatic cluster update setting for the workspace. A fresh etag needs to be provided in PATCH requests (as part of the setting field). The etag can be retrieved by making a GET request before the PATCH request. If diff --git a/cmd/workspace/catalogs/catalogs.go b/cmd/workspace/catalogs/catalogs.go index 1beb5b2de8..45302d7961 100755 --- a/cmd/workspace/catalogs/catalogs.go +++ b/cmd/workspace/catalogs/catalogs.go @@ -24,7 +24,7 @@ func New() *cobra.Command { Long: `A catalog is the first layer of Unity Catalog’s three-level namespace. It’s used to organize your data assets. Users can see all catalogs on which they have been assigned the USE_CATALOG data permission. - + In Unity Catalog, admins and data stewards manage users and their access to data centrally across all of the workspaces in a Databricks account. Users in different workspaces can share access to the same data, depending on @@ -79,7 +79,7 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME" cmd.Short = `Create a catalog.` cmd.Long = `Create a catalog. - + Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the **CREATE_CATALOG** privilege. @@ -159,7 +159,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete a catalog.` cmd.Long = `Delete a catalog. - + Deletes the catalog that matches the supplied name. The caller must be a metastore admin or the owner of the catalog. @@ -218,7 +218,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get a catalog.` cmd.Long = `Get a catalog. - + Gets the specified catalog in a metastore. The caller must be a metastore admin, the owner of the catalog, or a user that has the **USE_CATALOG** privilege set for their account. @@ -281,16 +281,16 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List catalogs.` cmd.Long = `List catalogs. - + Gets an array of catalogs in the metastore. If the caller is the metastore admin, all catalogs will be retrieved. Otherwise, only catalogs owned by the caller (or for which the caller has the **USE_CATALOG** privilege) will be retrieved. There is no guarantee of a specific ordering of the elements in the array. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -352,7 +352,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update a catalog.` cmd.Long = `Update a catalog. - + Updates the catalog that matches the supplied name. The caller must be either the owner of the catalog, or a metastore admin (when changing the owner field of the catalog). diff --git a/cmd/workspace/clean-room-asset-revisions/clean-room-asset-revisions.go b/cmd/workspace/clean-room-asset-revisions/clean-room-asset-revisions.go index 69094be382..494f8a6877 100755 --- a/cmd/workspace/clean-room-asset-revisions/clean-room-asset-revisions.go +++ b/cmd/workspace/clean-room-asset-revisions/clean-room-asset-revisions.go @@ -58,12 +58,12 @@ func newGet() *cobra.Command { cmd.Use = "get CLEAN_ROOM_NAME ASSET_TYPE NAME ETAG" cmd.Short = `Get an asset revision.` cmd.Long = `Get an asset revision. - + Get a specific revision of an asset Arguments: CLEAN_ROOM_NAME: Name of the clean room. - ASSET_TYPE: Asset type. Only NOTEBOOK_FILE is supported. + ASSET_TYPE: Asset type. Only NOTEBOOK_FILE is supported. Supported values: [FOREIGN_TABLE, NOTEBOOK_FILE, TABLE, VIEW, VOLUME] NAME: Name of the asset. ETAG: Revision etag to fetch. If not provided, the latest revision will be @@ -129,12 +129,12 @@ func newList() *cobra.Command { cmd.Use = "list CLEAN_ROOM_NAME ASSET_TYPE NAME" cmd.Short = `List asset revisions.` cmd.Long = `List asset revisions. - + List revisions for an asset Arguments: CLEAN_ROOM_NAME: Name of the clean room. - ASSET_TYPE: Asset type. Only NOTEBOOK_FILE is supported. + ASSET_TYPE: Asset type. Only NOTEBOOK_FILE is supported. Supported values: [FOREIGN_TABLE, NOTEBOOK_FILE, TABLE, VIEW, VOLUME] NAME: Name of the asset.` diff --git a/cmd/workspace/clean-room-assets/clean-room-assets.go b/cmd/workspace/clean-room-assets/clean-room-assets.go index 43a6af91ab..3892a731d5 100755 --- a/cmd/workspace/clean-room-assets/clean-room-assets.go +++ b/cmd/workspace/clean-room-assets/clean-room-assets.go @@ -77,7 +77,7 @@ func newCreate() *cobra.Command { cmd.Use = "create CLEAN_ROOM_NAME NAME ASSET_TYPE" cmd.Short = `Create an asset.` cmd.Long = `Create an asset. - + Create a clean room asset —share an asset like a notebook or table into the clean room. For each UC asset that is added through this method, the clean room owner must also have enough privilege on the asset to consume it. The @@ -89,13 +89,13 @@ func newCreate() *cobra.Command { for create operations and populated by the server for responses. NAME: A fully qualified name that uniquely identifies the asset within the clean room. This is also the name displayed in the clean room UI. - + For UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name* - + For notebooks, the name is the notebook file name. For jar analyses, the name is the jar analysis name. - ASSET_TYPE: The type of the asset. + ASSET_TYPE: The type of the asset. Supported values: [FOREIGN_TABLE, NOTEBOOK_FILE, TABLE, VIEW, VOLUME]` cmd.Annotations = make(map[string]string) @@ -182,12 +182,12 @@ func newCreateCleanRoomAssetReview() *cobra.Command { cmd.Use = "create-clean-room-asset-review CLEAN_ROOM_NAME ASSET_TYPE NAME" cmd.Short = `Create a review (e.g. approval) for an asset.` cmd.Long = `Create a review (e.g. approval) for an asset. - + Submit an asset review Arguments: CLEAN_ROOM_NAME: Name of the clean room - ASSET_TYPE: Asset type. Can either be NOTEBOOK_FILE or JAR_ANALYSIS. + ASSET_TYPE: Asset type. Can either be NOTEBOOK_FILE or JAR_ANALYSIS. Supported values: [FOREIGN_TABLE, NOTEBOOK_FILE, TABLE, VIEW, VOLUME] NAME: Name of the asset` @@ -259,12 +259,12 @@ func newDelete() *cobra.Command { cmd.Use = "delete CLEAN_ROOM_NAME ASSET_TYPE NAME" cmd.Short = `Delete an asset.` cmd.Long = `Delete an asset. - + Delete a clean room asset - unshare/remove the asset from the clean room Arguments: CLEAN_ROOM_NAME: Name of the clean room. - ASSET_TYPE: The type of the asset. + ASSET_TYPE: The type of the asset. Supported values: [FOREIGN_TABLE, NOTEBOOK_FILE, TABLE, VIEW, VOLUME] NAME: The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.` @@ -325,12 +325,12 @@ func newGet() *cobra.Command { cmd.Use = "get CLEAN_ROOM_NAME ASSET_TYPE NAME" cmd.Short = `Get an asset.` cmd.Long = `Get an asset. - + Get the details of a clean room asset by its type and full name. Arguments: CLEAN_ROOM_NAME: Name of the clean room. - ASSET_TYPE: The type of the asset. + ASSET_TYPE: The type of the asset. Supported values: [FOREIGN_TABLE, NOTEBOOK_FILE, TABLE, VIEW, VOLUME] NAME: The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.` @@ -458,20 +458,20 @@ func newUpdate() *cobra.Command { cmd.Use = "update CLEAN_ROOM_NAME ASSET_TYPE NAME" cmd.Short = `Update an asset.` cmd.Long = `Update an asset. - + Update a clean room asset. For example, updating the content of a notebook; changing the shared partitions of a table; etc. Arguments: CLEAN_ROOM_NAME: Name of the clean room. - ASSET_TYPE: The type of the asset. + ASSET_TYPE: The type of the asset. Supported values: [FOREIGN_TABLE, NOTEBOOK_FILE, TABLE, VIEW, VOLUME] NAME: A fully qualified name that uniquely identifies the asset within the clean room. This is also the name displayed in the clean room UI. - + For UC securable assets (tables, volumes, etc.), the format is *shared_catalog*.*shared_schema*.*asset_name* - + For notebooks, the name is the notebook file name. For jar analyses, the name is the jar analysis name.` diff --git a/cmd/workspace/clean-room-auto-approval-rules/clean-room-auto-approval-rules.go b/cmd/workspace/clean-room-auto-approval-rules/clean-room-auto-approval-rules.go index a88b3b0bde..948c811d21 100755 --- a/cmd/workspace/clean-room-auto-approval-rules/clean-room-auto-approval-rules.go +++ b/cmd/workspace/clean-room-auto-approval-rules/clean-room-auto-approval-rules.go @@ -66,7 +66,7 @@ func newCreate() *cobra.Command { cmd.Use = "create CLEAN_ROOM_NAME" cmd.Short = `Create an auto-approval rule.` cmd.Long = `Create an auto-approval rule. - + Create an auto-approval rule Arguments: @@ -136,7 +136,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete CLEAN_ROOM_NAME RULE_ID" cmd.Short = `Delete an auto-approval rule.` cmd.Long = `Delete an auto-approval rule. - + Delete a auto-approval rule by rule ID` cmd.Annotations = make(map[string]string) @@ -190,7 +190,7 @@ func newGet() *cobra.Command { cmd.Use = "get CLEAN_ROOM_NAME RULE_ID" cmd.Short = `Get an auto-approval rule.` cmd.Long = `Get an auto-approval rule. - + Get a auto-approval rule by rule ID` cmd.Annotations = make(map[string]string) @@ -247,7 +247,7 @@ func newList() *cobra.Command { cmd.Use = "list CLEAN_ROOM_NAME" cmd.Short = `List auto-approval rules.` cmd.Long = `List auto-approval rules. - + List all auto-approval rules for the caller` cmd.Annotations = make(map[string]string) @@ -306,7 +306,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update CLEAN_ROOM_NAME RULE_ID" cmd.Short = `Update an auto-approval rule.` cmd.Long = `Update an auto-approval rule. - + Update a auto-approval rule by rule ID Arguments: diff --git a/cmd/workspace/clean-room-task-runs/clean-room-task-runs.go b/cmd/workspace/clean-room-task-runs/clean-room-task-runs.go index f4817fb7f8..282448f70d 100755 --- a/cmd/workspace/clean-room-task-runs/clean-room-task-runs.go +++ b/cmd/workspace/clean-room-task-runs/clean-room-task-runs.go @@ -58,7 +58,7 @@ func newList() *cobra.Command { cmd.Use = "list CLEAN_ROOM_NAME" cmd.Short = `List notebook task runs.` cmd.Long = `List notebook task runs. - + List all the historical notebook task runs in a clean room. Arguments: diff --git a/cmd/workspace/clean-rooms/clean-rooms.go b/cmd/workspace/clean-rooms/clean-rooms.go index 4b94810aa7..7f4b8ac814 100755 --- a/cmd/workspace/clean-rooms/clean-rooms.go +++ b/cmd/workspace/clean-rooms/clean-rooms.go @@ -81,14 +81,14 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a clean room.` cmd.Long = `Create a clean room. - + Create a new clean room with the specified collaborators. This method is asynchronous; the returned name field inside the clean_room field can be used to poll the clean room status, using the :method:cleanrooms/get method. When this method returns, the clean room will be in a PROVISIONING state, with only name, owner, comment, created_at and status populated. The clean room will be usable once it enters an ACTIVE state. - + The caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the metastore.` @@ -172,7 +172,7 @@ func newCreateOutputCatalog() *cobra.Command { cmd.Use = "create-output-catalog CLEAN_ROOM_NAME" cmd.Short = `Create an output catalog.` cmd.Long = `Create an output catalog. - + Create the output catalog of the clean room. Arguments: @@ -240,7 +240,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete a clean room.` cmd.Long = `Delete a clean room. - + Delete a clean room. After deletion, the clean room will be removed from the metastore. If the other collaborators have not deleted the clean room, they will still have the clean room in their metastore, but it will be in a DELETED @@ -299,7 +299,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get a clean room.` cmd.Long = `Get a clean room. - + Get the details of a clean room given its name.` cmd.Annotations = make(map[string]string) @@ -355,7 +355,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List clean rooms.` cmd.Long = `List clean rooms. - + Get a list of all clean rooms of the metastore. Only clean rooms the caller has access to are returned.` @@ -409,10 +409,10 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update a clean room.` cmd.Long = `Update a clean room. - + Update a clean room. The caller must be the owner of the clean room, have **MODIFY_CLEAN_ROOM** privilege, or be metastore admin. - + When the caller is a metastore admin, only the __owner__ field can be updated. Arguments: diff --git a/cmd/workspace/cluster-policies/cluster-policies.go b/cmd/workspace/cluster-policies/cluster-policies.go index 5423ec37c4..d05d77fbbd 100755 --- a/cmd/workspace/cluster-policies/cluster-policies.go +++ b/cmd/workspace/cluster-policies/cluster-policies.go @@ -25,14 +25,14 @@ func New() *cobra.Command { based on a set of rules. These rules specify which attributes or attribute values can be used during cluster creation. Cluster policies have ACLs that limit their use to specific users and groups. - + With cluster policies, you can: - Auto-install cluster libraries on the next restart by listing them in the policy's "libraries" field (Public Preview). - Limit users to creating clusters with the prescribed settings. - Simplify the user interface, enabling more users to create clusters, by fixing and hiding some fields. - Manage costs by setting limits on attributes that impact the hourly rate. - + Cluster policy permissions limit which policies a user can select in the Policy drop-down when the user creates a cluster: - A user who has unrestricted cluster create permission can select the Unrestricted policy and @@ -40,7 +40,7 @@ func New() *cobra.Command { create permission and access to cluster policies can select the Unrestricted policy and policies they have access to. - A user that has access to only cluster policies, can select the policies they have access to. - + If no policies exist in the workspace, the Policy drop-down doesn't appear. Only admin users can create, edit, and delete policies. Admin users also have access to all policies.`, @@ -98,7 +98,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new policy.` cmd.Long = `Create a new policy. - + Creates a new policy with prescribed settings.` cmd.Annotations = make(map[string]string) @@ -165,7 +165,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete POLICY_ID" cmd.Short = `Delete a cluster policy.` cmd.Long = `Delete a cluster policy. - + Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited. @@ -269,7 +269,7 @@ func newEdit() *cobra.Command { cmd.Use = "edit POLICY_ID" cmd.Short = `Update a cluster policy.` cmd.Long = `Update a cluster policy. - + Update an existing policy for cluster. This operation may make some clusters governed by the previous policy invalid. @@ -363,7 +363,7 @@ func newGet() *cobra.Command { cmd.Use = "get POLICY_ID" cmd.Short = `Get a cluster policy.` cmd.Long = `Get a cluster policy. - + Get a cluster policy entity. Creation and editing is available to admins only. Arguments: @@ -431,7 +431,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels CLUSTER_POLICY_ID" cmd.Short = `Get cluster policy permission levels.` cmd.Long = `Get cluster policy permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -499,7 +499,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions CLUSTER_POLICY_ID" cmd.Short = `Get cluster policy permissions.` cmd.Long = `Get cluster policy permissions. - + Gets the permissions of a cluster policy. Cluster policies can inherit permissions from their root object. @@ -571,7 +571,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List cluster policies.` cmd.Long = `List cluster policies. - + Returns a list of policies accessible by the requesting user.` cmd.Annotations = make(map[string]string) @@ -624,7 +624,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions CLUSTER_POLICY_ID" cmd.Short = `Set cluster policy permissions.` cmd.Long = `Set cluster policy permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -711,7 +711,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions CLUSTER_POLICY_ID" cmd.Short = `Update cluster policy permissions.` cmd.Long = `Update cluster policy permissions. - + Updates the permissions on a cluster policy. Cluster policies can inherit permissions from their root object. diff --git a/cmd/workspace/clusters/clusters.go b/cmd/workspace/clusters/clusters.go index 9d99e81062..40f2721b7d 100755 --- a/cmd/workspace/clusters/clusters.go +++ b/cmd/workspace/clusters/clusters.go @@ -24,26 +24,26 @@ func New() *cobra.Command { Short: `The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.`, Long: `The Clusters API allows you to create, start, edit, list, terminate, and delete clusters. - + Databricks maps cluster node instance types to compute units known as DBUs. See the instance type pricing page for a list of the supported instance types and their corresponding DBUs. - + A Databricks cluster is a set of computation resources and configurations on which you run data engineering, data science, and data analytics workloads, such as production ETL pipelines, streaming analytics, ad-hoc analytics, and machine learning. - + You run these workloads as a set of commands in a notebook or as an automated job. Databricks makes a distinction between all-purpose clusters and job clusters. You use all-purpose clusters to analyze data collaboratively using interactive notebooks. You use job clusters to run fast and robust automated jobs. - + You can create an all-purpose cluster using the UI, CLI, or REST API. You can manually terminate and restart an all-purpose cluster. Multiple users can share such clusters to do collaborative interactive analysis. - + IMPORTANT: Databricks retains cluster configuration information for terminated clusters for 30 days. To keep an all-purpose cluster configuration even after it has been terminated for more than 30 days, an administrator can pin a @@ -106,13 +106,13 @@ func newChangeOwner() *cobra.Command { cmd.Use = "change-owner CLUSTER_ID OWNER_USERNAME" cmd.Short = `Change cluster owner.` cmd.Long = `Change cluster owner. - + Change the owner of the cluster. You must be an admin and the cluster must be terminated to perform this operation. The service principal application ID can be supplied as an argument to owner_username. Arguments: - CLUSTER_ID: + CLUSTER_ID: OWNER_USERNAME: New owner of the cluster_id after this RPC.` cmd.Annotations = make(map[string]string) @@ -242,7 +242,7 @@ func newCreate() *cobra.Command { cmd.Use = "create SPARK_VERSION" cmd.Short = `Create new cluster.` cmd.Long = `Create new cluster. - + Creates a new Spark cluster. This method will acquire new instances from the cloud provider if necessary. This method is asynchronous; the returned cluster_id can be used to poll the cluster status. When this method @@ -250,15 +250,15 @@ func newCreate() *cobra.Command { usable once it enters a RUNNING state. Note: Databricks may not be able to acquire some of the requested nodes, due to cloud provider limitations (account limits, spot price, etc.) or transient network issues. - + If Databricks acquires at least 85% of the requested on-demand nodes, cluster creation will succeed. Otherwise the cluster will terminate with an informative error message. - + Rather than authoring the cluster's JSON definition from scratch, Databricks recommends filling out the [create compute UI] and then copying the generated JSON definition from the UI. - + [create compute UI]: https://docs.databricks.com/compute/configure.html Arguments: @@ -358,7 +358,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete CLUSTER_ID" cmd.Short = `Terminate cluster.` cmd.Long = `Terminate cluster. - + Terminates the Spark cluster with the specified ID. The cluster is removed asynchronously. Once the termination has completed, the cluster will be in a TERMINATED state. If the cluster is already in a TERMINATING or @@ -517,18 +517,18 @@ func newEdit() *cobra.Command { cmd.Use = "edit CLUSTER_ID SPARK_VERSION" cmd.Short = `Update cluster configuration.` cmd.Long = `Update cluster configuration. - + Updates the configuration of a cluster to match the provided attributes and size. A cluster can be updated if it is in a RUNNING or TERMINATED state. - + If a cluster is updated while in a RUNNING state, it will be restarted so that the new attributes can take effect. - + If a cluster is updated while in a TERMINATED state, it will remain TERMINATED. The next time it is started using the clusters/start API, the new attributes will take effect. Any attempt to update a cluster in any other state will be rejected with an INVALID_STATE error code. - + Clusters created by the Databricks Jobs service cannot be edited. Arguments: @@ -635,7 +635,7 @@ func newEvents() *cobra.Command { cmd.Use = "events CLUSTER_ID" cmd.Short = `List cluster activity events.` cmd.Long = `List cluster activity events. - + Retrieves a list of events about the activity of a cluster. This API is paginated. If there are more events to read, the response includes all the parameters necessary to request the next page of events. @@ -727,7 +727,7 @@ func newGet() *cobra.Command { cmd.Use = "get CLUSTER_ID" cmd.Short = `Get cluster info.` cmd.Long = `Get cluster info. - + Retrieves the information for a cluster given its identifier. Clusters can be described while they are running, or up to 60 days after they are terminated. @@ -796,7 +796,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels CLUSTER_ID" cmd.Short = `Get cluster permission levels.` cmd.Long = `Get cluster permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -864,7 +864,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions CLUSTER_ID" cmd.Short = `Get cluster permissions.` cmd.Long = `Get cluster permissions. - + Gets the permissions of a cluster. Clusters can inherit permissions from their root object. @@ -938,7 +938,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List clusters.` cmd.Long = `List clusters. - + Return information about all pinned and active clusters, and all clusters terminated within the last 30 days. Clusters terminated prior to this period are not included.` @@ -985,7 +985,7 @@ func newListNodeTypes() *cobra.Command { cmd.Use = "list-node-types" cmd.Short = `List node types.` cmd.Long = `List node types. - + Returns a list of supported Spark node types. These node types can be used to launch a cluster.` @@ -1028,7 +1028,7 @@ func newListZones() *cobra.Command { cmd.Use = "list-zones" cmd.Short = `List availability zones.` cmd.Long = `List availability zones. - + Returns a list of availability zones where clusters can be created in (For example, us-west-2a). These zones can be used to launch a cluster.` @@ -1077,10 +1077,10 @@ func newPermanentDelete() *cobra.Command { cmd.Use = "permanent-delete CLUSTER_ID" cmd.Short = `Permanently delete cluster.` cmd.Long = `Permanently delete cluster. - + Permanently deletes a Spark cluster. This cluster is terminated and resources are asynchronously removed. - + In addition, users will no longer see permanently deleted clusters in the cluster list, and API users can no longer perform any action on permanently deleted clusters. @@ -1177,7 +1177,7 @@ func newPin() *cobra.Command { cmd.Use = "pin CLUSTER_ID" cmd.Short = `Pin cluster.` cmd.Long = `Pin cluster. - + Pinning a cluster ensures that the cluster will always be returned by the ListClusters API. Pinning a cluster that is already pinned will have no effect. This API can only be called by workspace admins.` @@ -1280,7 +1280,7 @@ func newResize() *cobra.Command { cmd.Use = "resize CLUSTER_ID" cmd.Short = `Resize cluster.` cmd.Long = `Resize cluster. - + Resizes a cluster to have a desired number of workers. This will fail unless the cluster is in a RUNNING state. @@ -1397,7 +1397,7 @@ func newRestart() *cobra.Command { cmd.Use = "restart CLUSTER_ID" cmd.Short = `Restart cluster.` cmd.Long = `Restart cluster. - + Restarts a Spark cluster with the supplied ID. If the cluster is not currently in a RUNNING state, nothing will happen. @@ -1508,7 +1508,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions CLUSTER_ID" cmd.Short = `Set cluster permissions.` cmd.Long = `Set cluster permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -1587,7 +1587,7 @@ func newSparkVersions() *cobra.Command { cmd.Use = "spark-versions" cmd.Short = `List available Spark versions.` cmd.Long = `List available Spark versions. - + Returns the list of available Spark versions. These versions can be used to launch a cluster.` @@ -1642,7 +1642,7 @@ func newStart() *cobra.Command { cmd.Use = "start CLUSTER_ID" cmd.Short = `Start terminated cluster.` cmd.Long = `Start terminated cluster. - + Starts a terminated Spark cluster with the supplied ID. This works similar to createCluster except: - The previous cluster id and attributes are preserved. - The cluster starts with the last specified cluster size. - If the @@ -1755,7 +1755,7 @@ func newUnpin() *cobra.Command { cmd.Use = "unpin CLUSTER_ID" cmd.Short = `Unpin cluster.` cmd.Long = `Unpin cluster. - + Unpinning a cluster will allow the cluster to eventually be removed from the ListClusters API. Unpinning a cluster that is not pinned will have no effect. This API can only be called by workspace admins.` @@ -1857,7 +1857,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update CLUSTER_ID UPDATE_MASK" cmd.Short = `Update cluster configuration (partial).` cmd.Long = `Update cluster configuration (partial). - + Updates the configuration of a cluster to match the partial set of attributes and size. Denote which fields to update using the update_mask field in the request body. A cluster can be updated if it is in a RUNNING or TERMINATED @@ -1873,14 +1873,14 @@ func newUpdate() *cobra.Command { CLUSTER_ID: ID of the cluster. UPDATE_MASK: Used to specify which cluster attributes and size fields to update. See https://google.aip.dev/161 for more details. - + The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the @@ -1977,7 +1977,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions CLUSTER_ID" cmd.Short = `Update cluster permissions.` cmd.Long = `Update cluster permissions. - + Updates the permissions on a cluster. Clusters can inherit permissions from their root object. diff --git a/cmd/workspace/compliance-security-profile/compliance-security-profile.go b/cmd/workspace/compliance-security-profile/compliance-security-profile.go index 5841dd4e71..acafe737d2 100755 --- a/cmd/workspace/compliance-security-profile/compliance-security-profile.go +++ b/cmd/workspace/compliance-security-profile/compliance-security-profile.go @@ -24,7 +24,7 @@ func New() *cobra.Command { Long: `Controls whether to enable the compliance security profile for the current workspace. Enabling it on a workspace is permanent. By default, it is turned off. - + This settings can NOT be disabled once it is enabled.`, RunE: root.ReportUnknownSubcommand, } @@ -60,7 +60,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the compliance security profile setting.` cmd.Long = `Get the compliance security profile setting. - + Gets the compliance security profile setting.` cmd.Annotations = make(map[string]string) @@ -114,7 +114,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the compliance security profile setting.` cmd.Long = `Update the compliance security profile setting. - + Updates the compliance security profile setting for the workspace. A fresh etag needs to be provided in PATCH requests (as part of the setting field). The etag can be retrieved by making a GET request before the PATCH diff --git a/cmd/workspace/connections/connections.go b/cmd/workspace/connections/connections.go index 7698c5d9e9..3255b26d87 100755 --- a/cmd/workspace/connections/connections.go +++ b/cmd/workspace/connections/connections.go @@ -22,7 +22,7 @@ func New() *cobra.Command { Use: "connections", Short: `Connections allow for creating a connection to an external data source.`, Long: `Connections allow for creating a connection to an external data source. - + A connection is an abstraction of an external data source that can be connected from Databricks Compute. Creating a connection object is the first step to managing external data sources within Unity Catalog, with the second @@ -78,9 +78,9 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a connection.` cmd.Long = `Create a connection. - + Creates a new connection - + Creates a new connection to an external data source. It allows users to specify connection details and configurations for interaction with the external server.` @@ -143,7 +143,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete a connection.` cmd.Long = `Delete a connection. - + Deletes the connection that matches the supplied name. Arguments: @@ -211,7 +211,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get a connection.` cmd.Long = `Get a connection. - + Gets a connection from it's name. Arguments: @@ -282,12 +282,12 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List connections.` cmd.Long = `List connections. - + List all connections. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -344,7 +344,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update a connection.` cmd.Long = `Update a connection. - + Updates the connection that matches the supplied name. Arguments: diff --git a/cmd/workspace/consumer-fulfillments/consumer-fulfillments.go b/cmd/workspace/consumer-fulfillments/consumer-fulfillments.go index 62f6e0be6f..6516196a60 100755 --- a/cmd/workspace/consumer-fulfillments/consumer-fulfillments.go +++ b/cmd/workspace/consumer-fulfillments/consumer-fulfillments.go @@ -58,7 +58,7 @@ func newGet() *cobra.Command { cmd.Use = "get LISTING_ID" cmd.Short = `Get listing content metadata.` cmd.Long = `Get listing content metadata. - + Get a high level preview of the metadata of listing installable content.` cmd.Annotations = make(map[string]string) @@ -111,7 +111,7 @@ func newList() *cobra.Command { cmd.Use = "list LISTING_ID" cmd.Short = `List all listing fulfillments.` cmd.Long = `List all listing fulfillments. - + Get all listings fulfillments associated with a listing. A _fulfillment_ is a potential installation. Standard installations contain metadata about the attached share or git repo. Only one of these fields will be present. diff --git a/cmd/workspace/consumer-installations/consumer-installations.go b/cmd/workspace/consumer-installations/consumer-installations.go index a686ad2ce9..00ceb595bf 100755 --- a/cmd/workspace/consumer-installations/consumer-installations.go +++ b/cmd/workspace/consumer-installations/consumer-installations.go @@ -71,7 +71,7 @@ func newCreate() *cobra.Command { cmd.Use = "create LISTING_ID" cmd.Short = `Install from a listing.` cmd.Long = `Install from a listing. - + Install payload associated with a Databricks Marketplace listing.` cmd.Annotations = make(map[string]string) @@ -136,7 +136,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete LISTING_ID INSTALLATION_ID" cmd.Short = `Uninstall from a listing.` cmd.Long = `Uninstall from a listing. - + Uninstall an installation associated with a Databricks Marketplace listing.` cmd.Annotations = make(map[string]string) @@ -193,7 +193,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List all installations.` cmd.Long = `List all installations. - + List all installations across all listings.` cmd.Annotations = make(map[string]string) @@ -244,7 +244,7 @@ func newListListingInstallations() *cobra.Command { cmd.Use = "list-listing-installations LISTING_ID" cmd.Short = `List installations for a listing.` cmd.Long = `List installations for a listing. - + List all installations for a particular listing.` cmd.Annotations = make(map[string]string) @@ -299,7 +299,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update LISTING_ID INSTALLATION_ID" cmd.Short = `Update an installation.` cmd.Long = `Update an installation. - + This is a update API that will update the part of the fields defined in the installation table as well as interact with external services according to the fields not included in the installation table 1. the token will be rotate if diff --git a/cmd/workspace/consumer-listings/consumer-listings.go b/cmd/workspace/consumer-listings/consumer-listings.go index a73fac1267..0c9036e960 100755 --- a/cmd/workspace/consumer-listings/consumer-listings.go +++ b/cmd/workspace/consumer-listings/consumer-listings.go @@ -62,7 +62,7 @@ func newBatchGet() *cobra.Command { cmd.Use = "batch-get" cmd.Short = `Get one batch of listings. One may specify up to 50 IDs per request.` cmd.Long = `Get one batch of listings. One may specify up to 50 IDs per request. - + Batch get a published listing in the Databricks Marketplace that the consumer has access to.` @@ -114,7 +114,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get listing.` cmd.Long = `Get listing. - + Get a published listing in the Databricks Marketplace that the consumer has access to.` @@ -190,7 +190,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List listings.` cmd.Long = `List listings. - + List all published listings in the Databricks Marketplace that the consumer has access to.` @@ -247,7 +247,7 @@ func newSearch() *cobra.Command { cmd.Use = "search QUERY" cmd.Short = `Search listings.` cmd.Long = `Search listings. - + Search published listings in the Databricks Marketplace that the consumer has access to. This query supports a variety of different search parameters and performs fuzzy matching. diff --git a/cmd/workspace/consumer-personalization-requests/consumer-personalization-requests.go b/cmd/workspace/consumer-personalization-requests/consumer-personalization-requests.go index cfafe2072e..02fb5081ca 100755 --- a/cmd/workspace/consumer-personalization-requests/consumer-personalization-requests.go +++ b/cmd/workspace/consumer-personalization-requests/consumer-personalization-requests.go @@ -70,7 +70,7 @@ func newCreate() *cobra.Command { cmd.Use = "create LISTING_ID" cmd.Short = `Create a personalization request.` cmd.Long = `Create a personalization request. - + Create a personalization request for a listing.` cmd.Annotations = make(map[string]string) @@ -137,7 +137,7 @@ func newGet() *cobra.Command { cmd.Use = "get LISTING_ID" cmd.Short = `Get the personalization request for a listing.` cmd.Long = `Get the personalization request for a listing. - + Get the personalization request for a listing. Each consumer can make at *most* one personalization request for a listing.` @@ -194,7 +194,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List all personalization requests.` cmd.Long = `List all personalization requests. - + List personalization requests for a consumer across all listings.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/consumer-providers/consumer-providers.go b/cmd/workspace/consumer-providers/consumer-providers.go index 2965644ba6..286df552fc 100755 --- a/cmd/workspace/consumer-providers/consumer-providers.go +++ b/cmd/workspace/consumer-providers/consumer-providers.go @@ -60,7 +60,7 @@ func newBatchGet() *cobra.Command { cmd.Use = "batch-get" cmd.Short = `Get one batch of providers. One may specify up to 50 IDs per request.` cmd.Long = `Get one batch of providers. One may specify up to 50 IDs per request. - + Batch get a provider in the Databricks Marketplace with at least one visible listing.` @@ -112,7 +112,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get a provider.` cmd.Long = `Get a provider. - + Get a provider in the Databricks Marketplace with at least one visible listing.` @@ -182,7 +182,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List providers.` cmd.Long = `List providers. - + List all providers in the Databricks Marketplace with at least one visible listing.` diff --git a/cmd/workspace/credentials-manager/credentials-manager.go b/cmd/workspace/credentials-manager/credentials-manager.go index 3a1bc9dab9..8580302e35 100755 --- a/cmd/workspace/credentials-manager/credentials-manager.go +++ b/cmd/workspace/credentials-manager/credentials-manager.go @@ -64,7 +64,7 @@ func newExchangeToken() *cobra.Command { cmd.Use = "exchange-token" cmd.Short = `Exchange token.` cmd.Long = `Exchange token. - + Exchange tokens with an Identity Provider to get a new access token. It allows specifying scopes to determine token permissions.` diff --git a/cmd/workspace/credentials/credentials.go b/cmd/workspace/credentials/credentials.go index 578e4fdf22..adc23b9937 100755 --- a/cmd/workspace/credentials/credentials.go +++ b/cmd/workspace/credentials/credentials.go @@ -25,7 +25,7 @@ func New() *cobra.Command { accessing services on your cloud tenant. Each credential is subject to Unity Catalog access-control policies that control which users and groups can access the credential. - + To create credentials, you must be a Databricks account admin or have the CREATE SERVICE CREDENTIAL privilege. The user who creates the credential can delegate ownership to another user or group to manage permissions on it.`, @@ -82,10 +82,10 @@ func newCreateCredential() *cobra.Command { cmd.Use = "create-credential NAME" cmd.Short = `Create a credential.` cmd.Long = `Create a credential. - + Creates a new credential. The type of credential to be created is determined by the **purpose** field, which should be either **SERVICE** or **STORAGE**. - + The caller must be a metastore admin or have the metastore privilege **CREATE_STORAGE_CREDENTIAL** for storage credentials, or **CREATE_SERVICE_CREDENTIAL** for service credentials. @@ -167,7 +167,7 @@ func newDeleteCredential() *cobra.Command { cmd.Use = "delete-credential NAME_ARG" cmd.Short = `Delete a credential.` cmd.Long = `Delete a credential. - + Deletes a service or storage credential from the metastore. The caller must be an owner of the credential. @@ -230,7 +230,7 @@ func newGenerateTemporaryServiceCredential() *cobra.Command { cmd.Use = "generate-temporary-service-credential CREDENTIAL_NAME" cmd.Short = `Generate a temporary service credential.` cmd.Long = `Generate a temporary service credential. - + Returns a set of temporary credentials generated using the specified service credential. The caller must be a metastore admin or have the metastore privilege **ACCESS** on the service credential. @@ -309,7 +309,7 @@ func newGetCredential() *cobra.Command { cmd.Use = "get-credential NAME_ARG" cmd.Short = `Get a credential.` cmd.Long = `Get a credential. - + Gets a service or storage credential from the metastore. The caller must be a metastore admin, the owner of the credential, or have any permission on the credential. @@ -372,14 +372,14 @@ func newListCredentials() *cobra.Command { cmd.Use = "list-credentials" cmd.Short = `List credentials.` cmd.Long = `List credentials. - + Gets an array of credentials (as __CredentialInfo__ objects). - + The array is limited to only the credentials that the caller has permission to access. If the caller is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a specific ordering of the elements in the array. - + PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the @@ -445,9 +445,9 @@ func newUpdateCredential() *cobra.Command { cmd.Use = "update-credential NAME_ARG" cmd.Short = `Update a credential.` cmd.Long = `Update a credential. - + Updates a service or storage credential on the metastore. - + The caller must be the owner of the credential or a metastore admin or have the MANAGE permission. If the caller is a metastore admin, only the __owner__ field can be changed. @@ -529,19 +529,19 @@ func newValidateCredential() *cobra.Command { cmd.Use = "validate-credential" cmd.Short = `Validate a credential.` cmd.Long = `Validate a credential. - + Validates a credential. - + For service credentials (purpose is **SERVICE**), either the __credential_name__ or the cloud-specific credential must be provided. - + For storage credentials (purpose is **STORAGE**), at least one of __external_location_name__ and __url__ need to be provided. If only one of them is provided, it will be used for validation. And if both are provided, the __url__ will be used for validation, and __external_location_name__ will be ignored when checking overlapping urls. Either the __credential_name__ or the cloud-specific credential must be provided. - + The caller must be a metastore admin or the credential owner or have the required permission on the metastore and the credential (e.g., **CREATE_EXTERNAL_LOCATION** when purpose is **STORAGE**).` diff --git a/cmd/workspace/current-user/current-user.go b/cmd/workspace/current-user/current-user.go index 40215d5e68..6e14ac8e7a 100755 --- a/cmd/workspace/current-user/current-user.go +++ b/cmd/workspace/current-user/current-user.go @@ -51,7 +51,7 @@ func newMe() *cobra.Command { cmd.Use = "me" cmd.Short = `Get current user info.` cmd.Long = `Get current user info. - + Get details about the current method caller's identity.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/dashboard-email-subscriptions/dashboard-email-subscriptions.go b/cmd/workspace/dashboard-email-subscriptions/dashboard-email-subscriptions.go index 0c4069c772..08e8f57368 100755 --- a/cmd/workspace/dashboard-email-subscriptions/dashboard-email-subscriptions.go +++ b/cmd/workspace/dashboard-email-subscriptions/dashboard-email-subscriptions.go @@ -59,7 +59,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete the Dashboard Email Subscriptions setting.` cmd.Long = `Delete the Dashboard Email Subscriptions setting. - + Reverts the Dashboard Email Subscriptions setting to its default value.` cmd.Annotations = make(map[string]string) @@ -112,7 +112,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the Dashboard Email Subscriptions setting.` cmd.Long = `Get the Dashboard Email Subscriptions setting. - + Gets the Dashboard Email Subscriptions setting.` cmd.Annotations = make(map[string]string) @@ -166,7 +166,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the Dashboard Email Subscriptions setting.` cmd.Long = `Update the Dashboard Email Subscriptions setting. - + Updates the Dashboard Email Subscriptions setting.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/dashboard-widgets/dashboard-widgets.go b/cmd/workspace/dashboard-widgets/dashboard-widgets.go index 57273a3b2a..195888919f 100755 --- a/cmd/workspace/dashboard-widgets/dashboard-widgets.go +++ b/cmd/workspace/dashboard-widgets/dashboard-widgets.go @@ -70,7 +70,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Add widget to a dashboard.` cmd.Long = `Add widget to a dashboard. - + Adds a widget to a dashboard` cmd.Annotations = make(map[string]string) @@ -131,7 +131,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Remove widget.` cmd.Long = `Remove widget. - + Removes a widget from a dashboard Arguments: @@ -193,7 +193,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Update existing widget.` cmd.Long = `Update existing widget. - + Updates an existing widget Arguments: diff --git a/cmd/workspace/dashboards/dashboards.go b/cmd/workspace/dashboards/dashboards.go index 4a5d6dd224..064cbb2784 100755 --- a/cmd/workspace/dashboards/dashboards.go +++ b/cmd/workspace/dashboards/dashboards.go @@ -64,7 +64,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete DASHBOARD_ID" cmd.Short = `Remove a dashboard.` cmd.Long = `Remove a dashboard. - + Moves a dashboard to the trash. Trashed dashboards do not appear in list views or searches, and cannot be shared.` @@ -118,7 +118,7 @@ func newGet() *cobra.Command { cmd.Use = "get DASHBOARD_ID" cmd.Short = `Retrieve a definition.` cmd.Long = `Retrieve a definition. - + Returns a JSON representation of a dashboard object, including its visualization and query objects.` @@ -177,9 +177,9 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get dashboard objects.` cmd.Long = `Get dashboard objects. - + Fetch a paginated list of dashboard objects. - + **Warning**: Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.` @@ -228,7 +228,7 @@ func newRestore() *cobra.Command { cmd.Use = "restore DASHBOARD_ID" cmd.Short = `Restore a dashboard.` cmd.Long = `Restore a dashboard. - + A restored dashboard appears in list views and searches and can be shared.` cmd.Annotations = make(map[string]string) @@ -288,10 +288,10 @@ func newUpdate() *cobra.Command { cmd.Use = "update DASHBOARD_ID" cmd.Short = `Change a dashboard definition.` cmd.Long = `Change a dashboard definition. - + Modify this dashboard definition. This operation only affects attributes of the dashboard object. It does not add, modify, or remove widgets. - + **Note**: You cannot undo this operation.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/data-quality/data-quality.go b/cmd/workspace/data-quality/data-quality.go index 304bd231c8..7e545c049a 100755 --- a/cmd/workspace/data-quality/data-quality.go +++ b/cmd/workspace/data-quality/data-quality.go @@ -68,11 +68,11 @@ func newCancelRefresh() *cobra.Command { cmd.Use = "cancel-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID" cmd.Short = `Cancel a refresh.` cmd.Long = `Cancel a refresh. - + Cancels a data quality monitor refresh. Currently only supported for the table object_type. The call must be made in the same workspace as where the monitor was created. - + The caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and @@ -85,15 +85,15 @@ func newCancelRefresh() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id @@ -161,11 +161,11 @@ func newCreateMonitor() *cobra.Command { cmd.Use = "create-monitor OBJECT_TYPE OBJECT_ID" cmd.Short = `Create a monitor.` cmd.Long = `Create a monitor. - + Create a data quality monitor on a Unity Catalog object. The caller must provide either anomaly_detection_config for a schema monitor or data_profiling_config for a table monitor. - + For the table object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the @@ -173,10 +173,10 @@ func newCreateMonitor() *cobra.Command { **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** and **SELECT** on the table. - + Workspace assets, such as the dashboard, will be created in the workspace where this call was made. - + For the schema object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and @@ -187,15 +187,15 @@ func newCreateMonitor() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id` @@ -278,10 +278,10 @@ func newCreateRefresh() *cobra.Command { cmd.Use = "create-refresh OBJECT_TYPE OBJECT_ID" cmd.Short = `Create a refresh.` cmd.Long = `Create a refresh. - + Creates a refresh. Currently only supported for the table object_type. The call must be made in the same workspace as where the monitor was created. - + The caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and @@ -294,15 +294,15 @@ func newCreateRefresh() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id` @@ -370,19 +370,19 @@ func newDeleteMonitor() *cobra.Command { cmd.Use = "delete-monitor OBJECT_TYPE OBJECT_ID" cmd.Short = `Delete a monitor.` cmd.Long = `Delete a monitor. - + Delete a data quality monitor on Unity Catalog object. - + For the table object_type, the caller must have either of the following sets of permissions: **MANAGE** and **USE_CATALOG** on the table's parent catalog. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table. - + Note that the metric tables and dashboard will not be deleted as part of this call; those assets must be manually cleaned up (if desired). - + For the schema object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and @@ -393,15 +393,15 @@ func newDeleteMonitor() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id` @@ -457,7 +457,7 @@ func newDeleteRefresh() *cobra.Command { cmd.Use = "delete-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID" cmd.Short = `Delete a refresh.` cmd.Long = `Delete a refresh. - + (Unimplemented) Delete a refresh Arguments: @@ -465,15 +465,15 @@ func newDeleteRefresh() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id @@ -534,21 +534,21 @@ func newGetMonitor() *cobra.Command { cmd.Use = "get-monitor OBJECT_TYPE OBJECT_ID" cmd.Short = `Read a monitor.` cmd.Long = `Read a monitor. - + Read a data quality monitor on a Unity Catalog object. - + For the table object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table. - + For the schema object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the schema. - + The returned information includes configuration values on the entity and parent entity as well as information on assets created by the monitor. Some information (e.g. dashboard) may be filtered out if the caller is in a @@ -559,15 +559,15 @@ func newGetMonitor() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id` @@ -623,17 +623,17 @@ func newGetRefresh() *cobra.Command { cmd.Use = "get-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID" cmd.Short = `Get a refresh.` cmd.Long = `Get a refresh. - + Get data quality monitor refresh. The call must be made in the same workspace as where the monitor was created. - + For the table object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table. - + For the schema object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** @@ -644,15 +644,15 @@ func newGetRefresh() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id @@ -716,7 +716,7 @@ func newListMonitor() *cobra.Command { cmd.Use = "list-monitor" cmd.Short = `List monitors.` cmd.Long = `List monitors. - + (Unimplemented) List data quality monitors.` cmd.Annotations = make(map[string]string) @@ -767,17 +767,17 @@ func newListRefresh() *cobra.Command { cmd.Use = "list-refresh OBJECT_TYPE OBJECT_ID" cmd.Short = `List refreshes.` cmd.Long = `List refreshes. - + List data quality monitor refreshes. The call must be made in the same workspace as where the monitor was created. - + For the table object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table. - + For the schema object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** @@ -788,15 +788,15 @@ func newListRefresh() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id` @@ -856,16 +856,16 @@ func newUpdateMonitor() *cobra.Command { cmd.Use = "update-monitor OBJECT_TYPE OBJECT_ID UPDATE_MASK OBJECT_TYPE OBJECT_ID" cmd.Short = `Update a monitor.` cmd.Long = `Update a monitor. - + Update a data quality monitor on Unity Catalog object. - + For the table object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** on the table. - + For the schema object_type, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE** and @@ -876,15 +876,15 @@ func newUpdateMonitor() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id @@ -895,15 +895,15 @@ func newUpdateMonitor() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id` @@ -989,7 +989,7 @@ func newUpdateRefresh() *cobra.Command { cmd.Use = "update-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID UPDATE_MASK OBJECT_TYPE OBJECT_ID" cmd.Short = `Update a refresh.` cmd.Long = `Update a refresh. - + (Unimplemented) Update a refresh Arguments: @@ -997,15 +997,15 @@ func newUpdateRefresh() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id @@ -1015,15 +1015,15 @@ func newUpdateRefresh() *cobra.Command { table. OBJECT_ID: The UUID of the request object. It is schema_id for schema, and table_id for table. - + Find the schema_id from either: 1. The [schema_id] of the Schemas resource. 2. In [Catalog Explorer] > select the schema > go to the Details tab > the Schema ID field. - + Find the table_id from either: 1. The [table_id] of the Tables resource. 2. In [Catalog Explorer] > select the table > go to the Details tab > the Table ID field. - + [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/ [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id` diff --git a/cmd/workspace/data-sources/data-sources.go b/cmd/workspace/data-sources/data-sources.go index 1c474f20e7..2478d1631d 100755 --- a/cmd/workspace/data-sources/data-sources.go +++ b/cmd/workspace/data-sources/data-sources.go @@ -22,15 +22,15 @@ func New() *cobra.Command { warehouse against which it will run. If you don't already know the data_source_id for your desired SQL warehouse, this API will help you find it. - + This API does not support searches. It returns the full list of SQL warehouses in your workspace. We advise you to use any text editor, REST client, or grep to search the response from this API for the name of your SQL warehouse as it appears in Databricks SQL. - + **Note**: A new version of the Databricks SQL API is now available. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html`, GroupID: "sql", Annotations: map[string]string{ @@ -64,14 +64,14 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get a list of SQL warehouses.` cmd.Long = `Get a list of SQL warehouses. - + Retrieves a full list of SQL warehouses available in this workspace. All fields that appear in this API response are enumerated for clarity. However, you need only a SQL warehouse's id to create new queries against it. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:warehouses/list instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/database/database.go b/cmd/workspace/database/database.go index 89246ea2d7..8767f2259c 100755 --- a/cmd/workspace/database/database.go +++ b/cmd/workspace/database/database.go @@ -293,7 +293,7 @@ func newCreateDatabaseInstanceRole() *cobra.Command { cmd.Long = `Create a role for a Database Instance. Arguments: - INSTANCE_NAME: + INSTANCE_NAME: NAME: The name of the role. This is the unique identifier for the role in an instance.` @@ -379,7 +379,7 @@ func newCreateDatabaseTable() *cobra.Command { cmd.Use = "create-database-table NAME" cmd.Short = `Create a Database Table.` cmd.Long = `Create a Database Table. - + Create a Database Table. Useful for registering pre-existing PG tables in UC. See CreateSyncedDatabaseTable for creating synced tables in PG from a source table in UC. @@ -653,7 +653,7 @@ func newDeleteDatabaseInstanceRole() *cobra.Command { cmd.Use = "delete-database-instance-role INSTANCE_NAME NAME" cmd.Short = `Delete a role for a Database Instance.` cmd.Long = `Delete a role for a Database Instance. - + Deletes a role for a Database Instance.` // This command is being previewed; hide from help output. @@ -1037,7 +1037,7 @@ func newGetDatabaseInstanceRole() *cobra.Command { cmd.Use = "get-database-instance-role INSTANCE_NAME NAME" cmd.Short = `Get a role for a Database Instance.` cmd.Long = `Get a role for a Database Instance. - + Gets a role for a Database Instance.` // This command is being previewed; hide from help output. @@ -1199,7 +1199,7 @@ func newListDatabaseCatalogs() *cobra.Command { cmd.Use = "list-database-catalogs INSTANCE_NAME" cmd.Short = `List all Database Catalogs in a Database Instance.` cmd.Long = `List all Database Catalogs in a Database Instance. - + This API is currently unimplemented, but exposed for Terraform support. Arguments: @@ -1258,7 +1258,7 @@ func newListDatabaseInstanceRoles() *cobra.Command { cmd.Use = "list-database-instance-roles INSTANCE_NAME" cmd.Short = `List roles for a Database Instance.` cmd.Long = `List roles for a Database Instance. - + START OF PG ROLE APIs Section These APIs are marked a PUBLIC with stage < PUBLIC_PREVIEW. With more recent Lakebase V2 plans, we don't plan to ever advance these to PUBLIC_PREVIEW. These APIs will remain effectively @@ -1367,7 +1367,7 @@ func newListSyncedDatabaseTables() *cobra.Command { cmd.Use = "list-synced-database-tables INSTANCE_NAME" cmd.Short = `List all synced database tables in a Database Instance.` cmd.Long = `List all synced database tables in a Database Instance. - + This API is currently unimplemented, but exposed for Terraform support. Arguments: @@ -1429,7 +1429,7 @@ func newUpdateDatabaseCatalog() *cobra.Command { cmd.Use = "update-database-catalog NAME UPDATE_MASK DATABASE_INSTANCE_NAME DATABASE_NAME" cmd.Short = `Update a Database Catalog.` cmd.Long = `Update a Database Catalog. - + This API is currently unimplemented, but exposed for Terraform support. Arguments: @@ -1612,7 +1612,7 @@ func newUpdateSyncedDatabaseTable() *cobra.Command { cmd.Use = "update-synced-database-table NAME UPDATE_MASK" cmd.Short = `Update a Synced Database Table.` cmd.Long = `Update a Synced Database Table. - + This API is currently unimplemented, but exposed for Terraform support. Arguments: diff --git a/cmd/workspace/default-namespace/default-namespace.go b/cmd/workspace/default-namespace/default-namespace.go index d5a24dbb7e..b795743b20 100755 --- a/cmd/workspace/default-namespace/default-namespace.go +++ b/cmd/workspace/default-namespace/default-namespace.go @@ -23,13 +23,13 @@ func New() *cobra.Command { Short: `The default namespace setting API allows users to configure the default namespace for a Databricks workspace.`, Long: `The default namespace setting API allows users to configure the default namespace for a Databricks workspace. - + Through this API, users can retrieve, set, or modify the default namespace used when queries do not reference a fully qualified three-level name. For example, if you use the API to set 'retail_prod' as the default catalog, then a query 'SELECT * FROM myTable' would reference the object 'retail_prod.default.myTable' (the schema 'default' is always assumed). - + This setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.`, @@ -68,7 +68,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete the default namespace setting.` cmd.Long = `Delete the default namespace setting. - + Deletes the default namespace setting for the workspace. A fresh etag needs to be provided in DELETE requests (as a query parameter). The etag can be retrieved by making a GET request before the DELETE request. If the @@ -125,7 +125,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the default namespace setting.` cmd.Long = `Get the default namespace setting. - + Gets the default namespace setting.` cmd.Annotations = make(map[string]string) @@ -179,7 +179,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the default namespace setting.` cmd.Long = `Update the default namespace setting. - + Updates the default namespace setting for the workspace. A fresh etag needs to be provided in PATCH requests (as part of the setting field). The etag can be retrieved by making a GET request before the PATCH request. Note that diff --git a/cmd/workspace/default-warehouse-id/default-warehouse-id.go b/cmd/workspace/default-warehouse-id/default-warehouse-id.go index dec4078fe9..5bf39f37fd 100755 --- a/cmd/workspace/default-warehouse-id/default-warehouse-id.go +++ b/cmd/workspace/default-warehouse-id/default-warehouse-id.go @@ -61,7 +61,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete the Default Warehouse Id setting.` cmd.Long = `Delete the Default Warehouse Id setting. - + Reverts the Default Warehouse Id setting to its default value.` cmd.Annotations = make(map[string]string) @@ -114,7 +114,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the Default Warehouse Id setting.` cmd.Long = `Get the Default Warehouse Id setting. - + Gets the Default Warehouse Id setting.` cmd.Annotations = make(map[string]string) @@ -168,7 +168,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the Default Warehouse Id setting.` cmd.Long = `Update the Default Warehouse Id setting. - + Updates the Default Warehouse Id setting.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/disable-legacy-access/disable-legacy-access.go b/cmd/workspace/disable-legacy-access/disable-legacy-access.go index 3447a8fb8a..43d3598913 100755 --- a/cmd/workspace/disable-legacy-access/disable-legacy-access.go +++ b/cmd/workspace/disable-legacy-access/disable-legacy-access.go @@ -22,7 +22,7 @@ func New() *cobra.Command { Use: "disable-legacy-access", Short: `'Disabling legacy access' has the following impacts: 1.`, Long: `'Disabling legacy access' has the following impacts: - + 1. Disables direct access to Hive Metastores from the workspace. However, you can still access a Hive Metastore through Hive Metastore federation. 2. Disables fallback mode on external location access from the workspace. 3. @@ -62,7 +62,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete Legacy Access Disablement Status.` cmd.Long = `Delete Legacy Access Disablement Status. - + Deletes legacy access disablement status.` cmd.Annotations = make(map[string]string) @@ -115,7 +115,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Retrieve Legacy Access Disablement Status.` cmd.Long = `Retrieve Legacy Access Disablement Status. - + Retrieves legacy access disablement Status.` cmd.Annotations = make(map[string]string) @@ -169,7 +169,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update Legacy Access Disablement Status.` cmd.Long = `Update Legacy Access Disablement Status. - + Updates legacy access disablement status.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/disable-legacy-dbfs/disable-legacy-dbfs.go b/cmd/workspace/disable-legacy-dbfs/disable-legacy-dbfs.go index fd1d3fb902..e6110b17d6 100755 --- a/cmd/workspace/disable-legacy-dbfs/disable-legacy-dbfs.go +++ b/cmd/workspace/disable-legacy-dbfs/disable-legacy-dbfs.go @@ -22,10 +22,10 @@ func New() *cobra.Command { Use: "disable-legacy-dbfs", Short: `Disabling legacy DBFS has the following implications: 1.`, Long: `Disabling legacy DBFS has the following implications: - + 1. Access to DBFS root and DBFS mounts is disallowed (as well as the creation of new mounts). 2. Disables Databricks Runtime versions prior to 13.3LTS. - + When the setting is off, all DBFS functionality is enabled and no restrictions are imposed on Databricks Runtime versions. This setting can take up to 20 minutes to take effect and requires a manual restart of all-purpose compute @@ -65,7 +65,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete the disable legacy DBFS setting.` cmd.Long = `Delete the disable legacy DBFS setting. - + Deletes the disable legacy DBFS setting for a workspace, reverting back to the default.` @@ -119,7 +119,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the disable legacy DBFS setting.` cmd.Long = `Get the disable legacy DBFS setting. - + Gets the disable legacy DBFS setting.` cmd.Annotations = make(map[string]string) @@ -173,7 +173,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the disable legacy DBFS setting.` cmd.Long = `Update the disable legacy DBFS setting. - + Updates the disable legacy DBFS setting for the workspace.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/enable-export-notebook/enable-export-notebook.go b/cmd/workspace/enable-export-notebook/enable-export-notebook.go index bd916399be..e272fb0304 100755 --- a/cmd/workspace/enable-export-notebook/enable-export-notebook.go +++ b/cmd/workspace/enable-export-notebook/enable-export-notebook.go @@ -52,7 +52,7 @@ func newGetEnableExportNotebook() *cobra.Command { cmd.Use = "get-enable-export-notebook" cmd.Short = `Get the Notebook and File exporting setting.` cmd.Long = `Get the Notebook and File exporting setting. - + Gets the Notebook and File exporting setting.` cmd.Annotations = make(map[string]string) @@ -100,7 +100,7 @@ func newPatchEnableExportNotebook() *cobra.Command { cmd.Use = "patch-enable-export-notebook" cmd.Short = `Update the Notebook and File exporting setting.` cmd.Long = `Update the Notebook and File exporting setting. - + Updates the Notebook and File exporting setting. The model follows eventual consistency, which means the get after the update operation might receive stale values for some time.` diff --git a/cmd/workspace/enable-notebook-table-clipboard/enable-notebook-table-clipboard.go b/cmd/workspace/enable-notebook-table-clipboard/enable-notebook-table-clipboard.go index db5e1c488a..3fa502d448 100755 --- a/cmd/workspace/enable-notebook-table-clipboard/enable-notebook-table-clipboard.go +++ b/cmd/workspace/enable-notebook-table-clipboard/enable-notebook-table-clipboard.go @@ -52,7 +52,7 @@ func newGetEnableNotebookTableClipboard() *cobra.Command { cmd.Use = "get-enable-notebook-table-clipboard" cmd.Short = `Get the Results Table Clipboard features setting.` cmd.Long = `Get the Results Table Clipboard features setting. - + Gets the Results Table Clipboard features setting.` cmd.Annotations = make(map[string]string) @@ -100,7 +100,7 @@ func newPatchEnableNotebookTableClipboard() *cobra.Command { cmd.Use = "patch-enable-notebook-table-clipboard" cmd.Short = `Update the Results Table Clipboard features setting.` cmd.Long = `Update the Results Table Clipboard features setting. - + Updates the Results Table Clipboard features setting. The model follows eventual consistency, which means the get after the update operation might receive stale values for some time.` diff --git a/cmd/workspace/enable-results-downloading/enable-results-downloading.go b/cmd/workspace/enable-results-downloading/enable-results-downloading.go index 4393f8b2c0..540b0274b3 100755 --- a/cmd/workspace/enable-results-downloading/enable-results-downloading.go +++ b/cmd/workspace/enable-results-downloading/enable-results-downloading.go @@ -52,7 +52,7 @@ func newGetEnableResultsDownloading() *cobra.Command { cmd.Use = "get-enable-results-downloading" cmd.Short = `Get the Notebook results download setting.` cmd.Long = `Get the Notebook results download setting. - + Gets the Notebook results download setting.` cmd.Annotations = make(map[string]string) @@ -100,7 +100,7 @@ func newPatchEnableResultsDownloading() *cobra.Command { cmd.Use = "patch-enable-results-downloading" cmd.Short = `Update the Notebook results download setting.` cmd.Long = `Update the Notebook results download setting. - + Updates the Notebook results download setting. The model follows eventual consistency, which means the get after the update operation might receive stale values for some time.` diff --git a/cmd/workspace/enhanced-security-monitoring/enhanced-security-monitoring.go b/cmd/workspace/enhanced-security-monitoring/enhanced-security-monitoring.go index 2621d13604..99daa63fb4 100755 --- a/cmd/workspace/enhanced-security-monitoring/enhanced-security-monitoring.go +++ b/cmd/workspace/enhanced-security-monitoring/enhanced-security-monitoring.go @@ -25,7 +25,7 @@ func New() *cobra.Command { workspace. If the compliance security profile is enabled, this is automatically enabled. By default, it is disabled. However, if the compliance security profile is enabled, this is automatically enabled. - + If the compliance security profile is disabled, you can enable or disable this setting and it is not permanent.`, RunE: root.ReportUnknownSubcommand, @@ -62,7 +62,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the enhanced security monitoring setting.` cmd.Long = `Get the enhanced security monitoring setting. - + Gets the enhanced security monitoring setting.` cmd.Annotations = make(map[string]string) @@ -116,7 +116,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the enhanced security monitoring setting.` cmd.Long = `Update the enhanced security monitoring setting. - + Updates the enhanced security monitoring setting for the workspace. A fresh etag needs to be provided in PATCH requests (as part of the setting field). The etag can be retrieved by making a GET request before the PATCH diff --git a/cmd/workspace/entity-tag-assignments/entity-tag-assignments.go b/cmd/workspace/entity-tag-assignments/entity-tag-assignments.go index 7dffa32804..b7852185ab 100755 --- a/cmd/workspace/entity-tag-assignments/entity-tag-assignments.go +++ b/cmd/workspace/entity-tag-assignments/entity-tag-assignments.go @@ -71,17 +71,17 @@ func newCreate() *cobra.Command { cmd.Use = "create ENTITY_NAME TAG_KEY ENTITY_TYPE" cmd.Short = `Create an entity tag assignment.` cmd.Long = `Create an entity tag assignment. - + Creates a tag assignment for an Unity Catalog entity. - + To add tags to Unity Catalog entities, you must own the entity or have the following privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the entity's parent schema - **USE CATALOG** on the entity's parent catalog - + To add a governed tag to Unity Catalog entities, you must also have the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy permissions]. - + [Manage tag policy permissions]: https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions Arguments: @@ -167,17 +167,17 @@ func newDelete() *cobra.Command { cmd.Use = "delete ENTITY_TYPE ENTITY_NAME TAG_KEY" cmd.Short = `Delete an entity tag assignment.` cmd.Long = `Delete an entity tag assignment. - + Deletes a tag assignment for an Unity Catalog entity by its key. - + To delete tags from Unity Catalog entities, you must own the entity or have the following privileges: - **APPLY TAG** on the entity - **USE_SCHEMA** on the entity's parent schema - **USE_CATALOG** on the entity's parent catalog - + To delete a governed tag from Unity Catalog entities, you must also have the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy permissions]. - + [Manage tag policy permissions]: https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions Arguments: @@ -238,7 +238,7 @@ func newGet() *cobra.Command { cmd.Use = "get ENTITY_TYPE ENTITY_NAME TAG_KEY" cmd.Short = `Get an entity tag assignment.` cmd.Long = `Get an entity tag assignment. - + Gets a tag assignment for an Unity Catalog entity by tag key. Arguments: @@ -302,9 +302,9 @@ func newList() *cobra.Command { cmd.Use = "list ENTITY_TYPE ENTITY_NAME" cmd.Short = `List entity tag assignments.` cmd.Long = `List entity tag assignments. - + List tag assignments for an Unity Catalog entity - + PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the @@ -369,17 +369,17 @@ func newUpdate() *cobra.Command { cmd.Use = "update ENTITY_TYPE ENTITY_NAME TAG_KEY UPDATE_MASK" cmd.Short = `Update an entity tag assignment.` cmd.Long = `Update an entity tag assignment. - + Updates an existing tag assignment for an Unity Catalog entity. - + To update tags to Unity Catalog entities, you must own the entity or have the following privileges: - **APPLY TAG** on the entity - **USE SCHEMA** on the entity's parent schema - **USE CATALOG** on the entity's parent catalog - + To update a governed tag to Unity Catalog entities, you must also have the **ASSIGN** or **MANAGE** permission on the tag policy. See [Manage tag policy permissions]. - + [Manage tag policy permissions]: https://docs.databricks.com/aws/en/admin/tag-policies/manage-permissions Arguments: @@ -393,7 +393,7 @@ func newUpdate() *cobra.Command { Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the diff --git a/cmd/workspace/experiments/experiments.go b/cmd/workspace/experiments/experiments.go index 3b877589e7..4f6e9fa792 100755 --- a/cmd/workspace/experiments/experiments.go +++ b/cmd/workspace/experiments/experiments.go @@ -26,7 +26,7 @@ func New() *cobra.Command { compare runs, as well as download run artifacts or metadata for analysis in other tools. Experiments are maintained in a Databricks hosted MLflow tracking server. - + Experiments are located in the workspace file tree. You manage experiments using the same tools you use to manage other workspace objects such as folders, notebooks, and libraries.`, @@ -109,12 +109,12 @@ func newCreateExperiment() *cobra.Command { cmd.Use = "create-experiment NAME" cmd.Short = `Create experiment.` cmd.Long = `Create experiment. - + Creates an experiment with a name. Returns the ID of the newly created experiment. Validates that another experiment with the same name does not already exist and fails if another experiment with the same name already exists. - + Throws RESOURCE_ALREADY_EXISTS if an experiment with the given name exists. Arguments: @@ -284,7 +284,7 @@ func newCreateRun() *cobra.Command { cmd.Use = "create-run" cmd.Short = `Create a run.` cmd.Long = `Create a run. - + Creates a new run within an experiment. A run is usually a single execution of a machine learning or data ETL pipeline. MLflow uses runs to track the mlflowParam, mlflowMetric, and mlflowRunTag associated with a single @@ -354,7 +354,7 @@ func newDeleteExperiment() *cobra.Command { cmd.Use = "delete-experiment EXPERIMENT_ID" cmd.Short = `Delete an experiment.` cmd.Long = `Delete an experiment. - + Marks an experiment and associated metadata, runs, metrics, params, and tags for deletion. If the experiment uses FileStore, artifacts associated with the experiment are also deleted. @@ -546,7 +546,7 @@ func newDeleteRun() *cobra.Command { cmd.Use = "delete-run RUN_ID" cmd.Short = `Delete a run.` cmd.Long = `Delete a run. - + Marks a run for deletion. Arguments: @@ -628,7 +628,7 @@ func newDeleteRuns() *cobra.Command { cmd.Use = "delete-runs EXPERIMENT_ID MAX_TIMESTAMP_MILLIS" cmd.Short = `Delete runs by creation time.` cmd.Long = `Delete runs by creation time. - + Bulk delete runs in an experiment that were created prior to or at the specified timestamp. Deletes at most max_runs per request. To call this API from a Databricks Notebook in Python, you can use the client code snippet on @@ -720,7 +720,7 @@ func newDeleteTag() *cobra.Command { cmd.Use = "delete-tag RUN_ID KEY" cmd.Short = `Delete a tag on a run.` cmd.Long = `Delete a tag on a run. - + Deletes a tag on a run. Tags are run metadata that can be updated during a run and after a run completes. @@ -810,7 +810,7 @@ func newFinalizeLoggedModel() *cobra.Command { MODEL_ID: The ID of the logged model to finalize. STATUS: Whether or not the model is ready for use. "LOGGED_MODEL_UPLOAD_FAILED" indicates that something went wrong when - logging the model weights / agent code. + logging the model weights / agent code. Supported values: [LOGGED_MODEL_PENDING, LOGGED_MODEL_READY, LOGGED_MODEL_UPLOAD_FAILED]` cmd.Annotations = make(map[string]string) @@ -889,14 +889,14 @@ func newGetByName() *cobra.Command { cmd.Use = "get-by-name EXPERIMENT_NAME" cmd.Short = `Get an experiment by name.` cmd.Long = `Get an experiment by name. - + Gets metadata for an experiment. - + This endpoint will return deleted experiments, but prefers the active experiment if an active and deleted experiment share the same name. If multiple deleted experiments share the same name, the API will return one of them. - + Throws RESOURCE_DOES_NOT_EXIST if no experiment with the specified name exists. @@ -953,7 +953,7 @@ func newGetExperiment() *cobra.Command { cmd.Use = "get-experiment EXPERIMENT_ID" cmd.Short = `Get an experiment.` cmd.Long = `Get an experiment. - + Gets metadata for an experiment. This method works on deleted experiments. Arguments: @@ -1014,7 +1014,7 @@ func newGetHistory() *cobra.Command { cmd.Use = "get-history METRIC_KEY" cmd.Short = `Get metric history for a run.` cmd.Long = `Get metric history for a run. - + Gets a list of all values for the specified metric for a given run. Arguments: @@ -1121,7 +1121,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels EXPERIMENT_ID" cmd.Short = `Get experiment permission levels.` cmd.Long = `Get experiment permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -1177,7 +1177,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions EXPERIMENT_ID" cmd.Short = `Get experiment permissions.` cmd.Long = `Get experiment permissions. - + Gets the permissions of an experiment. Experiments can inherit permissions from their root object. @@ -1236,11 +1236,11 @@ func newGetRun() *cobra.Command { cmd.Use = "get-run RUN_ID" cmd.Short = `Get a run.` cmd.Long = `Get a run. - + Gets the metadata, metrics, params, and tags for a run. In the case where multiple metrics with the same key are logged for a run, return only the value with the latest timestamp. - + If there are multiple values with the latest timestamp, return the maximum of these values. @@ -1302,7 +1302,7 @@ func newListArtifacts() *cobra.Command { cmd.Use = "list-artifacts" cmd.Short = `List artifacts.` cmd.Long = `List artifacts. - + List artifacts for a run. Takes an optional artifact_path prefix which if specified, the response contains only artifacts with the specified prefix. A maximum of 1000 artifacts will be retrieved for UC Volumes. Please call @@ -1359,7 +1359,7 @@ func newListExperiments() *cobra.Command { cmd.Use = "list-experiments" cmd.Short = `List experiments.` cmd.Long = `List experiments. - + Gets a list of all experiments.` cmd.Annotations = make(map[string]string) @@ -1415,49 +1415,49 @@ func newLogBatch() *cobra.Command { cmd.Use = "log-batch" cmd.Short = `Log a batch of metrics/params/tags for a run.` cmd.Long = `Log a batch of metrics/params/tags for a run. - + Logs a batch of metrics, params, and tags for a run. If any data failed to be persisted, the server will respond with an error (non-200 status code). - + In case of error (due to internal server error or an invalid request), partial data may be written. - + You can write metrics, params, and tags in interleaving fashion, but within a given entity type are guaranteed to follow the order specified in the request body. - + The overwrite behavior for metrics, params, and tags is as follows: - + * Metrics: metric values are never overwritten. Logging a metric (key, value, timestamp) appends to the set of values for the metric with the provided key. - + * Tags: tag values can be overwritten by successive writes to the same tag key. That is, if multiple tag values with the same key are provided in the same API request, the last-provided tag value is written. Logging the same tag (key, value) is permitted. Specifically, logging a tag is idempotent. - + * Parameters: once written, param values cannot be changed (attempting to overwrite a param value will result in an error). However, logging the same param (key, value) is permitted. Specifically, logging a param is idempotent. - + Request Limits ------------------------------- A single JSON-serialized API request may be up to 1 MB in size and contain: - + * No more than 1000 metrics, params, and tags in total - + * Up to 1000 metrics - + * Up to 100 params - + * Up to 100 tags - + For example, a valid request might contain 900 metrics, 50 params, and 50 tags, but logging 900 metrics, 50 params, and 51 tags is invalid. - + The following limits also apply to metric, param, and tag keys and values: - + * Metric keys, param keys, and tag keys can be up to 250 characters in length - + * Parameter and tag values can be up to 250 characters in length` cmd.Annotations = make(map[string]string) @@ -1527,7 +1527,7 @@ func newLogInputs() *cobra.Command { cmd.Use = "log-inputs RUN_ID" cmd.Short = `Log inputs to a run.` cmd.Long = `Log inputs to a run. - + Logs inputs, such as datasets and models, to an MLflow Run. Arguments: @@ -1609,7 +1609,7 @@ func newLogLoggedModelParams() *cobra.Command { cmd.Use = "log-logged-model-params MODEL_ID" cmd.Short = `Log params for a logged model.` cmd.Long = `Log params for a logged model. - + Logs params for a logged model. A param is a key-value pair (string key, string value). Examples include hyperparameters used for ML model training. A param can be logged only once for a logged model, and attempting to overwrite @@ -1690,7 +1690,7 @@ func newLogMetric() *cobra.Command { cmd.Use = "log-metric KEY VALUE TIMESTAMP" cmd.Short = `Log a metric for a run.` cmd.Long = `Log a metric for a run. - + Log a metric for a run. A metric is a key-value pair (string key, float value) with an associated timestamp. Examples include the various metrics that represent ML model accuracy. A metric can be logged multiple times. @@ -1791,11 +1791,11 @@ func newLogModel() *cobra.Command { cmd.Use = "log-model" cmd.Short = `Log a model.` cmd.Long = `Log a model. - + **Note:** the [Create a logged model](/api/workspace/experiments/createloggedmodel) API replaces this endpoint. - + Log a model to an MLflow Run.` cmd.Annotations = make(map[string]string) @@ -1864,7 +1864,7 @@ func newLogOutputs() *cobra.Command { cmd.Use = "log-outputs RUN_ID" cmd.Short = `Log outputs from a run.` cmd.Long = `Log outputs from a run. - + Logs outputs, such as models, from an MLflow Run. Arguments: @@ -1947,7 +1947,7 @@ func newLogParam() *cobra.Command { cmd.Use = "log-param KEY VALUE" cmd.Short = `Log a param for a run.` cmd.Long = `Log a param for a run. - + Logs a param used for a run. A param is a key-value pair (string key, string value). Examples include hyperparameters used for ML model training and constant dates and values used in an ETL pipeline. A param can be logged only @@ -2034,11 +2034,11 @@ func newRestoreExperiment() *cobra.Command { cmd.Use = "restore-experiment EXPERIMENT_ID" cmd.Short = `Restore an experiment.` cmd.Long = `Restore an experiment. - + Restore an experiment marked for deletion. This also restores associated metadata, runs, metrics, params, and tags. If experiment uses FileStore, underlying artifacts associated with experiment are also restored. - + Throws RESOURCE_DOES_NOT_EXIST if experiment was never created or was permanently deleted. @@ -2119,10 +2119,10 @@ func newRestoreRun() *cobra.Command { cmd.Use = "restore-run RUN_ID" cmd.Short = `Restore a run.` cmd.Long = `Restore a run. - + Restores a deleted run. This also restores associated metadata, runs, metrics, params, and tags. - + Throws RESOURCE_DOES_NOT_EXIST if the run was never created or was permanently deleted. @@ -2205,7 +2205,7 @@ func newRestoreRuns() *cobra.Command { cmd.Use = "restore-runs EXPERIMENT_ID MIN_TIMESTAMP_MILLIS" cmd.Short = `Restore runs by deletion time.` cmd.Long = `Restore runs by deletion time. - + Bulk restore runs in an experiment that were deleted no earlier than the specified timestamp. Restores at most max_runs per request. To call this API from a Databricks Notebook in Python, you can use the client code snippet on @@ -2303,7 +2303,7 @@ func newSearchExperiments() *cobra.Command { cmd.Use = "search-experiments" cmd.Short = `Search experiments.` cmd.Long = `Search experiments. - + Searches for experiments that satisfy specified search criteria.` cmd.Annotations = make(map[string]string) @@ -2374,7 +2374,7 @@ func newSearchLoggedModels() *cobra.Command { cmd.Use = "search-logged-models" cmd.Short = `Search logged models.` cmd.Long = `Search logged models. - + Search for Logged Models that satisfy specified search criteria.` cmd.Annotations = make(map[string]string) @@ -2448,9 +2448,9 @@ func newSearchRuns() *cobra.Command { cmd.Use = "search-runs" cmd.Short = `Search for runs.` cmd.Long = `Search for runs. - + Searches for runs that satisfy expressions. - + Search expressions can use mlflowMetric and mlflowParam keys.` cmd.Annotations = make(map[string]string) @@ -2514,7 +2514,7 @@ func newSetExperimentTag() *cobra.Command { cmd.Use = "set-experiment-tag EXPERIMENT_ID KEY VALUE" cmd.Short = `Set a tag for an experiment.` cmd.Long = `Set a tag for an experiment. - + Sets a tag on an experiment. Experiment tags are metadata that can be updated. Arguments: @@ -2676,7 +2676,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions EXPERIMENT_ID" cmd.Short = `Set experiment permissions.` cmd.Long = `Set experiment permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -2752,7 +2752,7 @@ func newSetTag() *cobra.Command { cmd.Use = "set-tag KEY VALUE" cmd.Short = `Set a tag for a run.` cmd.Long = `Set a tag for a run. - + Sets a tag on a run. Tags are run metadata that can be updated during a run and after a run completes. @@ -2840,7 +2840,7 @@ func newUpdateExperiment() *cobra.Command { cmd.Use = "update-experiment EXPERIMENT_ID" cmd.Short = `Update an experiment.` cmd.Long = `Update an experiment. - + Updates experiment metadata. Arguments: @@ -2922,7 +2922,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions EXPERIMENT_ID" cmd.Short = `Update experiment permissions.` cmd.Long = `Update experiment permissions. - + Updates the permissions on an experiment. Experiments can inherit permissions from their root object. @@ -3000,7 +3000,7 @@ func newUpdateRun() *cobra.Command { cmd.Use = "update-run" cmd.Short = `Update a run.` cmd.Long = `Update a run. - + Updates run metadata.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/external-lineage/external-lineage.go b/cmd/workspace/external-lineage/external-lineage.go index ea0e7a6ef7..8bc315cf4d 100755 --- a/cmd/workspace/external-lineage/external-lineage.go +++ b/cmd/workspace/external-lineage/external-lineage.go @@ -25,7 +25,7 @@ func New() *cobra.Command { between Databricks objects and external systems. These APIs allow users to capture data flows connecting Databricks tables, models, and file paths with external metadata objects. - + With these APIs, users can create, update, delete, and list lineage relationships with support for column-level mappings and custom properties.`, GroupID: "catalog", @@ -73,7 +73,7 @@ func newCreateExternalLineageRelationship() *cobra.Command { cmd.Use = "create-external-lineage-relationship SOURCE TARGET" cmd.Short = `Create an external lineage relationship.` cmd.Long = `Create an external lineage relationship. - + Creates an external lineage relationship between a Databricks or external metadata object and another external metadata object. @@ -166,7 +166,7 @@ func newDeleteExternalLineageRelationship() *cobra.Command { cmd.Use = "delete-external-lineage-relationship" cmd.Short = `Delete an external lineage relationship.` cmd.Long = `Delete an external lineage relationship. - + Deletes an external lineage relationship between a Databricks or external metadata object and another external metadata object.` @@ -234,7 +234,7 @@ func newListExternalLineageRelationships() *cobra.Command { cmd.Use = "list-external-lineage-relationships" cmd.Short = `List external lineage relationships.` cmd.Long = `List external lineage relationships. - + Lists external lineage relationships of a Databricks object or external metadata given a supplied direction.` @@ -300,7 +300,7 @@ func newUpdateExternalLineageRelationship() *cobra.Command { cmd.Use = "update-external-lineage-relationship UPDATE_MASK SOURCE TARGET" cmd.Short = `Update an external lineage relationship.` cmd.Long = `Update an external lineage relationship. - + Updates an external lineage relationship between a Databricks or external metadata object and another external metadata object. @@ -311,7 +311,7 @@ func newUpdateExternalLineageRelationship() *cobra.Command { Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the diff --git a/cmd/workspace/external-locations/external-locations.go b/cmd/workspace/external-locations/external-locations.go index 63c6f4e8c6..eeb7b4076b 100755 --- a/cmd/workspace/external-locations/external-locations.go +++ b/cmd/workspace/external-locations/external-locations.go @@ -28,10 +28,10 @@ func New() *cobra.Command { have access to an external location in Unity Catalog, the request fails and Unity Catalog does not attempt to authenticate to your cloud tenant on the user’s behalf. - + Databricks recommends using external locations rather than using storage credentials directly. - + To create external locations, you must be a metastore admin or a user with the **CREATE_EXTERNAL_LOCATION** privilege.`, GroupID: "catalog", @@ -84,7 +84,7 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME URL CREDENTIAL_NAME" cmd.Short = `Create an external location.` cmd.Long = `Create an external location. - + Creates a new external location entry in the metastore. The caller must be a metastore admin or have the **CREATE_EXTERNAL_LOCATION** privilege on both the metastore and the associated storage credential. @@ -173,7 +173,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete an external location.` cmd.Long = `Delete an external location. - + Deletes the specified external location from the metastore. The caller must be the owner of the external location. @@ -232,7 +232,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get an external location.` cmd.Long = `Get an external location. - + Gets an external location from the metastore. The caller must be either a metastore admin, the owner of the external location, or a user that has some privilege on the external location. @@ -295,15 +295,15 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List external locations.` cmd.Long = `List external locations. - + Gets an array of external locations (__ExternalLocationInfo__ objects) from the metastore. The caller must be a metastore admin, the owner of the external location, or a user that has some privilege on the external location. There is no guarantee of a specific ordering of the elements in the array. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -371,7 +371,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update an external location.` cmd.Long = `Update an external location. - + Updates an external location in the metastore. The caller must be the owner of the external location, or be a metastore admin. In the second case, the admin can only update the name of the external location. diff --git a/cmd/workspace/external-metadata/external-metadata.go b/cmd/workspace/external-metadata/external-metadata.go index 0c3cb1211f..dbec2c478e 100755 --- a/cmd/workspace/external-metadata/external-metadata.go +++ b/cmd/workspace/external-metadata/external-metadata.go @@ -23,7 +23,7 @@ func New() *cobra.Command { Short: `External Metadata objects enable customers to register and manage metadata about external systems within Unity Catalog.`, Long: `External Metadata objects enable customers to register and manage metadata about external systems within Unity Catalog. - + These APIs provide a standardized way to create, update, retrieve, list, and delete external metadata objects. Fine-grained authorization ensures that only users with appropriate permissions can view and manage external metadata @@ -77,14 +77,14 @@ func newCreateExternalMetadata() *cobra.Command { cmd.Use = "create-external-metadata NAME SYSTEM_TYPE ENTITY_TYPE" cmd.Short = `Create an external metadata object.` cmd.Long = `Create an external metadata object. - + Creates a new external metadata object in the parent metastore if the caller is a metastore admin or has the **CREATE_EXTERNAL_METADATA** privilege. Grants **BROWSE** to all account users upon creation by default. Arguments: NAME: Name of the external metadata object. - SYSTEM_TYPE: Type of external system. + SYSTEM_TYPE: Type of external system. Supported values: [ AMAZON_REDSHIFT, AZURE_SYNAPSE, @@ -193,7 +193,7 @@ func newDeleteExternalMetadata() *cobra.Command { cmd.Use = "delete-external-metadata NAME" cmd.Short = `Delete an external metadata object.` cmd.Long = `Delete an external metadata object. - + Deletes the external metadata object that matches the supplied name. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the **MANAGE** privilege.` @@ -248,7 +248,7 @@ func newGetExternalMetadata() *cobra.Command { cmd.Use = "get-external-metadata NAME" cmd.Short = `Get an external metadata object.` cmd.Long = `Get an external metadata object. - + Gets the specified external metadata object in a metastore. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the **BROWSE** privilege.` @@ -306,7 +306,7 @@ func newListExternalMetadata() *cobra.Command { cmd.Use = "list-external-metadata" cmd.Short = `List external metadata objects.` cmd.Long = `List external metadata objects. - + Gets an array of external metadata objects in the metastore. If the caller is the metastore admin, all external metadata objects will be retrieved. Otherwise, only external metadata objects that the caller has **BROWSE** on @@ -368,7 +368,7 @@ func newUpdateExternalMetadata() *cobra.Command { cmd.Use = "update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE" cmd.Short = `Update an external metadata object.` cmd.Long = `Update an external metadata object. - + Updates the external metadata object that matches the supplied name. The caller can only update either the owner or other metadata fields in one request. The caller must be a metastore admin, the owner of the external @@ -383,12 +383,12 @@ func newUpdateExternalMetadata() *cobra.Command { Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the future. - SYSTEM_TYPE: Type of external system. + SYSTEM_TYPE: Type of external system. Supported values: [ AMAZON_REDSHIFT, AZURE_SYNAPSE, diff --git a/cmd/workspace/feature-engineering/feature-engineering.go b/cmd/workspace/feature-engineering/feature-engineering.go index 39d003a1f2..9f78dc4002 100755 --- a/cmd/workspace/feature-engineering/feature-engineering.go +++ b/cmd/workspace/feature-engineering/feature-engineering.go @@ -76,7 +76,7 @@ func newCreateFeature() *cobra.Command { cmd.Use = "create-feature FULL_NAME SOURCE INPUTS FUNCTION TIME_WINDOW" cmd.Short = `Create a feature.` cmd.Long = `Create a feature. - + Create a Feature. Arguments: @@ -268,7 +268,7 @@ func newDeleteFeature() *cobra.Command { cmd.Use = "delete-feature FULL_NAME" cmd.Short = `Delete a feature.` cmd.Long = `Delete a feature. - + Delete a Feature. Arguments: @@ -378,7 +378,7 @@ func newGetFeature() *cobra.Command { cmd.Use = "get-feature FULL_NAME" cmd.Short = `Get a feature.` cmd.Long = `Get a feature. - + Get a Feature. Arguments: @@ -491,7 +491,7 @@ func newListFeatures() *cobra.Command { cmd.Use = "list-features" cmd.Short = `List features.` cmd.Long = `List features. - + List Features.` cmd.Annotations = make(map[string]string) @@ -596,7 +596,7 @@ func newUpdateFeature() *cobra.Command { cmd.Use = "update-feature FULL_NAME UPDATE_MASK SOURCE INPUTS FUNCTION TIME_WINDOW" cmd.Short = `Update a feature's description (all other fields are immutable).` cmd.Long = `Update a feature's description (all other fields are immutable). - + Update a Feature. Arguments: @@ -713,7 +713,7 @@ func newUpdateMaterializedFeature() *cobra.Command { cmd.Use = "update-materialized-feature MATERIALIZED_FEATURE_ID UPDATE_MASK FEATURE_NAME" cmd.Short = `Update a materialized feature.` cmd.Long = `Update a materialized feature. - + Update a materialized feature (pause/resume). Arguments: diff --git a/cmd/workspace/feature-store/feature-store.go b/cmd/workspace/feature-store/feature-store.go index 00bb904df1..29d5fc1f87 100755 --- a/cmd/workspace/feature-store/feature-store.go +++ b/cmd/workspace/feature-store/feature-store.go @@ -25,7 +25,7 @@ func New() *cobra.Command { find and share features. Using a feature store also ensures that the code used to compute feature values is the same during model training and when the model is used for inference. - + An online store is a low-latency database used for feature lookup during real-time model inference or serve feature for real-time applications.`, GroupID: "ml", diff --git a/cmd/workspace/forecasting/forecasting.go b/cmd/workspace/forecasting/forecasting.go index 188a2709fe..7516cf576d 100755 --- a/cmd/workspace/forecasting/forecasting.go +++ b/cmd/workspace/forecasting/forecasting.go @@ -85,7 +85,7 @@ func newCreateExperiment() *cobra.Command { cmd.Use = "create-experiment TRAIN_DATA_PATH TARGET_COLUMN TIME_COLUMN FORECAST_GRANULARITY FORECAST_HORIZON" cmd.Short = `Create a forecasting experiment.` cmd.Long = `Create a forecasting experiment. - + Creates a serverless forecasting experiment. Returns the experiment ID. Arguments: @@ -205,7 +205,7 @@ func newGetExperiment() *cobra.Command { cmd.Use = "get-experiment EXPERIMENT_ID" cmd.Short = `Get a forecasting experiment.` cmd.Long = `Get a forecasting experiment. - + Public RPC to get forecasting experiment Arguments: diff --git a/cmd/workspace/functions/functions.go b/cmd/workspace/functions/functions.go index 078a168b96..c158986e3d 100755 --- a/cmd/workspace/functions/functions.go +++ b/cmd/workspace/functions/functions.go @@ -22,7 +22,7 @@ func New() *cobra.Command { Use: "functions", Short: `Functions implement User-Defined Functions (UDFs) in Unity Catalog.`, Long: `Functions implement User-Defined Functions (UDFs) in Unity Catalog. - + The function implementation can be any SQL expression or Query, and it can be invoked wherever a table reference is allowed in a query. In Unity Catalog, a function resides at the same level as a table, so it can be referenced with @@ -69,11 +69,11 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a function.` cmd.Long = `Create a function. - + **WARNING: This API is experimental and will change in future versions** - + Creates a new function - + The user must have the following permissions in order for the function to be created: - **USE_CATALOG** on the function's parent catalog - **USE_SCHEMA** and **CREATE_FUNCTION** on the function's parent schema` @@ -138,7 +138,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete a function.` cmd.Long = `Delete a function. - + Deletes the function that matches the supplied name. For the deletion to succeed, the user must satisfy one of the following conditions: - Is the owner of the function's parent catalog - Is the owner of the function's parent @@ -214,7 +214,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get a function.` cmd.Long = `Get a function. - + Gets a function from within a parent catalog and schema. For the fetch to succeed, the user must satisfy one of the following requirements: - Is a metastore admin - Is an owner of the function's parent catalog - Have the @@ -293,7 +293,7 @@ func newList() *cobra.Command { cmd.Use = "list CATALOG_NAME SCHEMA_NAME" cmd.Short = `List functions.` cmd.Long = `List functions. - + List functions within the specified parent catalog and schema. If the user is a metastore admin, all functions are returned in the output list. Otherwise, the user must have the **USE_CATALOG** privilege on the catalog and the @@ -301,10 +301,10 @@ func newList() *cobra.Command { functions for which either the user has the **EXECUTE** privilege or the user is the owner. There is no guarantee of a specific ordering of the elements in the array. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -367,7 +367,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update a function.` cmd.Long = `Update a function. - + Updates the function that matches the supplied name. Only the owner of the function can be updated. If the user is not a metastore admin, the user must be a member of the group that is the new function owner. - Is a metastore diff --git a/cmd/workspace/genie/genie.go b/cmd/workspace/genie/genie.go index ce6e01279b..0bce00d239 100755 --- a/cmd/workspace/genie/genie.go +++ b/cmd/workspace/genie/genie.go @@ -86,7 +86,7 @@ func newCreateMessage() *cobra.Command { cmd.Use = "create-message SPACE_ID CONVERSATION_ID CONTENT" cmd.Short = `Create conversation message.` cmd.Long = `Create conversation message. - + Create new message in a [conversation](:method:genie/startconversation). The AI response uses all previously created messages in the conversation to respond. @@ -182,7 +182,7 @@ func newDeleteConversation() *cobra.Command { cmd.Use = "delete-conversation SPACE_ID CONVERSATION_ID" cmd.Short = `Delete conversation.` cmd.Long = `Delete conversation. - + Delete a conversation. Arguments: @@ -240,7 +240,7 @@ func newDeleteConversationMessage() *cobra.Command { cmd.Use = "delete-conversation-message SPACE_ID CONVERSATION_ID MESSAGE_ID" cmd.Short = `Delete conversation message.` cmd.Long = `Delete conversation message. - + Delete a conversation message. Arguments: @@ -300,7 +300,7 @@ func newExecuteMessageAttachmentQuery() *cobra.Command { cmd.Use = "execute-message-attachment-query SPACE_ID CONVERSATION_ID MESSAGE_ID ATTACHMENT_ID" cmd.Short = `Execute message attachment SQL query.` cmd.Long = `Execute message attachment SQL query. - + Execute the SQL for a message query attachment. Use this API when the query attachment has expired and needs to be re-executed. @@ -363,7 +363,7 @@ func newExecuteMessageQuery() *cobra.Command { cmd.Use = "execute-message-query SPACE_ID CONVERSATION_ID MESSAGE_ID" cmd.Short = `[Deprecated] Execute SQL query in a conversation message.` cmd.Long = `[Deprecated] Execute SQL query in a conversation message. - + DEPRECATED: Use [Execute Message Attachment Query](:method:genie/executemessageattachmentquery) instead. @@ -427,7 +427,7 @@ func newGetMessage() *cobra.Command { cmd.Use = "get-message SPACE_ID CONVERSATION_ID MESSAGE_ID" cmd.Short = `Get conversation message.` cmd.Long = `Get conversation message. - + Get message from conversation. Arguments: @@ -489,7 +489,7 @@ func newGetMessageAttachmentQueryResult() *cobra.Command { cmd.Use = "get-message-attachment-query-result SPACE_ID CONVERSATION_ID MESSAGE_ID ATTACHMENT_ID" cmd.Short = `Get message attachment SQL query result.` cmd.Long = `Get message attachment SQL query result. - + Get the result of SQL query if the message has a query attachment. This is only available if a message has a query attachment and the message status is EXECUTING_QUERY OR COMPLETED. @@ -553,7 +553,7 @@ func newGetMessageQueryResult() *cobra.Command { cmd.Use = "get-message-query-result SPACE_ID CONVERSATION_ID MESSAGE_ID" cmd.Short = `[Deprecated] Get conversation message SQL query result.` cmd.Long = `[Deprecated] Get conversation message SQL query result. - + DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult) instead. @@ -617,7 +617,7 @@ func newGetMessageQueryResultByAttachment() *cobra.Command { cmd.Use = "get-message-query-result-by-attachment SPACE_ID CONVERSATION_ID MESSAGE_ID ATTACHMENT_ID" cmd.Short = `[Deprecated] Get conversation message SQL query result.` cmd.Long = `[Deprecated] Get conversation message SQL query result. - + DEPRECATED: Use [Get Message Attachment Query Result](:method:genie/getmessageattachmentqueryresult) instead. @@ -683,7 +683,7 @@ func newGetSpace() *cobra.Command { cmd.Use = "get-space SPACE_ID" cmd.Short = `Get Genie Space.` cmd.Long = `Get Genie Space. - + Get details of a Genie Space. Arguments: @@ -742,7 +742,7 @@ func newListConversationMessages() *cobra.Command { cmd.Use = "list-conversation-messages SPACE_ID CONVERSATION_ID" cmd.Short = `List conversation messages.` cmd.Long = `List conversation messages. - + List messages in a conversation Arguments: @@ -804,7 +804,7 @@ func newListConversations() *cobra.Command { cmd.Use = "list-conversations SPACE_ID" cmd.Short = `List conversations in a Genie Space.` cmd.Long = `List conversations in a Genie Space. - + Get a list of conversations in a Genie Space. Arguments: @@ -863,7 +863,7 @@ func newListSpaces() *cobra.Command { cmd.Use = "list-spaces" cmd.Short = `List Genie spaces.` cmd.Long = `List Genie spaces. - + Get list of Genie Spaces.` cmd.Annotations = make(map[string]string) @@ -917,14 +917,14 @@ func newSendMessageFeedback() *cobra.Command { cmd.Use = "send-message-feedback SPACE_ID CONVERSATION_ID MESSAGE_ID RATING" cmd.Short = `Send message feedback.` cmd.Long = `Send message feedback. - + Send feedback for a message. Arguments: SPACE_ID: The ID associated with the Genie space where the message is located. CONVERSATION_ID: The ID associated with the conversation. MESSAGE_ID: The ID associated with the message to provide feedback for. - RATING: The rating (POSITIVE, NEGATIVE, or NONE). + RATING: The rating (POSITIVE, NEGATIVE, or NONE). Supported values: [NEGATIVE, NONE, POSITIVE]` cmd.Annotations = make(map[string]string) @@ -1014,7 +1014,7 @@ func newStartConversation() *cobra.Command { cmd.Use = "start-conversation SPACE_ID CONTENT" cmd.Short = `Start conversation.` cmd.Long = `Start conversation. - + Start a new conversation. Arguments: @@ -1107,7 +1107,7 @@ func newTrashSpace() *cobra.Command { cmd.Use = "trash-space SPACE_ID" cmd.Short = `Trash Genie Space.` cmd.Long = `Trash Genie Space. - + Move a Genie Space to the trash. Arguments: diff --git a/cmd/workspace/git-credentials/git-credentials.go b/cmd/workspace/git-credentials/git-credentials.go index 02b60cc2e6..4878567ac4 100755 --- a/cmd/workspace/git-credentials/git-credentials.go +++ b/cmd/workspace/git-credentials/git-credentials.go @@ -23,9 +23,9 @@ func New() *cobra.Command { Short: `Registers personal access token for Databricks to do operations on behalf of the user.`, Long: `Registers personal access token for Databricks to do operations on behalf of the user. - + See [more info]. - + [more info]: https://docs.databricks.com/repos/get-access-tokens-from-git-provider.html`, GroupID: "workspace", Annotations: map[string]string{ @@ -75,7 +75,7 @@ func newCreate() *cobra.Command { cmd.Use = "create GIT_PROVIDER" cmd.Short = `Create a credential entry.` cmd.Long = `Create a credential entry. - + Creates a Git credential entry for the user. Only one Git credential per user is supported, so any attempts to create credentials if an entry already exists will fail. Use the PATCH endpoint to update existing credentials, or the @@ -158,7 +158,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete CREDENTIAL_ID" cmd.Short = `Delete a credential.` cmd.Long = `Delete a credential. - + Deletes the specified Git credential. Arguments: @@ -229,7 +229,7 @@ func newGet() *cobra.Command { cmd.Use = "get CREDENTIAL_ID" cmd.Short = `Get a credential entry.` cmd.Long = `Get a credential entry. - + Gets the Git credential with the specified credential ID. Arguments: @@ -297,7 +297,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get Git credentials.` cmd.Long = `Get Git credentials. - + Lists the calling user's Git credentials. One credential per user is supported.` @@ -349,7 +349,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update CREDENTIAL_ID GIT_PROVIDER" cmd.Short = `Update a credential.` cmd.Long = `Update a credential. - + Updates the specified Git credential. Arguments: diff --git a/cmd/workspace/global-init-scripts/global-init-scripts.go b/cmd/workspace/global-init-scripts/global-init-scripts.go index ed20214985..f4cd75d5e2 100755 --- a/cmd/workspace/global-init-scripts/global-init-scripts.go +++ b/cmd/workspace/global-init-scripts/global-init-scripts.go @@ -24,7 +24,7 @@ func New() *cobra.Command { Long: `The Global Init Scripts API enables Workspace administrators to configure global initialization scripts for their workspace. These scripts run on every node in every cluster in the workspace. - + **Important:** Existing clusters must be restarted to pick up any changes made to global init scripts. Global init scripts are run in order. If the init script returns with a bad exit code, the Apache Spark container fails to @@ -75,7 +75,7 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME SCRIPT" cmd.Short = `Create init script.` cmd.Long = `Create init script. - + Creates a new global init script in this workspace. Arguments: @@ -156,7 +156,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete SCRIPT_ID" cmd.Short = `Delete init script.` cmd.Long = `Delete init script. - + Deletes a global init script. Arguments: @@ -224,7 +224,7 @@ func newGet() *cobra.Command { cmd.Use = "get SCRIPT_ID" cmd.Short = `Get an init script.` cmd.Long = `Get an init script. - + Gets all the details of a script, including its Base64-encoded contents. Arguments: @@ -289,7 +289,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get init scripts.` cmd.Long = `Get init scripts. - + Get a list of all global init scripts for this workspace. This returns all properties for each script but **not** the script contents. To retrieve the contents of a script, use the [get a global init @@ -340,7 +340,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update SCRIPT_ID NAME SCRIPT" cmd.Short = `Update init script.` cmd.Long = `Update init script. - + Updates a global init script, specifying only the fields to change. All fields are optional. Unspecified fields retain their current value. diff --git a/cmd/workspace/grants/grants.go b/cmd/workspace/grants/grants.go index fef4b74614..b1fc93f926 100755 --- a/cmd/workspace/grants/grants.go +++ b/cmd/workspace/grants/grants.go @@ -24,7 +24,7 @@ func New() *cobra.Command { owner of an object, or the owner of the catalog or schema that contains the object. Securable objects in Unity Catalog are hierarchical and privileges are inherited downward. - + Securable objects in Unity Catalog are hierarchical and privileges are inherited downward. This means that granting a privilege on the catalog automatically grants the privilege to all current and future objects within @@ -71,12 +71,12 @@ func newGet() *cobra.Command { cmd.Use = "get SECURABLE_TYPE FULL_NAME" cmd.Short = `Get permissions.` cmd.Long = `Get permissions. - + Gets the permissions for a securable. Does not include inherited permissions. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -141,13 +141,13 @@ func newGetEffective() *cobra.Command { cmd.Use = "get-effective SECURABLE_TYPE FULL_NAME" cmd.Short = `Get effective permissions.` cmd.Long = `Get effective permissions. - + Gets the effective permissions for a securable. Includes inherited permissions from any parent securables. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -213,7 +213,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update SECURABLE_TYPE FULL_NAME" cmd.Short = `Update permissions.` cmd.Long = `Update permissions. - + Updates the permissions for a securable. Arguments: diff --git a/cmd/workspace/groups-v2/groups-v2.go b/cmd/workspace/groups-v2/groups-v2.go index 580e5d1952..e27280b8b7 100755 --- a/cmd/workspace/groups-v2/groups-v2.go +++ b/cmd/workspace/groups-v2/groups-v2.go @@ -21,7 +21,7 @@ func New() *cobra.Command { Short: `Groups simplify identity management, making it easier to assign access to Databricks workspace, data, and other securable objects.`, Long: `Groups simplify identity management, making it easier to assign access to Databricks workspace, data, and other securable objects. - + It is best practice to assign access to workspaces and access-control policies in Unity Catalog to groups, instead of to users individually. All Databricks workspace identities can be assigned as members of groups, and members inherit @@ -79,7 +79,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new group.` cmd.Long = `Create a new group. - + Creates a group in the Databricks workspace with a unique name, using the supplied group details.` @@ -144,7 +144,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a group.` cmd.Long = `Delete a group. - + Deletes a group from the Databricks workspace. Arguments: @@ -200,7 +200,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get group details.` cmd.Long = `Get group details. - + Gets the information for a specific group in the Databricks workspace. Arguments: @@ -264,7 +264,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List group details.` cmd.Long = `List group details. - + Gets all details of the groups associated with the Databricks workspace.` cmd.Annotations = make(map[string]string) @@ -318,7 +318,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update group details.` cmd.Long = `Update group details. - + Partially updates the details of a group. Arguments: @@ -398,7 +398,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace a group.` cmd.Long = `Replace a group. - + Updates the details of a group by replacing the entire group entity. Arguments: diff --git a/cmd/workspace/groups/groups.go b/cmd/workspace/groups/groups.go index c792c35a29..0206298884 100755 --- a/cmd/workspace/groups/groups.go +++ b/cmd/workspace/groups/groups.go @@ -23,7 +23,7 @@ func New() *cobra.Command { Short: `Groups simplify identity management, making it easier to assign access to Databricks workspace, data, and other securable objects.`, Long: `Groups simplify identity management, making it easier to assign access to Databricks workspace, data, and other securable objects. - + It is best practice to assign access to workspaces and access-control policies in Unity Catalog to groups, instead of to users individually. All Databricks workspace identities can be assigned as members of groups, and members inherit @@ -81,7 +81,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new group.` cmd.Long = `Create a new group. - + Creates a group in the Databricks workspace with a unique name, using the supplied group details.` @@ -146,7 +146,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a group.` cmd.Long = `Delete a group. - + Deletes a group from the Databricks workspace. Arguments: @@ -214,7 +214,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get group details.` cmd.Long = `Get group details. - + Gets the information for a specific group in the Databricks workspace. Arguments: @@ -290,7 +290,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List group details.` cmd.Long = `List group details. - + Gets all details of the groups associated with the Databricks workspace.` cmd.Annotations = make(map[string]string) @@ -344,7 +344,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update group details.` cmd.Long = `Update group details. - + Partially updates the details of a group. Arguments: @@ -437,7 +437,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace a group.` cmd.Long = `Replace a group. - + Updates the details of a group by replacing the entire group entity. Arguments: diff --git a/cmd/workspace/instance-pools/instance-pools.go b/cmd/workspace/instance-pools/instance-pools.go index 7e6d69b320..52d4a1153c 100755 --- a/cmd/workspace/instance-pools/instance-pools.go +++ b/cmd/workspace/instance-pools/instance-pools.go @@ -24,7 +24,7 @@ func New() *cobra.Command { Long: `Instance Pools API are used to create, edit, delete and list instance pools by using ready-to-use cloud instances which reduces a cluster start and auto-scaling times. - + Databricks pools reduce cluster start and auto-scaling times by maintaining a set of idle, ready-to-use instances. When a cluster is attached to a pool, cluster nodes are created using the pool’s idle instances. If the pool has @@ -33,10 +33,10 @@ func New() *cobra.Command { cluster releases an instance, it returns to the pool and is free for another cluster to use. Only clusters attached to a pool can use that pool’s idle instances. - + You can specify a different pool for the driver node and worker nodes, or use the same pool for both. - + Databricks does not charge DBUs while instances are idle in the pool. Instance provider billing does apply. See pricing.`, GroupID: "compute", @@ -99,7 +99,7 @@ func newCreate() *cobra.Command { cmd.Use = "create INSTANCE_POOL_NAME NODE_TYPE_ID" cmd.Short = `Create a new instance pool.` cmd.Long = `Create a new instance pool. - + Creates a new instance pool using idle and ready-to-use cloud instances. Arguments: @@ -188,7 +188,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete INSTANCE_POOL_ID" cmd.Short = `Delete an instance pool.` cmd.Long = `Delete an instance pool. - + Deletes the instance pool permanently. The idle instances in the pool are terminated asynchronously. @@ -291,7 +291,7 @@ func newEdit() *cobra.Command { cmd.Use = "edit INSTANCE_POOL_ID INSTANCE_POOL_NAME NODE_TYPE_ID" cmd.Short = `Edit an existing instance pool.` cmd.Long = `Edit an existing instance pool. - + Modifies the configuration of an existing instance pool. Arguments: @@ -381,7 +381,7 @@ func newGet() *cobra.Command { cmd.Use = "get INSTANCE_POOL_ID" cmd.Short = `Get instance pool information.` cmd.Long = `Get instance pool information. - + Retrieve the information for an instance pool based on its identifier. Arguments: @@ -449,7 +449,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels INSTANCE_POOL_ID" cmd.Short = `Get instance pool permission levels.` cmd.Long = `Get instance pool permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -517,7 +517,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions INSTANCE_POOL_ID" cmd.Short = `Get instance pool permissions.` cmd.Long = `Get instance pool permissions. - + Gets the permissions of an instance pool. Instance pools can inherit permissions from their root object. @@ -583,7 +583,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List instance pool info.` cmd.Long = `List instance pool info. - + Gets a list of instance pools with their statistics.` cmd.Annotations = make(map[string]string) @@ -630,7 +630,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions INSTANCE_POOL_ID" cmd.Short = `Set instance pool permissions.` cmd.Long = `Set instance pool permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -717,7 +717,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions INSTANCE_POOL_ID" cmd.Short = `Update instance pool permissions.` cmd.Long = `Update instance pool permissions. - + Updates the permissions on an instance pool. Instance pools can inherit permissions from their root object. diff --git a/cmd/workspace/instance-profiles/instance-profiles.go b/cmd/workspace/instance-profiles/instance-profiles.go index dfbefe934f..4edfa3df95 100755 --- a/cmd/workspace/instance-profiles/instance-profiles.go +++ b/cmd/workspace/instance-profiles/instance-profiles.go @@ -25,7 +25,7 @@ func New() *cobra.Command { profiles that users can launch clusters with. Regular users can list the instance profiles available to them. See [Secure access to S3 buckets] using instance profiles for more information. - + [Secure access to S3 buckets]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/instance-profiles.html`, GroupID: "compute", Annotations: map[string]string{ @@ -72,10 +72,10 @@ func newAdd() *cobra.Command { cmd.Use = "add INSTANCE_PROFILE_ARN" cmd.Short = `Register an instance profile.` cmd.Long = `Register an instance profile. - + Registers an instance profile in Databricks. In the UI, you can then give users the permission to use this instance profile when launching clusters. - + This API is only available to admin users. Arguments: @@ -159,20 +159,20 @@ func newEdit() *cobra.Command { cmd.Use = "edit INSTANCE_PROFILE_ARN" cmd.Short = `Edit an instance profile.` cmd.Long = `Edit an instance profile. - + The only supported field to change is the optional IAM role ARN associated with the instance profile. It is required to specify the IAM role ARN if both of the following are true: - + * Your role name and instance profile name do not match. The name is the part after the last slash in each ARN. * You want to use the instance profile with [Databricks SQL Serverless]. - + To understand where these fields are in the AWS console, see [Enable serverless SQL warehouses]. - + This API is only available to admin users. - + [Databricks SQL Serverless]: https://docs.databricks.com/sql/admin/serverless.html [Enable serverless SQL warehouses]: https://docs.databricks.com/sql/admin/serverless.html @@ -248,9 +248,9 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List available instance profiles.` cmd.Long = `List available instance profiles. - + List the instance profiles that the calling user can use to launch a cluster. - + This API is available to all users.` cmd.Annotations = make(map[string]string) @@ -295,10 +295,10 @@ func newRemove() *cobra.Command { cmd.Use = "remove INSTANCE_PROFILE_ARN" cmd.Short = `Remove the instance profile.` cmd.Long = `Remove the instance profile. - + Remove the instance profile with the provided ARN. Existing clusters with this instance profile will continue to function. - + This API is only accessible to admin users. Arguments: diff --git a/cmd/workspace/ip-access-lists/ip-access-lists.go b/cmd/workspace/ip-access-lists/ip-access-lists.go index d29d7b98c4..88347bdc75 100755 --- a/cmd/workspace/ip-access-lists/ip-access-lists.go +++ b/cmd/workspace/ip-access-lists/ip-access-lists.go @@ -22,24 +22,24 @@ func New() *cobra.Command { Use: "ip-access-lists", Short: `IP Access List enables admins to configure IP access lists.`, Long: `IP Access List enables admins to configure IP access lists. - + IP access lists affect web application access and REST API access to this workspace only. If the feature is disabled for a workspace, all access is allowed for this workspace. There is support for allow lists (inclusion) and block lists (exclusion). - + When a connection is attempted: 1. **First, all block lists are checked.** If the connection IP address matches any block list, the connection is rejected. 2. **If the connection was not rejected by block lists**, the IP address is compared with the allow lists. - + If there is at least one allow list for the workspace, the connection is allowed only if the IP address matches an allow list. If there are no allow lists for the workspace, all IP addresses are allowed. - + For all allow lists and block lists combined, the workspace supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. - + After changes to the IP access list feature, it can take a few minutes for changes to take effect.`, GroupID: "settings", @@ -87,27 +87,27 @@ func newCreate() *cobra.Command { cmd.Use = "create LABEL LIST_TYPE" cmd.Short = `Create access list.` cmd.Long = `Create access list. - + Creates an IP access list for this workspace. - + A list can be an allow list or a block list. See the top of this file for a description of how the server treats allow lists and block lists at runtime. - + When creating or updating an IP access list: - + * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number return error 400 with error_code value QUOTA_EXCEEDED. * If the new list would block the calling user's current IP, error 400 is returned with error_code value INVALID_STATE. - + It can take a few minutes for the changes to take effect. **Note**: Your new IP access list has no effect until you enable the feature. See :method:workspaceconf/setStatus Arguments: LABEL: Label for the IP access list. This **cannot** be empty. - LIST_TYPE: + LIST_TYPE: Supported values: [ALLOW, BLOCK]` cmd.Annotations = make(map[string]string) @@ -188,7 +188,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete IP_ACCESS_LIST_ID" cmd.Short = `Delete access list.` cmd.Long = `Delete access list. - + Deletes an IP access list, specified by its list ID. Arguments: @@ -256,7 +256,7 @@ func newGet() *cobra.Command { cmd.Use = "get IP_ACCESS_LIST_ID" cmd.Short = `Get access list.` cmd.Long = `Get access list. - + Gets an IP access list, specified by its list ID. Arguments: @@ -321,7 +321,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get access lists.` cmd.Long = `Get access lists. - + Gets all IP access lists for the specified workspace.` cmd.Annotations = make(map[string]string) @@ -368,9 +368,9 @@ func newReplace() *cobra.Command { cmd.Use = "replace IP_ACCESS_LIST_ID LABEL LIST_TYPE ENABLED" cmd.Short = `Replace access list.` cmd.Long = `Replace access list. - + Replaces an IP access list, specified by its ID. - + A list can include allow lists and block lists. See the top of this file for a description of how the server treats allow lists and block lists at run time. When replacing an IP access list: * For all allow lists and block lists @@ -385,7 +385,7 @@ func newReplace() *cobra.Command { Arguments: IP_ACCESS_LIST_ID: The ID for the corresponding IP access list LABEL: Label for the IP access list. This **cannot** be empty. - LIST_TYPE: + LIST_TYPE: Supported values: [ALLOW, BLOCK] ENABLED: Specifies whether this IP access list is enabled.` @@ -483,20 +483,20 @@ func newUpdate() *cobra.Command { cmd.Use = "update IP_ACCESS_LIST_ID" cmd.Short = `Update access list.` cmd.Long = `Update access list. - + Updates an existing IP access list, specified by its ID. - + A list can include allow lists and block lists. See the top of this file for a description of how the server treats allow lists and block lists at run time. - + When updating an IP access list: - + * For all allow lists and block lists combined, the API supports a maximum of 1000 IP/CIDR values, where one CIDR counts as a single value. Attempts to exceed that number return error 400 with error_code value QUOTA_EXCEEDED. * If the updated list would block the calling user's current IP, error 400 is returned with error_code value INVALID_STATE. - + It can take a few minutes for the changes to take effect. Note that your resulting IP access list has no effect until you enable the feature. See :method:workspaceconf/setStatus. diff --git a/cmd/workspace/jobs/jobs.go b/cmd/workspace/jobs/jobs.go index 6a6ae772b2..c38c5be1ed 100755 --- a/cmd/workspace/jobs/jobs.go +++ b/cmd/workspace/jobs/jobs.go @@ -23,7 +23,7 @@ func New() *cobra.Command { Use: "jobs", Short: `The Jobs API allows you to create, edit, and delete jobs.`, Long: `The Jobs API allows you to create, edit, and delete jobs. - + You can use a Databricks job to run a data processing or data analysis task in a Databricks cluster with scalable resources. Your job can consist of a single task or can be a large, multi-task workflow with complex dependencies. @@ -32,11 +32,11 @@ func New() *cobra.Command { periodically through an easy-to-use scheduling system. You can implement job tasks using notebooks, JARS, Delta Live Tables pipelines, or Python, Scala, Spark submit, and Java applications. - + You should never hard code secrets or store them in plain text. Use the [Secrets CLI] to manage secrets in the [Databricks CLI]. Use the [Secrets utility] to reference secrets in notebooks and jobs. - + [Databricks CLI]: https://docs.databricks.com/dev-tools/cli/index.html [Secrets CLI]: https://docs.databricks.com/dev-tools/cli/secrets-cli.html [Secrets utility]: https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-secrets`, @@ -100,7 +100,7 @@ func newCancelAllRuns() *cobra.Command { cmd.Use = "cancel-all-runs" cmd.Short = `Cancel all runs of a job.` cmd.Long = `Cancel all runs of a job. - + Cancels all active runs of a job. The runs are canceled asynchronously, so it doesn't prevent new runs from being started.` @@ -174,7 +174,7 @@ func newCancelRun() *cobra.Command { cmd.Use = "cancel-run RUN_ID" cmd.Short = `Cancel a run.` cmd.Long = `Cancel a run. - + Cancels a job run or a task run. The run is canceled asynchronously, so it may still be running when this request completes. @@ -355,7 +355,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete JOB_ID" cmd.Short = `Delete a job.` cmd.Long = `Delete a job. - + Deletes a job. Arguments: @@ -454,7 +454,7 @@ func newDeleteRun() *cobra.Command { cmd.Use = "delete-run RUN_ID" cmd.Short = `Delete a job run.` cmd.Long = `Delete a job run. - + Deletes a non-active run. Returns an error if the run is active. Arguments: @@ -552,7 +552,7 @@ func newExportRun() *cobra.Command { cmd.Use = "export-run RUN_ID" cmd.Short = `Export and retrieve a job run.` cmd.Long = `Export and retrieve a job run. - + Export and retrieve the job run task. Arguments: @@ -625,9 +625,9 @@ func newGet() *cobra.Command { cmd.Use = "get JOB_ID" cmd.Short = `Get a single job.` cmd.Long = `Get a single job. - + Retrieves the details for a single job. - + Large arrays in the results will be paginated when they exceed 100 elements. A request for a single job will return all properties for that job, and the first 100 elements of array properties (tasks, job_clusters, @@ -706,7 +706,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels JOB_ID" cmd.Short = `Get job permission levels.` cmd.Long = `Get job permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -774,7 +774,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions JOB_ID" cmd.Short = `Get job permissions.` cmd.Long = `Get job permissions. - + Gets the permissions of a job. Jobs can inherit permissions from their root object. @@ -847,9 +847,9 @@ func newGetRun() *cobra.Command { cmd.Use = "get-run RUN_ID" cmd.Short = `Get a single job run.` cmd.Long = `Get a single job run. - + Retrieves the metadata of a run. - + Large arrays in the results will be paginated when they exceed 100 elements. A request for a single run will return all properties for that run, and the first 100 elements of array properties (tasks, job_clusters, @@ -928,13 +928,13 @@ func newGetRunOutput() *cobra.Command { cmd.Use = "get-run-output RUN_ID" cmd.Short = `Get the output for a single run.` cmd.Long = `Get the output for a single run. - + Retrieve the output and metadata of a single task run. When a notebook task returns a value through the dbutils.notebook.exit() call, you can use this endpoint to retrieve that value. Databricks restricts this API to returning the first 5 MB of the output. To return a larger result, you can store job results in a cloud storage service. - + This endpoint validates that the __run_id__ parameter is valid and returns an HTTP status code 400 if the __run_id__ parameter is invalid. Runs are automatically removed after 60 days. If you to want to reference them beyond @@ -1014,7 +1014,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List jobs.` cmd.Long = `List jobs. - + Retrieves a list of jobs.` cmd.Annotations = make(map[string]string) @@ -1073,7 +1073,7 @@ func newListRuns() *cobra.Command { cmd.Use = "list-runs" cmd.Short = `List job runs.` cmd.Long = `List job runs. - + List runs in descending order by start time.` cmd.Annotations = make(map[string]string) @@ -1145,7 +1145,7 @@ func newRepairRun() *cobra.Command { cmd.Use = "repair-run RUN_ID" cmd.Short = `Repair a job run.` cmd.Long = `Repair a job run. - + Re-run one or more tasks. Tasks are re-run as part of the original job run. They use the current job and task settings, and can be viewed in the history for the original job run. @@ -1265,7 +1265,7 @@ func newReset() *cobra.Command { cmd.Use = "reset" cmd.Short = `Update all job settings (reset).` cmd.Long = `Update all job settings (reset). - + Overwrite all settings for the given job. Use the [_Update_ endpoint](:method:jobs/update) to update job settings partially.` @@ -1350,7 +1350,7 @@ func newRunNow() *cobra.Command { cmd.Use = "run-now JOB_ID" cmd.Short = `Trigger a new job run.` cmd.Long = `Trigger a new job run. - + Run a job and return the run_id of the triggered run. Arguments: @@ -1470,7 +1470,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions JOB_ID" cmd.Short = `Set job permissions.` cmd.Long = `Set job permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -1577,7 +1577,7 @@ func newSubmit() *cobra.Command { cmd.Use = "submit" cmd.Short = `Create and trigger a one-time run.` cmd.Long = `Create and trigger a one-time run. - + Submit a one-time run. This endpoint allows you to submit a workload directly without creating a job. Runs submitted using this endpoint don’t display in the UI. Use the jobs/runs/get API to check the run state after the job is @@ -1669,7 +1669,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update JOB_ID" cmd.Short = `Update job settings partially.` cmd.Long = `Update job settings partially. - + Add, update, or remove specific settings of an existing job. Use the [_Reset_ endpoint](:method:jobs/reset) to overwrite all job settings. @@ -1771,7 +1771,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions JOB_ID" cmd.Short = `Update job permissions.` cmd.Long = `Update job permissions. - + Updates the permissions on a job. Jobs can inherit permissions from their root object. diff --git a/cmd/workspace/lakeview-embedded/lakeview-embedded.go b/cmd/workspace/lakeview-embedded/lakeview-embedded.go index 5700d23645..224d3948e5 100755 --- a/cmd/workspace/lakeview-embedded/lakeview-embedded.go +++ b/cmd/workspace/lakeview-embedded/lakeview-embedded.go @@ -57,7 +57,7 @@ func newGetPublishedDashboardTokenInfo() *cobra.Command { cmd.Use = "get-published-dashboard-token-info DASHBOARD_ID" cmd.Short = `Read information of a published dashboard to mint an OAuth token.` cmd.Long = `Read information of a published dashboard to mint an OAuth token. - + Get a required authorization details and scopes of a published dashboard to mint an OAuth token. diff --git a/cmd/workspace/lakeview/lakeview.go b/cmd/workspace/lakeview/lakeview.go index b3b0997855..e39317f460 100755 --- a/cmd/workspace/lakeview/lakeview.go +++ b/cmd/workspace/lakeview/lakeview.go @@ -84,7 +84,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create dashboard.` cmd.Long = `Create dashboard. - + Create a draft dashboard.` cmd.Annotations = make(map[string]string) @@ -444,7 +444,7 @@ func newGet() *cobra.Command { cmd.Use = "get DASHBOARD_ID" cmd.Short = `Get dashboard.` cmd.Long = `Get dashboard. - + Get a draft dashboard. Arguments: @@ -500,7 +500,7 @@ func newGetPublished() *cobra.Command { cmd.Use = "get-published DASHBOARD_ID" cmd.Short = `Get published dashboard.` cmd.Long = `Get published dashboard. - + Get the current published dashboard. Arguments: @@ -838,7 +838,7 @@ func newMigrate() *cobra.Command { cmd.Use = "migrate SOURCE_DASHBOARD_ID" cmd.Short = `Migrate dashboard.` cmd.Long = `Migrate dashboard. - + Migrates a classic SQL dashboard to Lakeview. Arguments: @@ -921,7 +921,7 @@ func newPublish() *cobra.Command { cmd.Use = "publish DASHBOARD_ID" cmd.Short = `Publish dashboard.` cmd.Long = `Publish dashboard. - + Publish the current draft dashboard. Arguments: @@ -989,7 +989,7 @@ func newTrash() *cobra.Command { cmd.Use = "trash DASHBOARD_ID" cmd.Short = `Trash dashboard.` cmd.Long = `Trash dashboard. - + Trash a dashboard. Arguments: @@ -1045,7 +1045,7 @@ func newUnpublish() *cobra.Command { cmd.Use = "unpublish DASHBOARD_ID" cmd.Short = `Unpublish dashboard.` cmd.Long = `Unpublish dashboard. - + Unpublish the dashboard. Arguments: @@ -1109,7 +1109,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update DASHBOARD_ID" cmd.Short = `Update dashboard.` cmd.Long = `Update dashboard. - + Update a draft dashboard. Arguments: diff --git a/cmd/workspace/libraries/libraries.go b/cmd/workspace/libraries/libraries.go index 8599ba0057..72093a230f 100755 --- a/cmd/workspace/libraries/libraries.go +++ b/cmd/workspace/libraries/libraries.go @@ -23,17 +23,17 @@ func New() *cobra.Command { Short: `The Libraries API allows you to install and uninstall libraries and get the status of libraries on a cluster.`, Long: `The Libraries API allows you to install and uninstall libraries and get the status of libraries on a cluster. - + To make third-party or custom code available to notebooks and jobs running on your clusters, you can install a library. Libraries can be written in Python, Java, Scala, and R. You can upload Python, Java, Scala and R libraries and point to external packages in PyPI, Maven, and CRAN repositories. - + Cluster libraries can be used by all notebooks running on a cluster. You can install a cluster library directly from a public repository such as PyPI or Maven, using a previously installed workspace library, or using an init script. - + When you uninstall a library from a cluster, the library is removed only when you restart the cluster. Until you restart the cluster, the status of the uninstalled library appears as Uninstall pending restart.`, @@ -72,7 +72,7 @@ func newAllClusterStatuses() *cobra.Command { cmd.Use = "all-cluster-statuses" cmd.Short = `Get all statuses.` cmd.Long = `Get all statuses. - + Get the status of all libraries on all clusters. A status is returned for all libraries installed on this cluster via the API or the libraries UI.` @@ -115,7 +115,7 @@ func newClusterStatus() *cobra.Command { cmd.Use = "cluster-status CLUSTER_ID" cmd.Short = `Get status.` cmd.Long = `Get status. - + Get the status of libraries on a cluster. A status is returned for all libraries installed on this cluster via the API or the libraries UI. The order of returned libraries is as follows: 1. Libraries set to be installed on this @@ -177,7 +177,7 @@ func newInstall() *cobra.Command { cmd.Use = "install" cmd.Short = `Add a library.` cmd.Long = `Add a library. - + Add libraries to install on a cluster. The installation is asynchronous; it happens in the background after the completion of this request.` @@ -242,7 +242,7 @@ func newUninstall() *cobra.Command { cmd.Use = "uninstall" cmd.Short = `Uninstall libraries.` cmd.Long = `Uninstall libraries. - + Set libraries to uninstall from a cluster. The libraries won't be uninstalled until the cluster is restarted. A request to uninstall a library that is not currently installed is ignored.` diff --git a/cmd/workspace/llm-proxy-partner-powered-workspace/llm-proxy-partner-powered-workspace.go b/cmd/workspace/llm-proxy-partner-powered-workspace/llm-proxy-partner-powered-workspace.go index 7faa64c2f7..47113e899a 100755 --- a/cmd/workspace/llm-proxy-partner-powered-workspace/llm-proxy-partner-powered-workspace.go +++ b/cmd/workspace/llm-proxy-partner-powered-workspace/llm-proxy-partner-powered-workspace.go @@ -61,7 +61,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete the enable partner powered AI features workspace setting.` cmd.Long = `Delete the enable partner powered AI features workspace setting. - + Reverts the enable partner powered AI features workspace setting to its default value.` @@ -115,7 +115,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the enable partner powered AI features workspace setting.` cmd.Long = `Get the enable partner powered AI features workspace setting. - + Gets the enable partner powered AI features workspace setting.` cmd.Annotations = make(map[string]string) @@ -169,7 +169,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the enable partner powered AI features workspace setting.` cmd.Long = `Update the enable partner powered AI features workspace setting. - + Updates the enable partner powered AI features workspace setting.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/materialized-features/materialized-features.go b/cmd/workspace/materialized-features/materialized-features.go index cec625c8e0..976748e02f 100755 --- a/cmd/workspace/materialized-features/materialized-features.go +++ b/cmd/workspace/materialized-features/materialized-features.go @@ -72,7 +72,7 @@ func newCreateFeatureTag() *cobra.Command { cmd.Use = "create-feature-tag TABLE_NAME FEATURE_NAME KEY" cmd.Short = `Create a feature tag.` cmd.Long = `Create a feature tag. - + Creates a FeatureTag.` cmd.Annotations = make(map[string]string) @@ -148,7 +148,7 @@ func newDeleteFeatureTag() *cobra.Command { cmd.Use = "delete-feature-tag TABLE_NAME FEATURE_NAME KEY" cmd.Short = `Delete a feature tag.` cmd.Long = `Delete a feature tag. - + Deletes a FeatureTag. Arguments: @@ -264,7 +264,7 @@ func newGetFeatureTag() *cobra.Command { cmd.Use = "get-feature-tag TABLE_NAME FEATURE_NAME KEY" cmd.Short = `Get a feature tag.` cmd.Long = `Get a feature tag. - + Gets a FeatureTag.` cmd.Annotations = make(map[string]string) @@ -322,7 +322,7 @@ func newListFeatureTags() *cobra.Command { cmd.Use = "list-feature-tags TABLE_NAME FEATURE_NAME" cmd.Short = `List all feature tags.` cmd.Long = `List all feature tags. - + Lists FeatureTags.` cmd.Annotations = make(map[string]string) @@ -380,7 +380,7 @@ func newUpdateFeatureTag() *cobra.Command { cmd.Use = "update-feature-tag TABLE_NAME FEATURE_NAME KEY" cmd.Short = `Update a feature tag.` cmd.Long = `Update a feature tag. - + Updates a FeatureTag.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/metastores/metastores.go b/cmd/workspace/metastores/metastores.go index a407975d6f..53494de6bc 100755 --- a/cmd/workspace/metastores/metastores.go +++ b/cmd/workspace/metastores/metastores.go @@ -26,10 +26,10 @@ func New() *cobra.Command { Databricks account admins can create metastores and assign them to Databricks workspaces to control which workloads use each metastore. For a workspace to use Unity Catalog, it must have a Unity Catalog metastore attached. - + Each metastore is configured with a root storage location in a cloud storage account. This storage location is used for metadata and managed tables data. - + NOTE: This metastore is distinct from the metastore included in Databricks workspaces created before Unity Catalog was released. If your workspace includes a legacy Hive metastore, the data in that metastore is available in a @@ -81,7 +81,7 @@ func newAssign() *cobra.Command { cmd.Use = "assign WORKSPACE_ID METASTORE_ID DEFAULT_CATALOG_NAME" cmd.Short = `Create an assignment.` cmd.Long = `Create an assignment. - + Creates a new metastore assignment. If an assignment for the same __workspace_id__ exists, it will be overwritten by the new __metastore_id__ and __default_catalog_name__. The caller must be an account admin. @@ -178,7 +178,7 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME" cmd.Short = `Create a metastore.` cmd.Long = `Create a metastore. - + Creates a new metastore based on a provided name and optional storage root path. By default (if the __owner__ field is not set), the owner of the new metastore is the user calling the __createMetastore__ API. If the __owner__ @@ -256,7 +256,7 @@ func newCurrent() *cobra.Command { cmd.Use = "current" cmd.Short = `Get metastore assignment for workspace.` cmd.Long = `Get metastore assignment for workspace. - + Gets the metastore assignment for the workspace being accessed.` cmd.Annotations = make(map[string]string) @@ -303,7 +303,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a metastore.` cmd.Long = `Delete a metastore. - + Deletes a metastore. The caller must be a metastore admin. Arguments: @@ -359,7 +359,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get a metastore.` cmd.Long = `Get a metastore. - + Gets a metastore that matches the supplied ID. The caller must be a metastore admin to retrieve this info. @@ -419,14 +419,14 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List metastores.` cmd.Long = `List metastores. - + Gets an array of the available metastores (as __MetastoreInfo__ objects). The caller must be an admin to retrieve this info. There is no guarantee of a specific ordering of the elements in the array. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -474,7 +474,7 @@ func newSummary() *cobra.Command { cmd.Use = "summary" cmd.Short = `Get a metastore summary.` cmd.Long = `Get a metastore summary. - + Gets information about a metastore. This summary includes the storage credential, the cloud vendor, the cloud region, and the global metastore ID.` @@ -520,7 +520,7 @@ func newUnassign() *cobra.Command { cmd.Use = "unassign WORKSPACE_ID METASTORE_ID" cmd.Short = `Delete an assignment.` cmd.Long = `Delete an assignment. - + Deletes a metastore assignment. The caller must be an account administrator. Arguments: @@ -593,7 +593,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Update a metastore.` cmd.Long = `Update a metastore. - + Updates information for a specific metastore. The caller must be a metastore admin. If the __owner__ field is set to the empty string (**""**), the ownership is updated to the System User. @@ -669,7 +669,7 @@ func newUpdateAssignment() *cobra.Command { cmd.Use = "update-assignment WORKSPACE_ID" cmd.Short = `Update an assignment.` cmd.Long = `Update an assignment. - + Updates a metastore assignment. This operation can be used to update __metastore_id__ or __default_catalog_name__ for a specified Workspace, if the Workspace is already assigned a metastore. The caller must be an account admin diff --git a/cmd/workspace/model-registry/model-registry.go b/cmd/workspace/model-registry/model-registry.go index 8340a80cc9..ad326f1494 100755 --- a/cmd/workspace/model-registry/model-registry.go +++ b/cmd/workspace/model-registry/model-registry.go @@ -26,7 +26,7 @@ func New() *cobra.Command { Catalog](/api/workspace/registeredmodels) instead. Models in Unity Catalog provides centralized model governance, cross-workspace access, lineage, and deployment. Workspace Model Registry will be deprecated in the future. - + The Workspace Model Registry is a centralized model repository and a UI and set of APIs that enable you to manage the full lifecycle of MLflow Models.`, GroupID: "ml", @@ -104,20 +104,20 @@ func newApproveTransitionRequest() *cobra.Command { cmd.Use = "approve-transition-request NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS" cmd.Short = `Approve transition request.` cmd.Long = `Approve transition request. - + Approves a model version stage transition request. Arguments: NAME: Name of the model. VERSION: Version of the model. STAGE: Target stage of the transition. Valid values are: - + * None: The initial stage of a model version. - + * Staging: Staging or pre-production stage. - + * Production: Production stage. - + * Archived: Archived stage. ARCHIVE_EXISTING_VERSIONS: Specifies whether to archive all current model versions in the target stage.` @@ -209,7 +209,7 @@ func newCreateComment() *cobra.Command { cmd.Use = "create-comment NAME VERSION COMMENT" cmd.Short = `Post a comment.` cmd.Long = `Post a comment. - + Posts a comment on a model version. A comment can be submitted either by a user or programmatically to display relevant information about the model. For example, test results or deployment errors. @@ -302,7 +302,7 @@ func newCreateModel() *cobra.Command { cmd.Use = "create-model NAME" cmd.Short = `Create a model.` cmd.Long = `Create a model. - + Creates a new registered model with the name specified in the request body. Throws RESOURCE_ALREADY_EXISTS if a registered model with the given name exists. @@ -389,7 +389,7 @@ func newCreateModelVersion() *cobra.Command { cmd.Use = "create-model-version NAME SOURCE" cmd.Short = `Create a model version.` cmd.Long = `Create a model version. - + Creates a model version. Arguments: @@ -475,20 +475,20 @@ func newCreateTransitionRequest() *cobra.Command { cmd.Use = "create-transition-request NAME VERSION STAGE" cmd.Short = `Make a transition request.` cmd.Long = `Make a transition request. - + Creates a model version stage transition request. Arguments: NAME: Name of the model. VERSION: Version of the model. STAGE: Target stage of the transition. Valid values are: - + * None: The initial stage of a model version. - + * Staging: Staging or pre-production stage. - + * Production: Production stage. - + * Archived: Archived stage.` cmd.Annotations = make(map[string]string) @@ -577,7 +577,7 @@ func newCreateWebhook() *cobra.Command { cmd.Use = "create-webhook" cmd.Short = `Create a webhook.` cmd.Long = `Create a webhook. - + **NOTE:** This endpoint is in Public Preview. Creates a registry webhook.` cmd.Annotations = make(map[string]string) @@ -638,7 +638,7 @@ func newDeleteComment() *cobra.Command { cmd.Use = "delete-comment ID" cmd.Short = `Delete a comment.` cmd.Long = `Delete a comment. - + Deletes a comment on a model version. Arguments: @@ -694,7 +694,7 @@ func newDeleteModel() *cobra.Command { cmd.Use = "delete-model NAME" cmd.Short = `Delete a model.` cmd.Long = `Delete a model. - + Deletes a registered model. Arguments: @@ -750,7 +750,7 @@ func newDeleteModelTag() *cobra.Command { cmd.Use = "delete-model-tag NAME KEY" cmd.Short = `Delete a model tag.` cmd.Long = `Delete a model tag. - + Deletes the tag for a registered model. Arguments: @@ -809,7 +809,7 @@ func newDeleteModelVersion() *cobra.Command { cmd.Use = "delete-model-version NAME VERSION" cmd.Short = `Delete a model version.` cmd.Long = `Delete a model version. - + Deletes a model version. Arguments: @@ -867,7 +867,7 @@ func newDeleteModelVersionTag() *cobra.Command { cmd.Use = "delete-model-version-tag NAME VERSION KEY" cmd.Short = `Delete a model version tag.` cmd.Long = `Delete a model version tag. - + Deletes a model version tag. Arguments: @@ -930,20 +930,20 @@ func newDeleteTransitionRequest() *cobra.Command { cmd.Use = "delete-transition-request NAME VERSION STAGE CREATOR" cmd.Short = `Delete a transition request.` cmd.Long = `Delete a transition request. - + Cancels a model version stage transition request. Arguments: NAME: Name of the model. VERSION: Version of the model. STAGE: Target stage of the transition request. Valid values are: - + * None: The initial stage of a model version. - + * Staging: Staging or pre-production stage. - + * Production: Production stage. - + * Archived: Archived stage. CREATOR: Username of the user who created this request. Of the transition requests matching the specified details, only the one transition created by this @@ -1002,7 +1002,7 @@ func newDeleteWebhook() *cobra.Command { cmd.Use = "delete-webhook ID" cmd.Short = `Delete a webhook.` cmd.Long = `Delete a webhook. - + **NOTE:** This endpoint is in Public Preview. Deletes a registry webhook. Arguments: @@ -1063,7 +1063,7 @@ func newGetLatestVersions() *cobra.Command { cmd.Use = "get-latest-versions NAME" cmd.Short = `Get the latest version.` cmd.Long = `Get the latest version. - + Gets the latest version of a registered model. Arguments: @@ -1137,11 +1137,11 @@ func newGetModel() *cobra.Command { cmd.Use = "get-model NAME" cmd.Short = `Get model.` cmd.Long = `Get model. - + Get the details of a model. This is a Databricks workspace version of the [MLflow endpoint] that also returns the model's Databricks workspace ID and the permission level of the requesting user on the model. - + [MLflow endpoint]: https://www.mlflow.org/docs/latest/rest-api.html#get-registeredmodel Arguments: @@ -1253,7 +1253,7 @@ func newGetModelVersionDownloadUri() *cobra.Command { cmd.Use = "get-model-version-download-uri NAME VERSION" cmd.Short = `Get a model version URI.` cmd.Long = `Get a model version URI. - + Gets a URI to download the model version. Arguments: @@ -1311,7 +1311,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels REGISTERED_MODEL_ID" cmd.Short = `Get registered model permission levels.` cmd.Long = `Get registered model permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -1367,7 +1367,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions REGISTERED_MODEL_ID" cmd.Short = `Get registered model permissions.` cmd.Long = `Get registered model permissions. - + Gets the permissions of a registered model. Registered models can inherit permissions from their root object. @@ -1427,7 +1427,7 @@ func newListModels() *cobra.Command { cmd.Use = "list-models" cmd.Short = `List models.` cmd.Long = `List models. - + Lists all available registered models, up to the limit specified in __max_results__.` @@ -1476,7 +1476,7 @@ func newListTransitionRequests() *cobra.Command { cmd.Use = "list-transition-requests NAME VERSION" cmd.Short = `List transition requests.` cmd.Long = `List transition requests. - + Gets a list of all open stage transition requests for the model version. Arguments: @@ -1536,7 +1536,7 @@ func newListWebhooks() *cobra.Command { cmd.Use = "list-webhooks" cmd.Short = `List registry webhooks.` cmd.Long = `List registry webhooks. - + **NOTE:** This endpoint is in Public Preview. Lists all registry webhooks.` cmd.Annotations = make(map[string]string) @@ -1589,20 +1589,20 @@ func newRejectTransitionRequest() *cobra.Command { cmd.Use = "reject-transition-request NAME VERSION STAGE" cmd.Short = `Reject a transition request.` cmd.Long = `Reject a transition request. - + Rejects a model version stage transition request. Arguments: NAME: Name of the model. VERSION: Version of the model. STAGE: Target stage of the transition. Valid values are: - + * None: The initial stage of a model version. - + * Staging: Staging or pre-production stage. - + * Production: Production stage. - + * Archived: Archived stage.` cmd.Annotations = make(map[string]string) @@ -1687,7 +1687,7 @@ func newRenameModel() *cobra.Command { cmd.Use = "rename-model NAME" cmd.Short = `Rename a model.` cmd.Long = `Rename a model. - + Renames a registered model. Arguments: @@ -1769,7 +1769,7 @@ func newSearchModelVersions() *cobra.Command { cmd.Use = "search-model-versions" cmd.Short = `Search model versions.` cmd.Long = `Search model versions. - + Searches for specific model versions based on the supplied __filter__.` cmd.Annotations = make(map[string]string) @@ -1822,7 +1822,7 @@ func newSearchModels() *cobra.Command { cmd.Use = "search-models" cmd.Short = `Search models.` cmd.Long = `Search models. - + Search for registered models based on the specified __filter__.` cmd.Annotations = make(map[string]string) @@ -1873,7 +1873,7 @@ func newSetModelTag() *cobra.Command { cmd.Use = "set-model-tag NAME KEY VALUE" cmd.Short = `Set a tag.` cmd.Long = `Set a tag. - + Sets a tag on a registered model. Arguments: @@ -1966,7 +1966,7 @@ func newSetModelVersionTag() *cobra.Command { cmd.Use = "set-model-version-tag NAME VERSION KEY VALUE" cmd.Short = `Set a version tag.` cmd.Long = `Set a version tag. - + Sets a model version tag. Arguments: @@ -2065,7 +2065,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions REGISTERED_MODEL_ID" cmd.Short = `Set registered model permissions.` cmd.Long = `Set registered model permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -2153,7 +2153,7 @@ func newTestRegistryWebhook() *cobra.Command { cmd.Use = "test-registry-webhook ID" cmd.Short = `Test a webhook.` cmd.Long = `Test a webhook. - + **NOTE:** This endpoint is in Public Preview. Tests a registry webhook. Arguments: @@ -2235,24 +2235,24 @@ func newTransitionStage() *cobra.Command { cmd.Use = "transition-stage NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS" cmd.Short = `Transition a stage.` cmd.Long = `Transition a stage. - + Transition a model version's stage. This is a Databricks workspace version of the [MLflow endpoint] that also accepts a comment associated with the transition to be recorded. - + [MLflow endpoint]: https://www.mlflow.org/docs/latest/rest-api.html#transition-modelversion-stage Arguments: NAME: Name of the model. VERSION: Version of the model. STAGE: Target stage of the transition. Valid values are: - + * None: The initial stage of a model version. - + * Staging: Staging or pre-production stage. - + * Production: Production stage. - + * Archived: Archived stage. ARCHIVE_EXISTING_VERSIONS: Specifies whether to archive all current model versions in the target stage.` @@ -2344,7 +2344,7 @@ func newUpdateComment() *cobra.Command { cmd.Use = "update-comment ID COMMENT" cmd.Short = `Update a comment.` cmd.Long = `Update a comment. - + Post an edit to a comment on a model version. Arguments: @@ -2430,7 +2430,7 @@ func newUpdateModel() *cobra.Command { cmd.Use = "update-model NAME" cmd.Short = `Update model.` cmd.Long = `Update model. - + Updates a registered model. Arguments: @@ -2512,7 +2512,7 @@ func newUpdateModelVersion() *cobra.Command { cmd.Use = "update-model-version NAME VERSION" cmd.Short = `Update model version.` cmd.Long = `Update model version. - + Updates the model version. Arguments: @@ -2598,7 +2598,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions REGISTERED_MODEL_ID" cmd.Short = `Update registered model permissions.` cmd.Long = `Update registered model permissions. - + Updates the permissions on a registered model. Registered models can inherit permissions from their root object. @@ -2676,7 +2676,7 @@ func newUpdateWebhook() *cobra.Command { cmd.Use = "update-webhook ID" cmd.Short = `Update a webhook.` cmd.Long = `Update a webhook. - + **NOTE:** This endpoint is in Public Preview. Updates a registry webhook. Arguments: diff --git a/cmd/workspace/model-versions/model-versions.go b/cmd/workspace/model-versions/model-versions.go index 5219bd5f09..0a907dc4b2 100755 --- a/cmd/workspace/model-versions/model-versions.go +++ b/cmd/workspace/model-versions/model-versions.go @@ -24,7 +24,7 @@ func New() *cobra.Command { Long: `Databricks provides a hosted version of MLflow Model Registry in Unity Catalog. Models in Unity Catalog provide centralized access control, auditing, lineage, and discovery of ML models across Databricks workspaces. - + This API reference documents the REST endpoints for managing model versions in Unity Catalog. For more details, see the [registered models API docs](/api/workspace/registeredmodels).`, @@ -67,10 +67,10 @@ func newDelete() *cobra.Command { cmd.Use = "delete FULL_NAME VERSION" cmd.Short = `Delete a Model Version.` cmd.Long = `Delete a Model Version. - + Deletes a model version from the specified registered model. Any aliases assigned to the model version will also be deleted. - + The caller must be a metastore admin or an owner of the parent registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** @@ -137,9 +137,9 @@ func newGet() *cobra.Command { cmd.Use = "get FULL_NAME VERSION" cmd.Short = `Get a Model Version.` cmd.Long = `Get a Model Version. - + Get a model version. - + The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the parent registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent @@ -205,9 +205,9 @@ func newGetByAlias() *cobra.Command { cmd.Use = "get-by-alias FULL_NAME ALIAS" cmd.Short = `Get Model Version By Alias.` cmd.Long = `Get Model Version By Alias. - + Get a model version by alias. - + The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and @@ -272,10 +272,10 @@ func newList() *cobra.Command { cmd.Use = "list FULL_NAME" cmd.Short = `List Model Versions.` cmd.Long = `List Model Versions. - + List model versions. You can list model versions under a particular schema, or list all model versions in the current metastore. - + The returned models are filtered based on the privileges of the calling user. For example, the metastore admin is able to list all the model versions. A regular user needs to be the owner or have the **EXECUTE** privilege on the @@ -283,10 +283,10 @@ func newList() *cobra.Command { latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. - + There is no guarantee of a specific ordering of the elements in the response. The elements in the response will not contain any aliases or tags. - + PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the @@ -364,14 +364,14 @@ func newUpdate() *cobra.Command { cmd.Use = "update FULL_NAME VERSION" cmd.Short = `Update a Model Version.` cmd.Long = `Update a Model Version. - + Updates the specified model version. - + The caller must be a metastore admin or an owner of the parent registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. - + Currently only the comment of the model version can be updated. Arguments: diff --git a/cmd/workspace/notification-destinations/notification-destinations.go b/cmd/workspace/notification-destinations/notification-destinations.go index 785fc7559f..57357d9eaf 100755 --- a/cmd/workspace/notification-destinations/notification-destinations.go +++ b/cmd/workspace/notification-destinations/notification-destinations.go @@ -69,7 +69,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a notification destination.` cmd.Long = `Create a notification destination. - + Creates a notification destination. Requires workspace admin permissions.` cmd.Annotations = make(map[string]string) @@ -133,7 +133,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a notification destination.` cmd.Long = `Delete a notification destination. - + Deletes a notification destination. Requires workspace admin permissions.` cmd.Annotations = make(map[string]string) @@ -186,7 +186,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get a notification destination.` cmd.Long = `Get a notification destination. - + Gets a notification destination.` cmd.Annotations = make(map[string]string) @@ -242,7 +242,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List notification destinations.` cmd.Long = `List notification destinations. - + Lists notification destinations.` cmd.Annotations = make(map[string]string) @@ -296,7 +296,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Update a notification destination.` cmd.Long = `Update a notification destination. - + Updates a notification destination. Requires workspace admin permissions. At least one field is required in the request body. diff --git a/cmd/workspace/online-tables/online-tables.go b/cmd/workspace/online-tables/online-tables.go index 3fd6a5d8b5..ad844dbfcb 100755 --- a/cmd/workspace/online-tables/online-tables.go +++ b/cmd/workspace/online-tables/online-tables.go @@ -75,7 +75,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create an Online Table.` cmd.Long = `Create an Online Table. - + Create a new Online Table.` cmd.Annotations = make(map[string]string) @@ -152,7 +152,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete an Online Table.` cmd.Long = `Delete an Online Table. - + Delete an online table. Warning: This will delete all the data in the online table. If the source Delta table was deleted or modified since this Online Table was created, this will lose the data forever! @@ -210,7 +210,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get an Online Table.` cmd.Long = `Get an Online Table. - + Get information about an existing online table and its status. Arguments: diff --git a/cmd/workspace/permissions/permissions.go b/cmd/workspace/permissions/permissions.go index 413d5a2712..b6634fa3f9 100755 --- a/cmd/workspace/permissions/permissions.go +++ b/cmd/workspace/permissions/permissions.go @@ -48,7 +48,7 @@ func New() *cobra.Command { and other important information, see [Access Control]. Note that to manage access control on service principals, use **[Account Access Control Proxy](:service:accountaccesscontrolproxy)**. - + [Access Control]: https://docs.databricks.com/security/auth-authz/access-control/index.html`, GroupID: "iam", Annotations: map[string]string{ @@ -88,7 +88,7 @@ func newGet() *cobra.Command { cmd.Use = "get REQUEST_OBJECT_TYPE REQUEST_OBJECT_ID" cmd.Short = `Get object permissions.` cmd.Long = `Get object permissions. - + Gets the permissions of an object. Objects can inherit permissions from their parent objects or root object. @@ -151,7 +151,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels REQUEST_OBJECT_TYPE REQUEST_OBJECT_ID" cmd.Short = `Get object permission levels.` cmd.Long = `Get object permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -218,7 +218,7 @@ func newSet() *cobra.Command { cmd.Use = "set REQUEST_OBJECT_TYPE REQUEST_OBJECT_ID" cmd.Short = `Set object permissions.` cmd.Long = `Set object permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their parent objects or root object. @@ -299,7 +299,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update REQUEST_OBJECT_TYPE REQUEST_OBJECT_ID" cmd.Short = `Update object permissions.` cmd.Long = `Update object permissions. - + Updates the permissions on an object. Objects can inherit permissions from their parent objects or root object. diff --git a/cmd/workspace/pipelines/pipelines.go b/cmd/workspace/pipelines/pipelines.go index d58dd5f605..d4c6701815 100755 --- a/cmd/workspace/pipelines/pipelines.go +++ b/cmd/workspace/pipelines/pipelines.go @@ -24,12 +24,12 @@ func New() *cobra.Command { Short: `The Delta Live Tables API allows you to create, edit, delete, start, and view details about pipelines.`, Long: `The Delta Live Tables API allows you to create, edit, delete, start, and view details about pipelines. - + Delta Live Tables is a framework for building reliable, maintainable, and testable data processing pipelines. You define the transformations to perform on your data, and Delta Live Tables manages task orchestration, cluster management, monitoring, data quality, and error handling. - + Instead of defining your data pipelines using a series of separate Apache Spark tasks, Delta Live Tables manages how your data is transformed based on a target schema you define for each processing step. You can also enforce data @@ -87,7 +87,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a pipeline.` cmd.Long = `Create a pipeline. - + Creates a new data processing pipeline based on the requested configuration. If successful, this method returns the ID of the new pipeline.` @@ -149,7 +149,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete PIPELINE_ID" cmd.Short = `Delete a pipeline.` cmd.Long = `Delete a pipeline. - + Deletes a pipeline. Deleting a pipeline is a permanent action that stops and removes the pipeline and its tables. You cannot undo this action.` @@ -278,7 +278,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels PIPELINE_ID" cmd.Short = `Get pipeline permission levels.` cmd.Long = `Get pipeline permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -346,7 +346,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions PIPELINE_ID" cmd.Short = `Get pipeline permissions.` cmd.Long = `Get pipeline permissions. - + Gets the permissions of a pipeline. Pipelines can inherit permissions from their root object. @@ -415,7 +415,7 @@ func newGetUpdate() *cobra.Command { cmd.Use = "get-update PIPELINE_ID UPDATE_ID" cmd.Short = `Get a pipeline update.` cmd.Long = `Get a pipeline update. - + Gets an update from an active pipeline. Arguments: @@ -478,7 +478,7 @@ func newListPipelineEvents() *cobra.Command { cmd.Use = "list-pipeline-events PIPELINE_ID" cmd.Short = `List pipeline events.` cmd.Long = `List pipeline events. - + Retrieves events for a pipeline. Arguments: @@ -548,7 +548,7 @@ func newListPipelines() *cobra.Command { cmd.Use = "list-pipelines" cmd.Short = `List pipelines.` cmd.Long = `List pipelines. - + Lists pipelines defined in the Delta Live Tables system.` cmd.Annotations = make(map[string]string) @@ -600,7 +600,7 @@ func newListUpdates() *cobra.Command { cmd.Use = "list-updates PIPELINE_ID" cmd.Short = `List pipeline updates.` cmd.Long = `List pipeline updates. - + List updates for an active pipeline. Arguments: @@ -673,7 +673,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions PIPELINE_ID" cmd.Short = `Set pipeline permissions.` cmd.Long = `Set pipeline permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -772,7 +772,7 @@ func newStartUpdate() *cobra.Command { cmd.Use = "start-update PIPELINE_ID" cmd.Short = `Start a pipeline.` cmd.Long = `Start a pipeline. - + Starts a new update for the pipeline. If there is already an active update for the pipeline, the request will fail and the active update will remain running.` @@ -856,7 +856,7 @@ func newStop() *cobra.Command { cmd.Use = "stop PIPELINE_ID" cmd.Short = `Stop a pipeline.` cmd.Long = `Stop a pipeline. - + Stops the pipeline by canceling the active update. If there is no active update for the pipeline, this request is a no-op.` @@ -969,7 +969,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update PIPELINE_ID" cmd.Short = `Edit a pipeline.` cmd.Long = `Edit a pipeline. - + Updates a pipeline with the supplied configuration. Arguments: @@ -1054,7 +1054,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions PIPELINE_ID" cmd.Short = `Update pipeline permissions.` cmd.Long = `Update pipeline permissions. - + Updates the permissions on a pipeline. Pipelines can inherit permissions from their root object. diff --git a/cmd/workspace/policies/policies.go b/cmd/workspace/policies/policies.go index 15a45238f9..857d279f2d 100755 --- a/cmd/workspace/policies/policies.go +++ b/cmd/workspace/policies/policies.go @@ -100,7 +100,7 @@ func newCreatePolicy() *cobra.Command { cmd.Use = "create-policy TO_PRINCIPALS FOR_SECURABLE_TYPE POLICY_TYPE" cmd.Short = `Create an ABAC policy.` cmd.Long = `Create an ABAC policy. - + Creates a new policy on a securable. The new policy applies to the securable and all its descendants. @@ -108,7 +108,7 @@ func newCreatePolicy() *cobra.Command { TO_PRINCIPALS: List of user or group names that the policy applies to. Required on create and optional on update. FOR_SECURABLE_TYPE: Type of securables that the policy should take effect on. Only TABLE is - supported at this moment. Required on create and optional on update. + supported at this moment. Required on create and optional on update. Supported values: [ CATALOG, CLEAN_ROOM, @@ -128,7 +128,7 @@ func newCreatePolicy() *cobra.Command { TABLE, VOLUME, ] - POLICY_TYPE: Type of the policy. Required on create and ignored on update. + POLICY_TYPE: Type of the policy. Required on create and ignored on update. Supported values: [POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER]` cmd.Annotations = make(map[string]string) @@ -220,7 +220,7 @@ func newDeletePolicy() *cobra.Command { cmd.Use = "delete-policy ON_SECURABLE_TYPE ON_SECURABLE_FULLNAME NAME" cmd.Short = `Delete an ABAC policy.` cmd.Long = `Delete an ABAC policy. - + Delete an ABAC policy defined on a securable. Arguments: @@ -281,7 +281,7 @@ func newGetPolicy() *cobra.Command { cmd.Use = "get-policy ON_SECURABLE_TYPE ON_SECURABLE_FULLNAME NAME" cmd.Short = `Get an ABAC policy.` cmd.Long = `Get an ABAC policy. - + Get the policy definition on a securable Arguments: @@ -345,10 +345,10 @@ func newListPolicies() *cobra.Command { cmd.Use = "list-policies ON_SECURABLE_TYPE ON_SECURABLE_FULLNAME" cmd.Short = `List ABAC policies.` cmd.Long = `List ABAC policies. - + List all policies defined on a securable. Optionally, the list can include inherited policies defined on the securable's parent schema or catalog. - + PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the @@ -439,7 +439,7 @@ func newUpdatePolicy() *cobra.Command { cmd.Use = "update-policy ON_SECURABLE_TYPE ON_SECURABLE_FULLNAME NAME TO_PRINCIPALS FOR_SECURABLE_TYPE POLICY_TYPE" cmd.Short = `Update an ABAC policy.` cmd.Long = `Update an ABAC policy. - + Update an ABAC policy on a securable. Arguments: @@ -450,7 +450,7 @@ func newUpdatePolicy() *cobra.Command { TO_PRINCIPALS: List of user or group names that the policy applies to. Required on create and optional on update. FOR_SECURABLE_TYPE: Type of securables that the policy should take effect on. Only TABLE is - supported at this moment. Required on create and optional on update. + supported at this moment. Required on create and optional on update. Supported values: [ CATALOG, CLEAN_ROOM, @@ -470,7 +470,7 @@ func newUpdatePolicy() *cobra.Command { TABLE, VOLUME, ] - POLICY_TYPE: Type of the policy. Required on create and ignored on update. + POLICY_TYPE: Type of the policy. Required on create and ignored on update. Supported values: [POLICY_TYPE_COLUMN_MASK, POLICY_TYPE_ROW_FILTER]` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/policy-compliance-for-clusters/policy-compliance-for-clusters.go b/cmd/workspace/policy-compliance-for-clusters/policy-compliance-for-clusters.go index 922a904288..7fa822b363 100755 --- a/cmd/workspace/policy-compliance-for-clusters/policy-compliance-for-clusters.go +++ b/cmd/workspace/policy-compliance-for-clusters/policy-compliance-for-clusters.go @@ -23,11 +23,11 @@ func New() *cobra.Command { Short: `The policy compliance APIs allow you to view and manage the policy compliance status of clusters in your workspace.`, Long: `The policy compliance APIs allow you to view and manage the policy compliance status of clusters in your workspace. - + A cluster is compliant with its policy if its configuration satisfies all its policy rules. Clusters could be out of compliance if their policy was updated after the cluster was last edited. - + The get and list compliance APIs allow you to view the policy compliance status of a cluster. The enforce compliance API allows you to update a cluster to be compliant with the current version of its policy.`, @@ -73,17 +73,17 @@ func newEnforceCompliance() *cobra.Command { cmd.Use = "enforce-compliance CLUSTER_ID" cmd.Short = `Enforce cluster policy compliance.` cmd.Long = `Enforce cluster policy compliance. - + Updates a cluster to be compliant with the current version of its policy. A cluster can be updated if it is in a RUNNING or TERMINATED state. - + If a cluster is updated while in a RUNNING state, it will be restarted so that the new attributes can take effect. - + If a cluster is updated while in a TERMINATED state, it will remain TERMINATED. The next time the cluster is started, the new attributes will take effect. - + Clusters created by the Databricks Jobs, DLT, or Models services cannot be enforced by this API. Instead, use the "Enforce job policy compliance" API to enforce policy compliance on jobs. @@ -162,7 +162,7 @@ func newGetCompliance() *cobra.Command { cmd.Use = "get-compliance CLUSTER_ID" cmd.Short = `Get cluster policy compliance.` cmd.Long = `Get cluster policy compliance. - + Returns the policy compliance status of a cluster. Clusters could be out of compliance if their policy was updated after the cluster was last edited. @@ -222,7 +222,7 @@ func newListCompliance() *cobra.Command { cmd.Use = "list-compliance POLICY_ID" cmd.Short = `List cluster policy compliance.` cmd.Long = `List cluster policy compliance. - + Returns the policy compliance status of all clusters that use a given policy. Clusters could be out of compliance if their policy was updated after the cluster was last edited. diff --git a/cmd/workspace/policy-compliance-for-jobs/policy-compliance-for-jobs.go b/cmd/workspace/policy-compliance-for-jobs/policy-compliance-for-jobs.go index 80ba0f7b85..b70e7648fd 100755 --- a/cmd/workspace/policy-compliance-for-jobs/policy-compliance-for-jobs.go +++ b/cmd/workspace/policy-compliance-for-jobs/policy-compliance-for-jobs.go @@ -24,13 +24,13 @@ func New() *cobra.Command { Long: `The compliance APIs allow you to view and manage the policy compliance status of jobs in your workspace. This API currently only supports compliance controls for cluster policies. - + A job is in compliance if its cluster configurations satisfy the rules of all their respective cluster policies. A job could be out of compliance if a cluster policy it uses was updated after the job was last edited. The job is considered out of compliance if any of its clusters no longer comply with their updated policies. - + The get and list compliance APIs allow you to view the policy compliance status of a job. The enforce compliance API allows you to update a job so that it becomes compliant with all of its policies.`, @@ -76,7 +76,7 @@ func newEnforceCompliance() *cobra.Command { cmd.Use = "enforce-compliance JOB_ID" cmd.Short = `Enforce job policy compliance.` cmd.Long = `Enforce job policy compliance. - + Updates a job so the job clusters that are created when running the job (specified in new_cluster) are compliant with the current versions of their respective cluster policies. All-purpose clusters used in the job will not be @@ -160,7 +160,7 @@ func newGetCompliance() *cobra.Command { cmd.Use = "get-compliance JOB_ID" cmd.Short = `Get job policy compliance.` cmd.Long = `Get job policy compliance. - + Returns the policy compliance status of a job. Jobs could be out of compliance if a cluster policy they use was updated after the job was last edited and some of its job clusters no longer comply with their updated policies. @@ -224,7 +224,7 @@ func newListCompliance() *cobra.Command { cmd.Use = "list-compliance POLICY_ID" cmd.Short = `List job policy compliance.` cmd.Long = `List job policy compliance. - + Returns the policy compliance status of all jobs that use a given policy. Jobs could be out of compliance if a cluster policy they use was updated after the job was last edited and its job clusters no longer comply with the updated diff --git a/cmd/workspace/policy-families/policy-families.go b/cmd/workspace/policy-families/policy-families.go index 7af92490f6..f56fc800ec 100755 --- a/cmd/workspace/policy-families/policy-families.go +++ b/cmd/workspace/policy-families/policy-families.go @@ -20,10 +20,10 @@ func New() *cobra.Command { Short: `View available policy families.`, Long: `View available policy families. A policy family contains a policy definition providing best practices for configuring clusters for a particular use case. - + Databricks manages and provides policy families for several common cluster use cases. You cannot create, edit, or delete policy families. - + Policy families cannot be used directly to create clusters. Instead, you create cluster policies using a policy family. Cluster policies created using a policy family inherit the policy family's policy definition.`, @@ -65,7 +65,7 @@ func newGet() *cobra.Command { cmd.Use = "get POLICY_FAMILY_ID" cmd.Short = `Get policy family information.` cmd.Long = `Get policy family information. - + Retrieve the information for an policy family based on its identifier and version @@ -125,7 +125,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List policy families.` cmd.Long = `List policy families. - + Returns the list of policy definition types available to use at their latest version. This API is paginated.` diff --git a/cmd/workspace/provider-exchange-filters/provider-exchange-filters.go b/cmd/workspace/provider-exchange-filters/provider-exchange-filters.go index 7b808c4ee8..8a72cb346f 100755 --- a/cmd/workspace/provider-exchange-filters/provider-exchange-filters.go +++ b/cmd/workspace/provider-exchange-filters/provider-exchange-filters.go @@ -63,7 +63,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new exchange filter.` cmd.Long = `Create a new exchange filter. - + Add an exchange filter.` cmd.Annotations = make(map[string]string) @@ -124,7 +124,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete an exchange filter.` cmd.Long = `Delete an exchange filter. - + Delete an exchange filter` cmd.Annotations = make(map[string]string) @@ -192,7 +192,7 @@ func newList() *cobra.Command { cmd.Use = "list EXCHANGE_ID" cmd.Short = `List exchange filters.` cmd.Long = `List exchange filters. - + List exchange filter` cmd.Annotations = make(map[string]string) @@ -245,7 +245,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Update exchange filter.` cmd.Long = `Update exchange filter. - + Update an exchange filter.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/provider-exchanges/provider-exchanges.go b/cmd/workspace/provider-exchanges/provider-exchanges.go index 94210836c8..606229a23c 100755 --- a/cmd/workspace/provider-exchanges/provider-exchanges.go +++ b/cmd/workspace/provider-exchanges/provider-exchanges.go @@ -69,7 +69,7 @@ func newAddListingToExchange() *cobra.Command { cmd.Use = "add-listing-to-exchange LISTING_ID EXCHANGE_ID" cmd.Short = `Add an exchange for listing.` cmd.Long = `Add an exchange for listing. - + Associate an exchange with a listing` cmd.Annotations = make(map[string]string) @@ -149,7 +149,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create an exchange.` cmd.Long = `Create an exchange. - + Create an exchange` cmd.Annotations = make(map[string]string) @@ -210,7 +210,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete an exchange.` cmd.Long = `Delete an exchange. - + This removes a listing from marketplace.` cmd.Annotations = make(map[string]string) @@ -263,7 +263,7 @@ func newDeleteListingFromExchange() *cobra.Command { cmd.Use = "delete-listing-from-exchange ID" cmd.Short = `Remove an exchange for listing.` cmd.Long = `Remove an exchange for listing. - + Disassociate an exchange with a listing` cmd.Annotations = make(map[string]string) @@ -370,7 +370,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List exchanges.` cmd.Long = `List exchanges. - + List exchanges visible to provider` cmd.Annotations = make(map[string]string) @@ -421,7 +421,7 @@ func newListExchangesForListing() *cobra.Command { cmd.Use = "list-exchanges-for-listing LISTING_ID" cmd.Short = `List exchanges for listing.` cmd.Long = `List exchanges for listing. - + List exchanges associated with a listing` cmd.Annotations = make(map[string]string) @@ -474,7 +474,7 @@ func newListListingsForExchange() *cobra.Command { cmd.Use = "list-listings-for-exchange EXCHANGE_ID" cmd.Short = `List listings for exchange.` cmd.Long = `List listings for exchange. - + List listings associated with an exchange` cmd.Annotations = make(map[string]string) @@ -527,7 +527,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Update exchange.` cmd.Long = `Update exchange. - + Update an exchange` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/provider-files/provider-files.go b/cmd/workspace/provider-files/provider-files.go index 08434c3cac..98730c8815 100755 --- a/cmd/workspace/provider-files/provider-files.go +++ b/cmd/workspace/provider-files/provider-files.go @@ -66,7 +66,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a file.` cmd.Long = `Create a file. - + Create a file. Currently, only provider icons and attached notebooks are supported.` @@ -128,7 +128,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete FILE_ID" cmd.Short = `Delete a file.` cmd.Long = `Delete a file. - + Delete a file` cmd.Annotations = make(map[string]string) @@ -193,7 +193,7 @@ func newGet() *cobra.Command { cmd.Use = "get FILE_ID" cmd.Short = `Get a file.` cmd.Long = `Get a file. - + Get a file` cmd.Annotations = make(map[string]string) @@ -264,7 +264,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List files.` cmd.Long = `List files. - + List files attached to a parent entity.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/provider-listings/provider-listings.go b/cmd/workspace/provider-listings/provider-listings.go index 5bac5d5c7d..4dfed103ac 100755 --- a/cmd/workspace/provider-listings/provider-listings.go +++ b/cmd/workspace/provider-listings/provider-listings.go @@ -65,7 +65,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a listing.` cmd.Long = `Create a listing. - + Create a new listing` cmd.Annotations = make(map[string]string) @@ -126,7 +126,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a listing.` cmd.Long = `Delete a listing. - + Delete a listing` cmd.Annotations = make(map[string]string) @@ -191,7 +191,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get a listing.` cmd.Long = `Get a listing. - + Get a listing` cmd.Annotations = make(map[string]string) @@ -259,7 +259,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List listings.` cmd.Long = `List listings. - + List listings owned by this provider` cmd.Annotations = make(map[string]string) @@ -310,7 +310,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Update listing.` cmd.Long = `Update listing. - + Update a listing` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go b/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go index f88cfa2407..118d4fceb6 100755 --- a/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go +++ b/cmd/workspace/provider-personalization-requests/provider-personalization-requests.go @@ -62,7 +62,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `All personalization requests across all listings.` cmd.Long = `All personalization requests across all listings. - + List personalization requests to this provider. This will return all personalization requests, regardless of which listing they are for.` @@ -117,7 +117,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update LISTING_ID REQUEST_ID STATUS" cmd.Short = `Update personalization request status.` cmd.Long = `Update personalization request status. - + Update personalization request. This method only permits updating the status of the request.` diff --git a/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go b/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go index 809256d7af..5e06f91fd0 100755 --- a/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go +++ b/cmd/workspace/provider-provider-analytics-dashboards/provider-provider-analytics-dashboards.go @@ -55,7 +55,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create provider analytics dashboard.` cmd.Long = `Create provider analytics dashboard. - + Create provider analytics dashboard. Returns Marketplace specific id. Not to be confused with the Lakeview dashboard id.` diff --git a/cmd/workspace/provider-providers/provider-providers.go b/cmd/workspace/provider-providers/provider-providers.go index 872b998730..841779b2be 100755 --- a/cmd/workspace/provider-providers/provider-providers.go +++ b/cmd/workspace/provider-providers/provider-providers.go @@ -64,7 +64,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a provider.` cmd.Long = `Create a provider. - + Create a provider` cmd.Annotations = make(map[string]string) @@ -125,7 +125,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete provider.` cmd.Long = `Delete provider. - + Delete provider` cmd.Annotations = make(map[string]string) @@ -190,7 +190,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get provider.` cmd.Long = `Get provider. - + Get provider profile` cmd.Annotations = make(map[string]string) @@ -258,7 +258,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List providers.` cmd.Long = `List providers. - + List provider profiles for account.` cmd.Annotations = make(map[string]string) @@ -309,7 +309,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Update provider.` cmd.Long = `Update provider. - + Update provider profile` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/providers/providers.go b/cmd/workspace/providers/providers.go index 1a1b31ef5f..6eeccd7a64 100755 --- a/cmd/workspace/providers/providers.go +++ b/cmd/workspace/providers/providers.go @@ -71,13 +71,13 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME AUTHENTICATION_TYPE" cmd.Short = `Create an auth provider.` cmd.Long = `Create an auth provider. - + Creates a new authentication provider minimally based on a name and authentication type. The caller must be an admin on the metastore. Arguments: NAME: The name of the Provider. - AUTHENTICATION_TYPE: + AUTHENTICATION_TYPE: Supported values: [DATABRICKS, OAUTH_CLIENT_CREDENTIALS, OIDC_FEDERATION, TOKEN]` cmd.Annotations = make(map[string]string) @@ -158,7 +158,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete a provider.` cmd.Long = `Delete a provider. - + Deletes an authentication provider, if the caller is a metastore admin or is the owner of the provider. @@ -227,7 +227,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get a provider.` cmd.Long = `Get a provider. - + Gets a specific authentication provider. The caller must supply the name of the provider, and must either be a metastore admin or the owner of the provider. @@ -301,7 +301,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List providers.` cmd.Long = `List providers. - + Gets an array of available authentication providers. The caller must either be a metastore admin or the owner of the providers. Providers not owned by the caller are not included in the response. There is no guarantee of a specific @@ -357,7 +357,7 @@ func newListProviderShareAssets() *cobra.Command { cmd.Use = "list-provider-share-assets PROVIDER_NAME SHARE_NAME" cmd.Short = `List assets by provider share.` cmd.Long = `List assets by provider share. - + Get arrays of assets associated with a specified provider's share. The caller is the recipient of the share. @@ -419,9 +419,9 @@ func newListShares() *cobra.Command { cmd.Use = "list-shares NAME" cmd.Short = `List shares by Provider.` cmd.Long = `List shares by Provider. - + Gets an array of a specified provider's shares within the metastore where: - + * the caller is a metastore admin, or * the caller is the owner. Arguments: @@ -494,7 +494,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update a provider.` cmd.Long = `Update a provider. - + Updates the information for an authentication provider, if the caller is a metastore admin or is the owner of the provider. If the update changes the provider name, the caller must be both a metastore admin and the owner of the diff --git a/cmd/workspace/quality-monitor-v2/quality-monitor-v2.go b/cmd/workspace/quality-monitor-v2/quality-monitor-v2.go index d6e96143b7..f48cc07e92 100755 --- a/cmd/workspace/quality-monitor-v2/quality-monitor-v2.go +++ b/cmd/workspace/quality-monitor-v2/quality-monitor-v2.go @@ -67,7 +67,7 @@ func newCreateQualityMonitor() *cobra.Command { cmd.Use = "create-quality-monitor OBJECT_TYPE OBJECT_ID" cmd.Short = `Create a quality monitor.` cmd.Long = `Create a quality monitor. - + Create a quality monitor on UC object Arguments: @@ -148,7 +148,7 @@ func newDeleteQualityMonitor() *cobra.Command { cmd.Use = "delete-quality-monitor OBJECT_TYPE OBJECT_ID" cmd.Short = `Delete a quality monitor.` cmd.Long = `Delete a quality monitor. - + Delete a quality monitor on UC object Arguments: @@ -206,7 +206,7 @@ func newGetQualityMonitor() *cobra.Command { cmd.Use = "get-quality-monitor OBJECT_TYPE OBJECT_ID" cmd.Short = `Read a quality monitor.` cmd.Long = `Read a quality monitor. - + Read a quality monitor on UC object Arguments: @@ -267,7 +267,7 @@ func newListQualityMonitor() *cobra.Command { cmd.Use = "list-quality-monitor" cmd.Short = `List quality monitors.` cmd.Long = `List quality monitors. - + (Unimplemented) List quality monitors` cmd.Annotations = make(map[string]string) @@ -321,7 +321,7 @@ func newUpdateQualityMonitor() *cobra.Command { cmd.Use = "update-quality-monitor OBJECT_TYPE OBJECT_ID OBJECT_TYPE OBJECT_ID" cmd.Short = `Update a quality monitor.` cmd.Long = `Update a quality monitor. - + (Unimplemented) Update a quality monitor on UC object Arguments: diff --git a/cmd/workspace/quality-monitors/quality-monitors.go b/cmd/workspace/quality-monitors/quality-monitors.go index 80a07aaf59..3361f79ca9 100755 --- a/cmd/workspace/quality-monitors/quality-monitors.go +++ b/cmd/workspace/quality-monitors/quality-monitors.go @@ -71,7 +71,7 @@ func newCancelRefresh() *cobra.Command { cmd.Use = "cancel-refresh TABLE_NAME REFRESH_ID" cmd.Short = `Cancel refresh.` cmd.Long = `Cancel refresh. - + Cancels an already-initiated refresh job. Arguments: @@ -152,16 +152,16 @@ func newCreate() *cobra.Command { cmd.Use = "create TABLE_NAME OUTPUT_SCHEMA_NAME ASSETS_DIR" cmd.Short = `Create a table monitor.` cmd.Long = `Create a table monitor. - + Creates a new monitor for the specified table. - + The caller must either: 1. be an owner of the table's parent catalog, have **USE_SCHEMA** on the table's parent schema, and have **SELECT** access on the table 2. have **USE_CATALOG** on the table's parent catalog, be an owner of the table's parent schema, and have **SELECT** access on the table. 3. have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the table's parent schema - be an owner of the table. - + Workspace assets, such as the dashboard, will be created in the workspace where this call was made. @@ -249,18 +249,18 @@ func newDelete() *cobra.Command { cmd.Use = "delete TABLE_NAME" cmd.Short = `Delete a table monitor.` cmd.Long = `Delete a table monitor. - + Deletes a monitor for the specified table. - + The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema 3. have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the table's parent schema - be an owner of the table. - + Additionally, the call must be made from the workspace where the monitor was created. - + Note that the metric tables and dashboard will not be deleted as part of this call; those assets must be manually cleaned up (if desired). @@ -318,15 +318,15 @@ func newGet() *cobra.Command { cmd.Use = "get TABLE_NAME" cmd.Short = `Get a table monitor.` cmd.Long = `Get a table monitor. - + Gets a monitor for the specified table. - + The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema. 3. have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the table's parent schema - **SELECT** privilege on the table. - + The returned information includes configuration values, as well as information on assets created by the monitor. Some information (e.g., dashboard) may be filtered out if the caller is in a different workspace than where the monitor @@ -386,15 +386,15 @@ func newGetRefresh() *cobra.Command { cmd.Use = "get-refresh TABLE_NAME REFRESH_ID" cmd.Short = `Get refresh.` cmd.Long = `Get refresh. - + Gets info about a specific monitor refresh using the given refresh ID. - + The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema 3. have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the table's parent schema - **SELECT** privilege on the table. - + Additionally, the call must be made from the workspace where the monitor was created. @@ -456,16 +456,16 @@ func newListRefreshes() *cobra.Command { cmd.Use = "list-refreshes TABLE_NAME" cmd.Short = `List refreshes.` cmd.Long = `List refreshes. - + Gets an array containing the history of the most recent refreshes (up to 25) for this table. - + The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema 3. have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the table's parent schema - **SELECT** privilege on the table. - + Additionally, the call must be made from the workspace where the monitor was created. @@ -528,15 +528,15 @@ func newRegenerateDashboard() *cobra.Command { cmd.Use = "regenerate-dashboard TABLE_NAME" cmd.Short = `Regenerate a monitoring dashboard.` cmd.Long = `Regenerate a monitoring dashboard. - + Regenerates the monitoring dashboard for the specified table. - + The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema 3. have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the table's parent schema - be an owner of the table - + The call must be made from the workspace where the monitor was created. The dashboard will be regenerated in the assets directory that was specified when the monitor was created. @@ -610,16 +610,16 @@ func newRunRefresh() *cobra.Command { cmd.Use = "run-refresh TABLE_NAME" cmd.Short = `Run refresh.` cmd.Long = `Run refresh. - + Queues a metric refresh on the monitor for the specified table. The refresh will execute in the background. - + The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema 3. have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the table's parent schema - be an owner of the table - + Additionally, the call must be made from the workspace where the monitor was created. @@ -692,18 +692,18 @@ func newUpdate() *cobra.Command { cmd.Use = "update TABLE_NAME OUTPUT_SCHEMA_NAME" cmd.Short = `Update a table monitor.` cmd.Long = `Update a table monitor. - + Updates a monitor for the specified table. - + The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the table's parent catalog and be an owner of the table's parent schema 3. have the following permissions: - **USE_CATALOG** on the table's parent catalog - **USE_SCHEMA** on the table's parent schema - be an owner of the table. - + Additionally, the call must be made from the workspace where the monitor was created, and the caller must be the original creator of the monitor. - + Certain configuration fields, such as output asset identifiers, cannot be updated. diff --git a/cmd/workspace/queries-legacy/queries-legacy.go b/cmd/workspace/queries-legacy/queries-legacy.go index e52fa6d81c..49fd453f2a 100755 --- a/cmd/workspace/queries-legacy/queries-legacy.go +++ b/cmd/workspace/queries-legacy/queries-legacy.go @@ -23,10 +23,10 @@ func New() *cobra.Command { definitions include the target SQL warehouse, query text, name, description, tags, parameters, and visualizations. Queries can be scheduled using the sql_task type of the Jobs API, e.g. :method:jobs/create. - + **Note**: A new version of the Databricks SQL API is now available. Please see the latest version. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html`, GroupID: "sql", Annotations: map[string]string{ @@ -80,20 +80,20 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new query definition.` cmd.Long = `Create a new query definition. - + Creates a new query definition. Queries created with this endpoint belong to the authenticated user making the request. - + The data_source_id field specifies the ID of the SQL warehouse to run this query against. You can use the Data Sources API to see a complete list of available SQL warehouses. Or you can copy the data_source_id from an existing query. - + **Note**: You cannot add a visualization until you create the query. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:queries/create instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) @@ -157,14 +157,14 @@ func newDelete() *cobra.Command { cmd.Use = "delete QUERY_ID" cmd.Short = `Delete a query.` cmd.Long = `Delete a query. - + Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and they cannot be used for alerts. The trash is deleted after 30 days. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:queries/delete instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) @@ -217,13 +217,13 @@ func newGet() *cobra.Command { cmd.Use = "get QUERY_ID" cmd.Short = `Get a query definition.` cmd.Long = `Get a query definition. - + Retrieve a query object definition along with contextual permissions information about the currently authenticated user. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:queries/get instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) @@ -281,16 +281,16 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get a list of queries.` cmd.Long = `Get a list of queries. - + Gets a list of queries. Optionally, this list can be filtered by a search term. - + **Warning**: Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:queries/list instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) @@ -338,13 +338,13 @@ func newRestore() *cobra.Command { cmd.Use = "restore QUERY_ID" cmd.Short = `Restore a query.` cmd.Long = `Restore a query. - + Restore a query that has been moved to the trash. A restored query appears in list views and searches. You can use restored queries for alerts. - + **Note**: A new version of the Databricks SQL API is now available. Please see the latest version. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) @@ -408,14 +408,14 @@ func newUpdate() *cobra.Command { cmd.Use = "update QUERY_ID" cmd.Short = `Change a query definition.` cmd.Long = `Change a query definition. - + Modify this query definition. - + **Note**: You cannot undo this operation. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:queries/update instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/queries/queries.go b/cmd/workspace/queries/queries.go index 3cca60bdb3..7b3613497e 100755 --- a/cmd/workspace/queries/queries.go +++ b/cmd/workspace/queries/queries.go @@ -71,7 +71,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a query.` cmd.Long = `Create a query. - + Creates a query.` cmd.Annotations = make(map[string]string) @@ -135,7 +135,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a query.` cmd.Long = `Delete a query. - + Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and cannot be used for alerts. You can restore a trashed query through the UI. A trashed query is permanently deleted after 30 @@ -203,7 +203,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get a query.` cmd.Long = `Get a query. - + Gets a query.` cmd.Annotations = make(map[string]string) @@ -271,7 +271,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List queries.` cmd.Long = `List queries. - + Gets a list of queries accessible to the user, ordered by creation time. **Warning:** Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.` @@ -324,7 +324,7 @@ func newListVisualizations() *cobra.Command { cmd.Use = "list-visualizations ID" cmd.Short = `List visualizations on a query.` cmd.Long = `List visualizations on a query. - + Gets a list of visualizations on a query.` // This command is being previewed; hide from help output. @@ -395,18 +395,18 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID UPDATE_MASK" cmd.Short = `Update a query.` cmd.Long = `Update a query. - + Updates a query. Arguments: - ID: + ID: UPDATE_MASK: The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the diff --git a/cmd/workspace/query-history/query-history.go b/cmd/workspace/query-history/query-history.go index 8854a0b236..c2e89dd73d 100755 --- a/cmd/workspace/query-history/query-history.go +++ b/cmd/workspace/query-history/query-history.go @@ -60,9 +60,9 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List Queries.` cmd.Long = `List Queries. - + List the history of queries through SQL warehouses, and serverless compute. - + You can filter by user ID, warehouse ID, status, and time range. Most recently started queries are returned first (up to max_results in request). The pagination token returned in response can be used to list subsequent query diff --git a/cmd/workspace/query-visualizations-legacy/query-visualizations-legacy.go b/cmd/workspace/query-visualizations-legacy/query-visualizations-legacy.go index f66fe2b615..c3efebf7f0 100755 --- a/cmd/workspace/query-visualizations-legacy/query-visualizations-legacy.go +++ b/cmd/workspace/query-visualizations-legacy/query-visualizations-legacy.go @@ -24,10 +24,10 @@ func New() *cobra.Command { Long: `This is an evolving API that facilitates the addition and removal of vizualisations from existing queries within the Databricks Workspace. Data structures may change over time. - + **Note**: A new version of the Databricks SQL API is now available. Please see the latest version. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html`, GroupID: "sql", Annotations: map[string]string{ @@ -75,12 +75,12 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Add visualization to a query.` cmd.Long = `Add visualization to a query. - + Creates visualization in the query. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:queryvisualizations/create instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) @@ -141,12 +141,12 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Remove visualization.` cmd.Long = `Remove visualization. - + Removes a visualization from the query. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:queryvisualizations/delete instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html Arguments: @@ -214,12 +214,12 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Edit existing visualization.` cmd.Long = `Edit existing visualization. - + Updates visualization in the query. - + **Note**: A new version of the Databricks SQL API is now available. Please use :method:queryvisualizations/update instead. [Learn more] - + [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/query-visualizations/query-visualizations.go b/cmd/workspace/query-visualizations/query-visualizations.go index 6bf80f27cf..668098665d 100755 --- a/cmd/workspace/query-visualizations/query-visualizations.go +++ b/cmd/workspace/query-visualizations/query-visualizations.go @@ -69,7 +69,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Add a visualization to a query.` cmd.Long = `Add a visualization to a query. - + Adds a visualization to a query.` cmd.Annotations = make(map[string]string) @@ -133,7 +133,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Remove a visualization.` cmd.Long = `Remove a visualization. - + Removes a visualization.` cmd.Annotations = make(map[string]string) @@ -191,18 +191,18 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID UPDATE_MASK" cmd.Short = `Update a visualization.` cmd.Long = `Update a visualization. - + Updates a visualization. Arguments: - ID: + ID: UPDATE_MASK: The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the diff --git a/cmd/workspace/recipient-activation/recipient-activation.go b/cmd/workspace/recipient-activation/recipient-activation.go index 65cd29868c..a1a30a5484 100755 --- a/cmd/workspace/recipient-activation/recipient-activation.go +++ b/cmd/workspace/recipient-activation/recipient-activation.go @@ -24,7 +24,7 @@ func New() *cobra.Command { the credential file that includes the access token. The recipient will then use the credential file to establish a secure connection with the provider to receive the shared data. - + Note that you can download the credential file only once. Recipients should treat the downloaded credential as a secret and must not share it outside of their organization.`, @@ -64,7 +64,7 @@ func newGetActivationUrlInfo() *cobra.Command { cmd.Use = "get-activation-url-info ACTIVATION_URL" cmd.Short = `Get a share activation URL.` cmd.Long = `Get a share activation URL. - + Gets an activation URL for a share. Arguments: @@ -120,7 +120,7 @@ func newRetrieveToken() *cobra.Command { cmd.Use = "retrieve-token ACTIVATION_URL" cmd.Short = `Get an access token.` cmd.Long = `Get an access token. - + Retrieve access token with an activation url. This is a public API without any authentication. diff --git a/cmd/workspace/recipient-federation-policies/recipient-federation-policies.go b/cmd/workspace/recipient-federation-policies/recipient-federation-policies.go index 26e123673d..53e6543ea0 100755 --- a/cmd/workspace/recipient-federation-policies/recipient-federation-policies.go +++ b/cmd/workspace/recipient-federation-policies/recipient-federation-policies.go @@ -40,7 +40,7 @@ func New() *cobra.Command { of short-lived, expiring tokens. It is designed for strong identity governance, secure cross-platform data sharing, and reduced operational overhead for credential management. - + For more information, see https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security and https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed`, @@ -90,7 +90,7 @@ func newCreate() *cobra.Command { cmd.Use = "create RECIPIENT_NAME" cmd.Short = `Create recipient federation policy.` cmd.Long = `Create recipient federation policy. - + Create a federation policy for an OIDC_FEDERATION recipient for sharing data from Databricks to non-Databricks recipients. The caller must be the owner of the recipient. When sharing data from Databricks to non-Databricks clients, @@ -98,16 +98,16 @@ func newCreate() *cobra.Command { The federation policy validates OIDC claims in federated tokens and is defined at the recipient level. This enables secretless sharing clients to authenticate using OIDC tokens. - + Supported scenarios for federation policies: 1. **User-to-Machine (U2M) flow** (e.g., PowerBI): A user accesses a resource using their own identity. 2. **Machine-to-Machine (M2M) flow** (e.g., OAuth App): An OAuth App accesses a resource using its own identity, typically for tasks like running nightly jobs. - + For an overview, refer to: - Blog post: Overview of feature: https://www.databricks.com/blog/announcing-oidc-token-federation-enhanced-delta-sharing-security - + For detailed configuration guides based on your use case: - Creating a Federation Policy as a provider: https://docs.databricks.com/en/delta-sharing/create-recipient-oidc-fed - @@ -184,7 +184,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete RECIPIENT_NAME NAME" cmd.Short = `Delete recipient federation policy.` cmd.Long = `Delete recipient federation policy. - + Deletes an existing federation policy for an OIDC_FEDERATION recipient. The caller must be the owner of the recipient. @@ -244,7 +244,7 @@ func newGetFederationPolicy() *cobra.Command { cmd.Use = "get-federation-policy RECIPIENT_NAME NAME" cmd.Short = `Get recipient federation policy.` cmd.Long = `Get recipient federation policy. - + Reads an existing federation policy for an OIDC_FEDERATION recipient for sharing data from Databricks to non-Databricks recipients. The caller must have read access to the recipient. @@ -308,7 +308,7 @@ func newList() *cobra.Command { cmd.Use = "list RECIPIENT_NAME" cmd.Short = `List recipient federation policies.` cmd.Long = `List recipient federation policies. - + Lists federation policies for an OIDC_FEDERATION recipient for sharing data from Databricks to non-Databricks recipients. The caller must have read access to the recipient. diff --git a/cmd/workspace/recipients/recipients.go b/cmd/workspace/recipients/recipients.go index cb63e56007..ce5086d60b 100755 --- a/cmd/workspace/recipients/recipients.go +++ b/cmd/workspace/recipients/recipients.go @@ -25,13 +25,13 @@ func New() *cobra.Command { represent an organization which you want to allow access shares. The way how sharing works differs depending on whether or not your recipient has access to a Databricks workspace that is enabled for Unity Catalog: - + - For recipients with access to a Databricks workspace that is enabled for Unity Catalog, you can create a recipient object along with a unique sharing identifier you get from the recipient. The sharing identifier is the key identifier that enables the secure connection. This sharing mode is called **Databricks-to-Databricks sharing**. - + - For recipients without access to a Databricks workspace that is enabled for Unity Catalog, when you create a recipient object, Databricks generates an activation link you can send to the recipient. The recipient follows the @@ -90,14 +90,14 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME AUTHENTICATION_TYPE" cmd.Short = `Create a share recipient.` cmd.Long = `Create a share recipient. - + Creates a new recipient with the delta sharing authentication type in the metastore. The caller must be a metastore admin or have the **CREATE_RECIPIENT** privilege on the metastore. Arguments: NAME: Name of Recipient. - AUTHENTICATION_TYPE: + AUTHENTICATION_TYPE: Supported values: [DATABRICKS, OAUTH_CLIENT_CREDENTIALS, OIDC_FEDERATION, TOKEN]` cmd.Annotations = make(map[string]string) @@ -178,7 +178,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete a share recipient.` cmd.Long = `Delete a share recipient. - + Deletes the specified recipient from the metastore. The caller must be the owner of the recipient. @@ -235,9 +235,9 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get a share recipient.` cmd.Long = `Get a share recipient. - + Gets a share recipient from the metastore if: - + * the caller is the owner of the share recipient, or: * is a metastore admin Arguments: @@ -297,9 +297,9 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List share recipients.` cmd.Long = `List share recipients. - + Gets an array of all share recipients within the current metastore where: - + * the caller is a metastore admin, or * the caller is the owner. There is no guarantee of a specific ordering of the elements in the array.` @@ -351,7 +351,7 @@ func newRotateToken() *cobra.Command { cmd.Use = "rotate-token NAME EXISTING_TOKEN_EXPIRE_IN_SECONDS" cmd.Short = `Rotate a token.` cmd.Long = `Rotate a token. - + Refreshes the specified recipient's delta sharing authentication token with the provided token info. The caller must be the owner of the recipient. @@ -441,7 +441,7 @@ func newSharePermissions() *cobra.Command { cmd.Use = "share-permissions NAME" cmd.Short = `Get recipient share permissions.` cmd.Long = `Get recipient share permissions. - + Gets the share permissions for the specified Recipient. The caller must have the USE_RECIPIENT privilege on the metastore or be the owner of the Recipient. @@ -508,7 +508,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update a share recipient.` cmd.Long = `Update a share recipient. - + Updates an existing recipient in the metastore. The caller must be a metastore admin or the owner of the recipient. If the recipient name will be updated, the user must be both a metastore admin and the owner of the recipient. diff --git a/cmd/workspace/registered-models/registered-models.go b/cmd/workspace/registered-models/registered-models.go index cf75be001b..28052eb0b1 100755 --- a/cmd/workspace/registered-models/registered-models.go +++ b/cmd/workspace/registered-models/registered-models.go @@ -24,19 +24,19 @@ func New() *cobra.Command { Long: `Databricks provides a hosted version of MLflow Model Registry in Unity Catalog. Models in Unity Catalog provide centralized access control, auditing, lineage, and discovery of ML models across Databricks workspaces. - + An MLflow registered model resides in the third layer of Unity Catalog’s three-level namespace. Registered models contain model versions, which correspond to actual ML models (MLflow models). Creating new model versions currently requires use of the MLflow Python client. Once model versions are created, you can load them for batch inference using MLflow Python client APIs, or deploy them for real-time serving using Databricks Model Serving. - + All operations on registered models and model versions require USE_CATALOG permissions on the enclosing catalog and USE_SCHEMA permissions on the enclosing schema. In addition, the following additional privileges are required for various operations: - + * To create a registered model, users must additionally have the CREATE_MODEL permission on the target schema. * To view registered model or model version metadata, model version data files, or invoke a model version, users must @@ -46,7 +46,7 @@ func New() *cobra.Command { model version metadata (comments, aliases) create a new model version, or update permissions on the registered model, users must be owners of the registered model. - + Note: The securable type for models is FUNCTION. When using REST APIs (e.g. tagging, grants) that specify a securable type, use FUNCTION as the securable type.`, @@ -109,13 +109,13 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a Registered Model.` cmd.Long = `Create a Registered Model. - + Creates a new registered model in Unity Catalog. - + File storage for model versions in the registered model will be located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore. - + For registered model creation to succeed, the user must satisfy the following conditions: - The caller must be a metastore admin, or be the owner of the parent catalog and schema, or have the **USE_CATALOG** privilege on the parent @@ -184,10 +184,10 @@ func newDelete() *cobra.Command { cmd.Use = "delete FULL_NAME" cmd.Short = `Delete a Registered Model.` cmd.Long = `Delete a Registered Model. - + Deletes a registered model and all its model versions from the specified parent catalog and schema. - + The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent @@ -258,9 +258,9 @@ func newDeleteAlias() *cobra.Command { cmd.Use = "delete-alias FULL_NAME ALIAS" cmd.Short = `Delete a Registered Model Alias.` cmd.Long = `Delete a Registered Model Alias. - + Deletes a registered model alias. - + The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent @@ -324,9 +324,9 @@ func newGet() *cobra.Command { cmd.Use = "get FULL_NAME" cmd.Short = `Get a Registered Model.` cmd.Long = `Get a Registered Model. - + Get a registered model. - + The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and @@ -403,10 +403,10 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List Registered Models.` cmd.Long = `List Registered Models. - + List registered models. You can list registered models under a particular schema, or list all registered models in the current metastore. - + The returned models are filtered based on the privileges of the calling user. For example, the metastore admin is able to list all the registered models. A regular user needs to be the owner or have the **EXECUTE** privilege on the @@ -414,9 +414,9 @@ func newList() *cobra.Command { latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. - + There is no guarantee of a specific ordering of the elements in the response. - + PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the @@ -470,9 +470,9 @@ func newSetAlias() *cobra.Command { cmd.Use = "set-alias FULL_NAME ALIAS VERSION_NUM" cmd.Short = `Set a Registered Model Alias.` cmd.Long = `Set a Registered Model Alias. - + Set an alias on the specified registered model. - + The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent @@ -578,14 +578,14 @@ func newUpdate() *cobra.Command { cmd.Use = "update FULL_NAME" cmd.Short = `Update a Registered Model.` cmd.Long = `Update a Registered Model. - + Updates the specified registered model. - + The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. - + Currently only the name, the owner or the comment of the registered model can be updated. diff --git a/cmd/workspace/repos/repos.go b/cmd/workspace/repos/repos.go index 9c36e0a737..03f3f7072a 100755 --- a/cmd/workspace/repos/repos.go +++ b/cmd/workspace/repos/repos.go @@ -23,11 +23,11 @@ func New() *cobra.Command { Short: `The Repos API allows users to manage their git repos.`, Long: `The Repos API allows users to manage their git repos. Users can use the API to access all repos that they have manage permissions on. - + Databricks Repos is a visual Git client in Databricks. It supports common Git operations such a cloning a repository, committing and pushing, pulling, branch management, and visual comparison of diffs when committing. - + Within Repos you can develop code in notebooks or other files and follow data science and engineering code development best practices using Git for version control, collaboration, and CI/CD.`, @@ -80,7 +80,7 @@ func newCreate() *cobra.Command { cmd.Use = "create URL PROVIDER" cmd.Short = `Create a repo.` cmd.Long = `Create a repo. - + Creates a repo in the workspace and links it to the remote Git repo specified. Note that repos created programmatically must be linked to a remote Git repo, unlike repos created in the browser. @@ -166,7 +166,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete REPO_ID" cmd.Short = `Delete a repo.` cmd.Long = `Delete a repo. - + Deletes the specified repo. Arguments: @@ -237,7 +237,7 @@ func newGet() *cobra.Command { cmd.Use = "get REPO_ID" cmd.Short = `Get a repo.` cmd.Long = `Get a repo. - + Returns the repo with the given repo ID. Arguments: @@ -308,7 +308,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels REPO_ID" cmd.Short = `Get repo permission levels.` cmd.Long = `Get repo permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -376,7 +376,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions REPO_ID" cmd.Short = `Get repo permissions.` cmd.Long = `Get repo permissions. - + Gets the permissions of a repo. Repos can inherit permissions from their root object. @@ -448,7 +448,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `Get repos.` cmd.Long = `Get repos. - + Returns repos that the calling user has Manage permissions on. Use next_page_token to iterate through additional pages.` @@ -502,7 +502,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions REPO_ID" cmd.Short = `Set repo permissions.` cmd.Long = `Set repo permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -591,7 +591,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update REPO_ID" cmd.Short = `Update a repo.` cmd.Long = `Update a repo. - + Updates the repo to a different branch or tag, or updates the repo to the latest commit on the same branch. @@ -680,7 +680,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions REPO_ID" cmd.Short = `Update repo permissions.` cmd.Long = `Update repo permissions. - + Updates the permissions on a repo. Repos can inherit permissions from their root object. diff --git a/cmd/workspace/resource-quotas/resource-quotas.go b/cmd/workspace/resource-quotas/resource-quotas.go index da2979d9fd..d4fe56c0b9 100755 --- a/cmd/workspace/resource-quotas/resource-quotas.go +++ b/cmd/workspace/resource-quotas/resource-quotas.go @@ -24,7 +24,7 @@ func New() *cobra.Command { catalog). The resource quota APIs enable you to monitor your current usage and limits. For more information on resource quotas see the [Unity Catalog documentation]. - + [Unity Catalog documentation]: https://docs.databricks.com/en/data-governance/unity-catalog/index.html#resource-quotas`, GroupID: "catalog", Annotations: map[string]string{ @@ -62,7 +62,7 @@ func newGetQuota() *cobra.Command { cmd.Use = "get-quota PARENT_SECURABLE_TYPE PARENT_FULL_NAME QUOTA_NAME" cmd.Short = `Get information for a single resource quota.` cmd.Long = `Get information for a single resource quota. - + The GetQuota API returns usage information for a single resource quota, defined as a child-parent pair. This API also refreshes the quota count if it is out of date. Refreshes are triggered asynchronously. The updated count @@ -130,11 +130,11 @@ func newListQuotas() *cobra.Command { cmd.Use = "list-quotas" cmd.Short = `List all resource quotas under a metastore.` cmd.Long = `List all resource quotas under a metastore. - + ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the counts returned. This API does not trigger a refresh of quota counts. - + PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the diff --git a/cmd/workspace/restrict-workspace-admins/restrict-workspace-admins.go b/cmd/workspace/restrict-workspace-admins/restrict-workspace-admins.go index 77cb09a28e..469f980360 100755 --- a/cmd/workspace/restrict-workspace-admins/restrict-workspace-admins.go +++ b/cmd/workspace/restrict-workspace-admins/restrict-workspace-admins.go @@ -68,7 +68,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete the restrict workspace admins setting.` cmd.Long = `Delete the restrict workspace admins setting. - + Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs to be provided in DELETE requests (as a query parameter). The etag can be retrieved by making a GET request before the DELETE request. @@ -125,7 +125,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the restrict workspace admins setting.` cmd.Long = `Get the restrict workspace admins setting. - + Gets the restrict workspace admins setting.` cmd.Annotations = make(map[string]string) @@ -179,7 +179,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the restrict workspace admins setting.` cmd.Long = `Update the restrict workspace admins setting. - + Updates the restrict workspace admins setting for the workspace. A fresh etag needs to be provided in PATCH requests (as part of the setting field). The etag can be retrieved by making a GET request before the PATCH request. If diff --git a/cmd/workspace/rfa/rfa.go b/cmd/workspace/rfa/rfa.go index d9125c1c69..737958df27 100755 --- a/cmd/workspace/rfa/rfa.go +++ b/cmd/workspace/rfa/rfa.go @@ -23,7 +23,7 @@ func New() *cobra.Command { Short: `Request for Access enables customers to request access to and manage access request destinations for Unity Catalog securables.`, Long: `Request for Access enables customers to request access to and manage access request destinations for Unity Catalog securables. - + These APIs provide a standardized way to update, get, and request to access request destinations. Fine-grained authorization ensures that only users with appropriate permissions can manage access request destinations.`, @@ -69,13 +69,13 @@ func newBatchCreateAccessRequests() *cobra.Command { cmd.Use = "batch-create-access-requests" cmd.Short = `Create Access Requests.` cmd.Long = `Create Access Requests. - + Creates access requests for Unity Catalog permissions for a specified principal on a securable object. This Batch API can take in multiple principals, securable objects, and permissions as the input and returns the access request destinations for each. Principals must be unique across the API call. - + The supported securable types are: "metastore", "catalog", "schema", "table", "external_location", "connection", "credential", "function", "registered_model", and "volume".` @@ -141,12 +141,12 @@ func newGetAccessRequestDestinations() *cobra.Command { cmd.Use = "get-access-request-destinations SECURABLE_TYPE FULL_NAME" cmd.Short = `Get Access Request Destinations.` cmd.Long = `Get Access Request Destinations. - + Gets an array of access request destinations for the specified securable. Any caller can see URL destinations or the destinations on the metastore. Otherwise, only those with **BROWSE** permissions on the securable can see destinations. - + The supported securable types are: "metastore", "catalog", "schema", "table", "external_location", "connection", "credential", "function", "registered_model", and "volume". @@ -210,7 +210,7 @@ func newUpdateAccessRequestDestinations() *cobra.Command { cmd.Use = "update-access-request-destinations UPDATE_MASK DESTINATIONS SECURABLE" cmd.Short = `Update Access Request Destinations.` cmd.Long = `Update Access Request Destinations. - + Updates the access request destinations for the given securable. The caller must be a metastore admin, the owner of the securable, or a user that has the **MANAGE** privilege on the securable in order to assign destinations. @@ -220,7 +220,7 @@ func newUpdateAccessRequestDestinations() *cobra.Command { notification destinations (Slack, Microsoft Teams, and Generic Webhook destinations) can be assigned to a securable. If a URL destination is assigned, no other destinations can be set. - + The supported securable types are: "metastore", "catalog", "schema", "table", "external_location", "connection", "credential", "function", "registered_model", and "volume". @@ -232,7 +232,7 @@ func newUpdateAccessRequestDestinations() *cobra.Command { Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the diff --git a/cmd/workspace/schemas/schemas.go b/cmd/workspace/schemas/schemas.go index cbb8dd9668..d9d17c3b96 100755 --- a/cmd/workspace/schemas/schemas.go +++ b/cmd/workspace/schemas/schemas.go @@ -72,7 +72,7 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME CATALOG_NAME" cmd.Short = `Create a schema.` cmd.Long = `Create a schema. - + Creates a new schema for catalog in the Metastore. The caller must be a metastore admin, or have the **CREATE_SCHEMA** privilege in the parent catalog. @@ -157,7 +157,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete FULL_NAME" cmd.Short = `Delete a schema.` cmd.Long = `Delete a schema. - + Deletes the specified schema from the parent catalog. The caller must be the owner of the schema or an owner of the parent catalog. @@ -216,7 +216,7 @@ func newGet() *cobra.Command { cmd.Use = "get FULL_NAME" cmd.Short = `Get a schema.` cmd.Long = `Get a schema. - + Gets the specified schema within the metastore. The caller must be a metastore admin, the owner of the schema, or a user that has the **USE_SCHEMA** privilege on the schema. @@ -278,16 +278,16 @@ func newList() *cobra.Command { cmd.Use = "list CATALOG_NAME" cmd.Short = `List schemas.` cmd.Long = `List schemas. - + Gets an array of schemas for a catalog in the metastore. If the caller is the metastore admin or the owner of the parent catalog, all schemas for the catalog will be retrieved. Otherwise, only schemas owned by the caller (or for which the caller has the **USE_SCHEMA** privilege) will be retrieved. There is no guarantee of a specific ordering of the elements in the array. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -352,7 +352,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update FULL_NAME" cmd.Short = `Update a schema.` cmd.Long = `Update a schema. - + Updates a schema for a catalog. The caller must be the owner of the schema or a metastore admin. If the caller is a metastore admin, only the __owner__ field can be changed in the update. If the __name__ field must be updated, the diff --git a/cmd/workspace/secrets/secrets.go b/cmd/workspace/secrets/secrets.go index 2425ecfb8f..c0cf0e9bae 100755 --- a/cmd/workspace/secrets/secrets.go +++ b/cmd/workspace/secrets/secrets.go @@ -23,12 +23,12 @@ func New() *cobra.Command { Short: `The Secrets API allows you to manage secrets, secret scopes, and access permissions.`, Long: `The Secrets API allows you to manage secrets, secret scopes, and access permissions. - + Sometimes accessing data requires that you authenticate to external data sources through JDBC. Instead of directly entering your credentials into a notebook, use Databricks secrets to store your credentials and reference them in notebooks and jobs. - + Administrators, secret creators, and users granted permission can read Databricks secrets. While Databricks makes an effort to redact secret values that might be displayed in notebooks, it is not possible to prevent such users @@ -84,23 +84,23 @@ func newCreateScope() *cobra.Command { cmd.Use = "create-scope SCOPE" cmd.Short = `Create a new secret scope.` cmd.Long = `Create a new secret scope. - + Creates a new secret scope. - + The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters. - + Example request: - + .. code:: - + { "scope": "my-simple-databricks-scope", "initial_manage_principal": "users" "scope_backend_type": "databricks|azure_keyvault", # below is only required if scope type is azure_keyvault "backend_azure_keyvault": { "resource_id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxx/providers/Microsoft.KeyVault/vaults/xxxx", "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "dns_name": "https://xxxx.vault.azure.net/", } } - + If initial_manage_principal is specified, the initial ACL applied to the scope is applied to the supplied principal (user or group) with MANAGE permissions. The only supported principal for this option is the group @@ -108,13 +108,13 @@ func newCreateScope() *cobra.Command { initial_manage_principal is not specified, the initial ACL with MANAGE permission applied to the scope is assigned to the API request issuer's user identity. - + If scope_backend_type is azure_keyvault, a secret scope is created with secrets from a given Azure KeyVault. The caller must provide the keyvault_resource_id and the tenant_id for the key vault. If scope_backend_type is databricks or is unspecified, an empty secret scope is created and stored in Databricks's own storage. - + Throws RESOURCE_ALREADY_EXISTS if a scope with the given name already exists. Throws RESOURCE_LIMIT_EXCEEDED if maximum number of scopes in the workspace is exceeded. Throws INVALID_PARAMETER_VALUE if the scope name is @@ -200,17 +200,17 @@ func newDeleteAcl() *cobra.Command { cmd.Use = "delete-acl SCOPE PRINCIPAL" cmd.Short = `Delete an ACL.` cmd.Long = `Delete an ACL. - + Deletes the given ACL on the given scope. - + Users must have the MANAGE permission to invoke this API. - + Example request: - + .. code:: - + { "scope": "my-secret-scope", "principal": "data-scientists" } - + Throws RESOURCE_DOES_NOT_EXIST if no such secret scope, principal, or ACL exists. Throws PERMISSION_DENIED if the user does not have permission to make this API call. Throws INVALID_PARAMETER_VALUE if the permission or @@ -297,15 +297,15 @@ func newDeleteScope() *cobra.Command { cmd.Use = "delete-scope SCOPE" cmd.Short = `Delete a secret scope.` cmd.Long = `Delete a secret scope. - + Deletes a secret scope. - + Example request: - + .. code:: - + { "scope": "my-secret-scope" } - + Throws RESOURCE_DOES_NOT_EXIST if the scope does not exist. Throws PERMISSION_DENIED if the user does not have permission to make this API call. Throws BAD_REQUEST if system user attempts to delete internal secret @@ -388,16 +388,16 @@ func newDeleteSecret() *cobra.Command { cmd.Use = "delete-secret SCOPE KEY" cmd.Short = `Delete a secret.` cmd.Long = `Delete a secret. - + Deletes the secret stored in this secret scope. You must have WRITE or MANAGE permission on the Secret Scope. - + Example request: - + .. code:: - + { "scope": "my-secret-scope", "key": "my-secret-key" } - + Throws RESOURCE_DOES_NOT_EXIST if no such secret scope or secret exists. Throws PERMISSION_DENIED if the user does not have permission to make this API call. Throws BAD_REQUEST if system user attempts to delete an internal @@ -481,17 +481,17 @@ func newGetAcl() *cobra.Command { cmd.Use = "get-acl SCOPE PRINCIPAL" cmd.Short = `Get secret ACL details.` cmd.Long = `Get secret ACL details. - + Describes the details about the given ACL, such as the group and permission. - + Users must have the MANAGE permission to invoke this API. - + Example response: - + .. code:: - + { "principal": "data-scientists", "permission": "READ" } - + Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws PERMISSION_DENIED if the user does not have permission to make this API call. Throws INVALID_PARAMETER_VALUE if the permission or principal is @@ -552,28 +552,28 @@ func newGetSecret() *cobra.Command { cmd.Use = "get-secret SCOPE KEY" cmd.Short = `Get a secret.` cmd.Long = `Get a secret. - + Gets a secret for a given key and scope. This API can only be called from the DBUtils interface. Users need the READ permission to make this call. - + Example response: - + .. code:: - + { "key": "my-string-key", "value": } - + Note that the secret value returned is in bytes. The interpretation of the bytes is determined by the caller in DBUtils and the type the data is decoded into. - + Throws RESOURCE_DOES_NOT_EXIST if no such secret or secret scope exists. Throws PERMISSION_DENIED if the user does not have permission to make this API call. - + Note: This is explicitly an undocumented API. It also doesn't need to be supported for the /preview prefix, because it's not a customer-facing API (i.e. only used for DBUtils SecretUtils to fetch secrets). - + Throws RESOURCE_DOES_NOT_EXIST if no such secret scope or secret exists. Throws BAD_REQUEST if normal user calls get secret outside of a notebook. AKV specific errors: Throws INVALID_PARAMETER_VALUE if secret name is not @@ -636,18 +636,18 @@ func newListAcls() *cobra.Command { cmd.Use = "list-acls SCOPE" cmd.Short = `Lists ACLs.` cmd.Long = `Lists ACLs. - + Lists the ACLs set on the given scope. - + Users must have the MANAGE permission to invoke this API. - + Example response: - + .. code:: - + { "acls": [{ "principal": "admins", "permission": "MANAGE" },{ "principal": "data-scientists", "permission": "READ" }] } - + Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws PERMISSION_DENIED if the user does not have permission to make this API call. @@ -699,16 +699,16 @@ func newListScopes() *cobra.Command { cmd.Use = "list-scopes" cmd.Short = `List all scopes.` cmd.Long = `List all scopes. - + Lists all secret scopes available in the workspace. - + Example response: - + .. code:: - + { "scopes": [{ "name": "my-databricks-scope", "backend_type": "DATABRICKS" },{ "name": "mount-points", "backend_type": "DATABRICKS" }] } - + Throws PERMISSION_DENIED if the user does not have permission to make this API call.` @@ -751,21 +751,21 @@ func newListSecrets() *cobra.Command { cmd.Use = "list-secrets SCOPE" cmd.Short = `List secret keys.` cmd.Long = `List secret keys. - + Lists the secret keys that are stored at this scope. This is a metadata-only operation; secret data cannot be retrieved using this API. Users need the READ permission to make this call. - + Example response: - + .. code:: - + { "secrets": [ { "key": "my-string-key"", "last_updated_timestamp": "1520467595000" }, { "key": "my-byte-key", "last_updated_timestamp": "1520467595000" }, ] } - + The lastUpdatedTimestamp returned is in milliseconds since epoch. - + Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws PERMISSION_DENIED if the user does not have permission to make this API call. @@ -823,35 +823,35 @@ func newPutAcl() *cobra.Command { cmd.Use = "put-acl SCOPE PRINCIPAL PERMISSION" cmd.Short = `Create/update an ACL.` cmd.Long = `Create/update an ACL. - + Creates or overwrites the ACL associated with the given principal (user or group) on the specified scope point. In general, a user or group will use the most powerful permission available to them, and permissions are ordered as follows: - + * MANAGE - Allowed to change ACLs, and read and write to this secret scope. * WRITE - Allowed to read and write to this secret scope. * READ - Allowed to read this secret scope and list what secrets are available. - + Note that in general, secret values can only be read from within a command on a cluster (for example, through a notebook). There is no API to read the actual secret value material outside of a cluster. However, the user's permission will be applied based on who is executing the command, and they must have at least READ permission. - + Users must have the MANAGE permission to invoke this API. - + Example request: - + .. code:: - + { "scope": "my-secret-scope", "principal": "data-scientists", "permission": "READ" } - + The principal is a user or group name corresponding to an existing Databricks principal to be granted or revoked access. - + Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws RESOURCE_ALREADY_EXISTS if a permission for the principal already exists. Throws INVALID_PARAMETER_VALUE if the permission or principal is invalid. @@ -861,7 +861,7 @@ func newPutAcl() *cobra.Command { Arguments: SCOPE: The name of the scope to apply permissions to. PRINCIPAL: The principal in which the permission is applied. - PERMISSION: The permission level applied to the principal. + PERMISSION: The permission level applied to the principal. Supported values: [MANAGE, READ, WRITE]` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/service-principal-secrets-proxy/service-principal-secrets-proxy.go b/cmd/workspace/service-principal-secrets-proxy/service-principal-secrets-proxy.go index edbda27e40..ab761dbede 100755 --- a/cmd/workspace/service-principal-secrets-proxy/service-principal-secrets-proxy.go +++ b/cmd/workspace/service-principal-secrets-proxy/service-principal-secrets-proxy.go @@ -22,16 +22,16 @@ func New() *cobra.Command { Long: `These APIs enable administrators to manage service principal secrets at the workspace level. To use these APIs, the service principal must be first added to the current workspace. - + You can use the generated secrets to obtain OAuth access tokens for a service principal, which can then be used to access Databricks Accounts and Workspace APIs. For more information, see [Authentication using OAuth tokens for service principals]. - + In addition, the generated secrets can be used to configure the Databricks Terraform Providerto authenticate with the service principal. For more information, see [Databricks Terraform Provider]. - + [Authentication using OAuth tokens for service principals]: https://docs.databricks.com/dev-tools/authentication-oauth.html [Databricks Terraform Provider]: https://github.com/databricks/terraform-provider-databricks/blob/master/docs/index.md#authenticating-with-service-principal`, GroupID: "oauth2", @@ -76,7 +76,7 @@ func newCreate() *cobra.Command { cmd.Use = "create SERVICE_PRINCIPAL_ID" cmd.Short = `Create service principal secret.` cmd.Long = `Create service principal secret. - + Create a secret for the given service principal. Arguments: @@ -144,7 +144,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete SERVICE_PRINCIPAL_ID SECRET_ID" cmd.Short = `Delete service principal secret.` cmd.Long = `Delete service principal secret. - + Delete a secret from the given service principal. Arguments: @@ -205,7 +205,7 @@ func newList() *cobra.Command { cmd.Use = "list SERVICE_PRINCIPAL_ID" cmd.Short = `List service principal secrets.` cmd.Long = `List service principal secrets. - + List all secrets associated with the given service principal. This operation only returns information about the secrets themselves and does not include the secret values. diff --git a/cmd/workspace/service-principals-v2/service-principals-v2.go b/cmd/workspace/service-principals-v2/service-principals-v2.go index a0377fd5a6..3cb989583f 100755 --- a/cmd/workspace/service-principals-v2/service-principals-v2.go +++ b/cmd/workspace/service-principals-v2/service-principals-v2.go @@ -78,7 +78,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a service principal.` cmd.Long = `Create a service principal. - + Creates a new service principal in the Databricks workspace.` cmd.Annotations = make(map[string]string) @@ -142,7 +142,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a service principal.` cmd.Long = `Delete a service principal. - + Delete a single service principal in the Databricks workspace. Arguments: @@ -198,7 +198,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get service principal details.` cmd.Long = `Get service principal details. - + Gets the details for a single service principal define in the Databricks workspace. @@ -263,7 +263,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List service principals.` cmd.Long = `List service principals. - + Gets the set of service principals associated with a Databricks workspace.` cmd.Annotations = make(map[string]string) @@ -317,7 +317,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update service principal details.` cmd.Long = `Update service principal details. - + Partially updates the details of a single service principal in the Databricks workspace. @@ -398,9 +398,9 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace service principal.` cmd.Long = `Replace service principal. - + Updates the details of a single service principal. - + This action replaces the existing service principal with the same name. Arguments: diff --git a/cmd/workspace/service-principals/service-principals.go b/cmd/workspace/service-principals/service-principals.go index 628d7fd49d..2db499bbe9 100755 --- a/cmd/workspace/service-principals/service-principals.go +++ b/cmd/workspace/service-principals/service-principals.go @@ -80,7 +80,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a service principal.` cmd.Long = `Create a service principal. - + Creates a new service principal in the Databricks workspace.` cmd.Annotations = make(map[string]string) @@ -144,7 +144,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a service principal.` cmd.Long = `Delete a service principal. - + Delete a single service principal in the Databricks workspace. Arguments: @@ -212,7 +212,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get service principal details.` cmd.Long = `Get service principal details. - + Gets the details for a single service principal define in the Databricks workspace. @@ -289,7 +289,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List service principals.` cmd.Long = `List service principals. - + Gets the set of service principals associated with a Databricks workspace.` cmd.Annotations = make(map[string]string) @@ -343,7 +343,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update service principal details.` cmd.Long = `Update service principal details. - + Partially updates the details of a single service principal in the Databricks workspace. @@ -437,9 +437,9 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace service principal.` cmd.Long = `Replace service principal. - + Updates the details of a single service principal. - + This action replaces the existing service principal with the same name. Arguments: diff --git a/cmd/workspace/serving-endpoints/serving-endpoints.go b/cmd/workspace/serving-endpoints/serving-endpoints.go index deeec41747..c149120076 100755 --- a/cmd/workspace/serving-endpoints/serving-endpoints.go +++ b/cmd/workspace/serving-endpoints/serving-endpoints.go @@ -24,7 +24,7 @@ func New() *cobra.Command { Short: `The Serving Endpoints API allows you to create, update, and delete model serving endpoints.`, Long: `The Serving Endpoints API allows you to create, update, and delete model serving endpoints. - + You can use a serving endpoint to serve models from the Databricks Model Registry or from Unity Catalog. Endpoints expose the underlying models as scalable REST API endpoints using serverless compute. This means the endpoints @@ -90,7 +90,7 @@ func newBuildLogs() *cobra.Command { cmd.Use = "build-logs NAME SERVED_MODEL_NAME" cmd.Short = `Get build logs for a served model.` cmd.Long = `Get build logs for a served model. - + Retrieves the build logs associated with the provided served model. Arguments: @@ -395,7 +395,7 @@ func newExportMetrics() *cobra.Command { cmd.Use = "export-metrics NAME" cmd.Short = `Get metrics of a serving endpoint.` cmd.Long = `Get metrics of a serving endpoint. - + Retrieves the metrics associated with the provided serving endpoint in either Prometheus or OpenMetrics exposition format. @@ -454,7 +454,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get a single serving endpoint.` cmd.Long = `Get a single serving endpoint. - + Retrieves the details for a single serving endpoint. Arguments: @@ -510,7 +510,7 @@ func newGetOpenApi() *cobra.Command { cmd.Use = "get-open-api NAME" cmd.Short = `Get the schema for a serving endpoint.` cmd.Long = `Get the schema for a serving endpoint. - + Get the query schema of the serving endpoint in OpenAPI format. The schema contains information for the supported paths, input and output format and datatypes. @@ -570,7 +570,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels SERVING_ENDPOINT_ID" cmd.Short = `Get serving endpoint permission levels.` cmd.Long = `Get serving endpoint permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -626,7 +626,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions SERVING_ENDPOINT_ID" cmd.Short = `Get serving endpoint permissions.` cmd.Long = `Get serving endpoint permissions. - + Gets the permissions of a serving endpoint. Serving endpoints can inherit permissions from their root object. @@ -691,7 +691,7 @@ func newHttpRequest() *cobra.Command { Arguments: CONNECTION_NAME: The connection name to use. This is required to identify the external connection. - METHOD: The HTTP method to use (e.g., 'GET', 'POST'). + METHOD: The HTTP method to use (e.g., 'GET', 'POST'). Supported values: [DELETE, GET, PATCH, POST, PUT] PATH: The relative path for the API endpoint. This is required.` @@ -792,7 +792,7 @@ func newLogs() *cobra.Command { cmd.Use = "logs NAME SERVED_MODEL_NAME" cmd.Short = `Get the latest logs for a served model.` cmd.Long = `Get the latest logs for a served model. - + Retrieves the service logs associated with the provided served model. Arguments: @@ -858,7 +858,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch NAME" cmd.Short = `Update tags of a serving endpoint.` cmd.Long = `Update tags of a serving endpoint. - + Used to batch add and delete tags from a serving endpoint with a single API call. @@ -933,7 +933,7 @@ func newPut() *cobra.Command { cmd.Use = "put NAME" cmd.Short = `Update rate limits of a serving endpoint.` cmd.Long = `Update rate limits of a serving endpoint. - + Deprecated: Please use AI Gateway to manage rate limits instead. Arguments: @@ -1011,7 +1011,7 @@ func newPutAiGateway() *cobra.Command { cmd.Use = "put-ai-gateway NAME" cmd.Short = `Update AI Gateway of a serving endpoint.` cmd.Long = `Update AI Gateway of a serving endpoint. - + Used to update the AI Gateway of a serving endpoint. NOTE: External model, provisioned throughput, and pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables. @@ -1101,7 +1101,7 @@ func newQuery() *cobra.Command { cmd.Use = "query NAME" cmd.Short = `Query a serving endpoint.` cmd.Long = `Query a serving endpoint. - + Query a serving endpoint Arguments: @@ -1175,7 +1175,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions SERVING_ENDPOINT_ID" cmd.Short = `Set serving endpoint permissions.` cmd.Long = `Set serving endpoint permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -1259,7 +1259,7 @@ func newUpdateConfig() *cobra.Command { cmd.Use = "update-config NAME" cmd.Short = `Update config of a serving endpoint.` cmd.Long = `Update config of a serving endpoint. - + Updates any combination of the serving endpoint's served entities, the compute configuration of those served entities, and the endpoint's traffic config. An endpoint that already has an update in progress can not be updated until the @@ -1348,7 +1348,7 @@ func newUpdateNotifications() *cobra.Command { cmd.Use = "update-notifications NAME" cmd.Short = `Update the email and webhook notification settings for an endpoint.` cmd.Long = `Update the email and webhook notification settings for an endpoint. - + Updates the email and webhook notification settings for an endpoint. Arguments: @@ -1422,7 +1422,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions SERVING_ENDPOINT_ID" cmd.Short = `Update serving endpoint permissions.` cmd.Long = `Update serving endpoint permissions. - + Updates the permissions on a serving endpoint. Serving endpoints can inherit permissions from their root object. @@ -1500,7 +1500,7 @@ func newUpdateProvisionedThroughputEndpointConfig() *cobra.Command { cmd.Use = "update-provisioned-throughput-endpoint-config NAME" cmd.Short = `Update config of a PT serving endpoint.` cmd.Long = `Update config of a PT serving endpoint. - + Updates any combination of the pt endpoint's served entities, the compute configuration of those served entities, and the endpoint's traffic config. Updates are instantaneous and endpoint should be updated instantly diff --git a/cmd/workspace/shares/shares.go b/cmd/workspace/shares/shares.go index c5f48ca19d..1b2599ce27 100755 --- a/cmd/workspace/shares/shares.go +++ b/cmd/workspace/shares/shares.go @@ -73,7 +73,7 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME" cmd.Short = `Create a share.` cmd.Long = `Create a share. - + Creates a new share for data objects. Data objects can be added after creation with **update**. The caller must be a metastore admin or have the **CREATE_SHARE** privilege on the metastore. @@ -152,7 +152,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete a share.` cmd.Long = `Delete a share. - + Deletes a data object share from the metastore. The caller must be an owner of the share. @@ -211,7 +211,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get a share.` cmd.Long = `Get a share. - + Gets a data object share from the metastore. The caller must have the USE_SHARE privilege on the metastore or be the owner of the share. @@ -271,7 +271,7 @@ func newListShares() *cobra.Command { cmd.Use = "list-shares" cmd.Short = `List shares.` cmd.Long = `List shares. - + Gets an array of data object shares from the metastore. If the caller has the USE_SHARE privilege on the metastore, all shares are returned. Otherwise, only shares owned by the caller are returned. There is no guarantee of a specific @@ -325,7 +325,7 @@ func newSharePermissions() *cobra.Command { cmd.Use = "share-permissions NAME" cmd.Short = `Get permissions.` cmd.Long = `Get permissions. - + Gets the permissions for a data share from the metastore. The caller must have the USE_SHARE privilege on the metastore or be the owner of the share. @@ -391,23 +391,23 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update a share.` cmd.Long = `Update a share. - + Updates the share with the changes and data objects in the request. The caller must be the owner of the share or a metastore admin. - + When the caller is a metastore admin, only the __owner__ field can be updated. - + In the case the share name is changed, **updateShare** requires that the caller is the owner of the share and has the CREATE_SHARE privilege. - + If there are notebook files in the share, the __storage_root__ field cannot be updated. - + For each table that is added through this method, the share owner must also have **SELECT** privilege on the table. This privilege must be maintained indefinitely for recipients to be able to access the table. Typically, you should use a group as the share owner. - + Table removals through **update** do not require additional privileges. Arguments: @@ -481,11 +481,11 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions NAME" cmd.Short = `Update permissions.` cmd.Long = `Update permissions. - + Updates the permissions for a data share in the metastore. The caller must have both the USE_SHARE and SET_SHARE_PERMISSION privileges on the metastore, or be the owner of the share. - + For new recipient grants, the user must also be the owner of the recipients. recipient revocations do not require additional privileges. diff --git a/cmd/workspace/sql-results-download/sql-results-download.go b/cmd/workspace/sql-results-download/sql-results-download.go index e96170fbea..3542b0a015 100755 --- a/cmd/workspace/sql-results-download/sql-results-download.go +++ b/cmd/workspace/sql-results-download/sql-results-download.go @@ -59,7 +59,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete" cmd.Short = `Delete the SQL Results Download setting.` cmd.Long = `Delete the SQL Results Download setting. - + Reverts the SQL Results Download setting to its default value.` cmd.Annotations = make(map[string]string) @@ -112,7 +112,7 @@ func newGet() *cobra.Command { cmd.Use = "get" cmd.Short = `Get the SQL Results Download setting.` cmd.Long = `Get the SQL Results Download setting. - + Gets the SQL Results Download setting.` cmd.Annotations = make(map[string]string) @@ -166,7 +166,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update" cmd.Short = `Update the SQL Results Download setting.` cmd.Long = `Update the SQL Results Download setting. - + Updates the SQL Results Download setting.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/storage-credentials/storage-credentials.go b/cmd/workspace/storage-credentials/storage-credentials.go index 5630aba1ef..e3487c9c61 100755 --- a/cmd/workspace/storage-credentials/storage-credentials.go +++ b/cmd/workspace/storage-credentials/storage-credentials.go @@ -27,10 +27,10 @@ func New() *cobra.Command { groups can access the credential. If a user does not have access to a storage credential in Unity Catalog, the request fails and Unity Catalog does not attempt to authenticate to your cloud tenant on the user’s behalf. - + Databricks recommends using external locations rather than using storage credentials directly. - + To create storage credentials, you must be a Databricks account admin. The account admin who creates the storage credential can delegate ownership to another user or group to manage permissions on it.`, @@ -86,9 +86,9 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME" cmd.Short = `Create a storage credential.` cmd.Long = `Create a storage credential. - + Creates a new storage credential. - + The caller must be a metastore admin or have the **CREATE_STORAGE_CREDENTIAL** privilege on the metastore. @@ -169,7 +169,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete a credential.` cmd.Long = `Delete a credential. - + Deletes a storage credential from the metastore. The caller must be an owner of the storage credential. @@ -226,7 +226,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get a credential.` cmd.Long = `Get a credential. - + Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the storage credential, or have some permission on the storage credential. @@ -288,16 +288,16 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List credentials.` cmd.Long = `List credentials. - + Gets an array of storage credentials (as __StorageCredentialInfo__ objects). The array is limited to only those storage credentials the caller has permission to access. If the caller is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a specific ordering of the elements in the array. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -364,9 +364,9 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update a credential.` cmd.Long = `Update a credential. - + Updates a storage credential on the metastore. - + The caller must be the owner of the storage credential or a metastore admin. If the caller is a metastore admin, only the **owner** field can be changed. @@ -448,16 +448,16 @@ func newValidate() *cobra.Command { cmd.Use = "validate" cmd.Short = `Validate a storage credential.` cmd.Long = `Validate a storage credential. - + Validates a storage credential. At least one of __external_location_name__ and __url__ need to be provided. If only one of them is provided, it will be used for validation. And if both are provided, the __url__ will be used for validation, and __external_location_name__ will be ignored when checking overlapping urls. - + Either the __storage_credential_name__ or the cloud-specific credential must be provided. - + The caller must be a metastore admin or the storage credential owner or have the **CREATE_EXTERNAL_LOCATION** privilege on the metastore and the storage credential.` diff --git a/cmd/workspace/system-schemas/system-schemas.go b/cmd/workspace/system-schemas/system-schemas.go index 8cff5356e2..c72b85093c 100755 --- a/cmd/workspace/system-schemas/system-schemas.go +++ b/cmd/workspace/system-schemas/system-schemas.go @@ -59,7 +59,7 @@ func newDisable() *cobra.Command { cmd.Use = "disable METASTORE_ID SCHEMA_NAME" cmd.Short = `Disable a system schema.` cmd.Long = `Disable a system schema. - + Disables the system schema and removes it from the system catalog. The caller must be an account admin or a metastore admin. @@ -123,7 +123,7 @@ func newEnable() *cobra.Command { cmd.Use = "enable METASTORE_ID SCHEMA_NAME" cmd.Short = `Enable a system schema.` cmd.Long = `Enable a system schema. - + Enables the system schema and adds it to the system catalog. The caller must be an account admin or a metastore admin. @@ -197,13 +197,13 @@ func newList() *cobra.Command { cmd.Use = "list METASTORE_ID" cmd.Short = `List system schemas.` cmd.Long = `List system schemas. - + Gets an array of system schemas for a metastore. The caller must be an account admin or a metastore admin. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only diff --git a/cmd/workspace/table-constraints/table-constraints.go b/cmd/workspace/table-constraints/table-constraints.go index 0034037fcb..c872b753a9 100755 --- a/cmd/workspace/table-constraints/table-constraints.go +++ b/cmd/workspace/table-constraints/table-constraints.go @@ -23,14 +23,14 @@ func New() *cobra.Command { Short: `Primary key and foreign key constraints encode relationships between fields in tables.`, Long: `Primary key and foreign key constraints encode relationships between fields in tables. - + Primary and foreign keys are informational only and are not enforced. Foreign keys must reference a primary key in another table. This primary key is the parent constraint of the foreign key and the table this primary key is on is the parent table of the foreign key. Similarly, the foreign key is the child constraint of its referenced primary key; the table of the foreign key is the child table of the primary key. - + You can declare primary keys and foreign keys as part of the table specification during table creation. You can also add or drop constraints on existing tables.`, @@ -73,9 +73,9 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a table constraint.` cmd.Long = `Create a table constraint. - + Creates a new table constraint. - + For the table constraint creation to succeed, the user must satisfy both of these conditions: - the user must have the **USE_CATALOG** privilege on the table's parent catalog, the **USE_SCHEMA** privilege on the table's parent @@ -143,9 +143,9 @@ func newDelete() *cobra.Command { cmd.Use = "delete FULL_NAME CONSTRAINT_NAME CASCADE" cmd.Short = `Delete a table constraint.` cmd.Long = `Delete a table constraint. - + Deletes a table constraint. - + For the table constraint deletion to succeed, the user must satisfy both of these conditions: - the user must have the **USE_CATALOG** privilege on the table's parent catalog, the **USE_SCHEMA** privilege on the table's parent diff --git a/cmd/workspace/tables/tables.go b/cmd/workspace/tables/tables.go index 57375d4f1f..ffa1ae99e9 100755 --- a/cmd/workspace/tables/tables.go +++ b/cmd/workspace/tables/tables.go @@ -27,7 +27,7 @@ func New() *cobra.Command { permission on its parent catalog. To query a table, users must have the SELECT permission on the table, and they must have the USE_CATALOG permission on its parent catalog and the USE_SCHEMA permission on its parent schema. - + A table can be managed or external. From an API perspective, a __VIEW__ is a particular kind of table (rather than a managed or external table).`, GroupID: "catalog", @@ -77,25 +77,25 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME CATALOG_NAME SCHEMA_NAME TABLE_TYPE DATA_SOURCE_FORMAT STORAGE_LOCATION" cmd.Short = `Create a table.` cmd.Long = `Create a table. - + Creates a new table in the specified catalog and schema. - + To create an external delta table, the caller must have the **EXTERNAL_USE_SCHEMA** privilege on the parent schema and the **EXTERNAL_USE_LOCATION** privilege on the external location. These privileges must always be granted explicitly, and cannot be inherited through ownership or **ALL_PRIVILEGES**. - + Standard UC permissions needed to create tables still apply: **USE_CATALOG** on the parent catalog (or ownership of the parent catalog), **CREATE_TABLE** and **USE_SCHEMA** on the parent schema (or ownership of the parent schema), and **CREATE_EXTERNAL_TABLE** on external location. - + The **columns** field needs to be in a Spark compatible format, so we recommend you use Spark to create these tables. The API itself does not validate the correctness of the column spec. If the spec is not Spark compatible, the tables may not be readable by Databricks Runtime. - + NOTE: The Create Table API for external clients only supports creating **external delta tables**. The values shown in the respective enums are all values supported by Databricks, however for this specific Create Table API, @@ -107,7 +107,7 @@ func newCreate() *cobra.Command { NAME: Name of table, relative to parent schema. CATALOG_NAME: Name of parent catalog. SCHEMA_NAME: Name of parent schema relative to its parent catalog. - TABLE_TYPE: + TABLE_TYPE: Supported values: [ EXTERNAL, EXTERNAL_SHALLOW_CLONE, @@ -119,7 +119,7 @@ func newCreate() *cobra.Command { STREAMING_TABLE, VIEW, ] - DATA_SOURCE_FORMAT: + DATA_SOURCE_FORMAT: Supported values: [ AVRO, BIGQUERY_FORMAT, @@ -248,7 +248,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete FULL_NAME" cmd.Short = `Delete a table.` cmd.Long = `Delete a table. - + Deletes a table from the specified parent catalog and schema. The caller must be the owner of the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema, or be the owner of the @@ -308,7 +308,7 @@ func newExists() *cobra.Command { cmd.Use = "exists FULL_NAME" cmd.Short = `Get boolean reflecting if table exists.` cmd.Long = `Get boolean reflecting if table exists. - + Gets if a table exists in the metastore for a specific catalog and schema. The caller must satisfy one of the following requirements: * Be a metastore admin * Be the owner of the parent catalog * Be the owner of the parent schema and @@ -375,7 +375,7 @@ func newGet() *cobra.Command { cmd.Use = "get FULL_NAME" cmd.Short = `Get a table.` cmd.Long = `Get a table. - + Gets a table from the metastore for a specific catalog and schema. The caller must satisfy one of the following requirements: * Be a metastore admin * Be the owner of the parent catalog * Be the owner of the parent schema and have @@ -445,17 +445,17 @@ func newList() *cobra.Command { cmd.Use = "list CATALOG_NAME SCHEMA_NAME" cmd.Short = `List tables.` cmd.Long = `List tables. - + Gets an array of all tables for the current metastore under the parent catalog and schema. The caller must be a metastore admin or an owner of (or have the **SELECT** privilege on) the table. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. There is no guarantee of a specific ordering of the elements in the array. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -519,19 +519,19 @@ func newListSummaries() *cobra.Command { cmd.Use = "list-summaries CATALOG_NAME" cmd.Short = `List table summaries.` cmd.Long = `List table summaries. - + Gets an array of summaries for tables for a schema and catalog within the metastore. The table summaries returned are either: - + * summaries for tables (within the current metastore and parent catalog and schema), when the user is a metastore admin, or: * summaries for tables and schemas (within the current metastore and parent catalog) for which the user has ownership or the **SELECT** privilege on the table and ownership or **USE_SCHEMA** privilege on the schema, provided that the user also has ownership or the **USE_CATALOG** privilege on the parent catalog. - + There is no guarantee of a specific ordering of the elements in the array. - + PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the @@ -592,7 +592,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update FULL_NAME" cmd.Short = `Update a table owner.` cmd.Long = `Update a table owner. - + Change the owner of the table. The caller must be the owner of the parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema, or be the owner of the table and have the diff --git a/cmd/workspace/tag-policies/tag-policies.go b/cmd/workspace/tag-policies/tag-policies.go index ae78bf28a8..d37515cf70 100755 --- a/cmd/workspace/tag-policies/tag-policies.go +++ b/cmd/workspace/tag-policies/tag-policies.go @@ -24,7 +24,7 @@ func New() *cobra.Command { Long: `The Tag Policy API allows you to manage policies for governed tags in Databricks. Permissions for tag policies can be managed using the [Account Access Control Proxy API]. - + [Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy`, GroupID: "tags", Annotations: map[string]string{ @@ -72,7 +72,7 @@ func newCreateTagPolicy() *cobra.Command { cmd.Use = "create-tag-policy TAG_KEY" cmd.Short = `Create a new tag policy.` cmd.Long = `Create a new tag policy. - + Creates a new tag policy, making the associated tag key governed.` cmd.Annotations = make(map[string]string) @@ -146,7 +146,7 @@ func newDeleteTagPolicy() *cobra.Command { cmd.Use = "delete-tag-policy TAG_KEY" cmd.Short = `Delete a tag policy.` cmd.Long = `Delete a tag policy. - + Deletes a tag policy by its associated governed tag's key, leaving that tag key ungoverned.` @@ -200,7 +200,7 @@ func newGetTagPolicy() *cobra.Command { cmd.Use = "get-tag-policy TAG_KEY" cmd.Short = `Get a tag policy.` cmd.Long = `Get a tag policy. - + Gets a single tag policy by its associated governed tag's key.` cmd.Annotations = make(map[string]string) @@ -256,7 +256,7 @@ func newListTagPolicies() *cobra.Command { cmd.Use = "list-tag-policies" cmd.Short = `List tag policies.` cmd.Long = `List tag policies. - + Lists the tag policies for all governed tags in the account.` cmd.Annotations = make(map[string]string) @@ -311,18 +311,18 @@ func newUpdateTagPolicy() *cobra.Command { cmd.Use = "update-tag-policy TAG_KEY UPDATE_MASK" cmd.Short = `Update an existing tag policy.` cmd.Long = `Update an existing tag policy. - + Updates an existing tag policy for a single governed tag. Arguments: - TAG_KEY: + TAG_KEY: UPDATE_MASK: The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the diff --git a/cmd/workspace/temporary-path-credentials/temporary-path-credentials.go b/cmd/workspace/temporary-path-credentials/temporary-path-credentials.go index ba4e0bf99a..5cd6a998e2 100755 --- a/cmd/workspace/temporary-path-credentials/temporary-path-credentials.go +++ b/cmd/workspace/temporary-path-credentials/temporary-path-credentials.go @@ -29,7 +29,7 @@ func New() *cobra.Command { Security Token Service (STS), Azure utilizes Shared Access Signatures (SAS) for its data storage services, and Google Cloud supports temporary credentials through OAuth 2.0. - + Temporary path credentials ensure that data access is limited in scope and duration, reducing the risk of unauthorized access or misuse. To use the temporary path credentials API, a metastore admin needs to enable the @@ -37,14 +37,14 @@ func New() *cobra.Command { needs to be granted the EXTERNAL USE LOCATION permission by external location owner. For requests on existing external tables, user also needs to be granted the EXTERNAL USE SCHEMA permission at the schema level by catalog admin. - + Note that EXTERNAL USE SCHEMA is a schema level permission that can only be granted by catalog admin explicitly and is not included in schema ownership or ALL PRIVILEGES on the schema for security reasons. Similarly, EXTERNAL USE LOCATION is an external location level permission that can only be granted by external location owner explicitly and is not included in external location ownership or ALL PRIVILEGES on the external location for security reasons. - + This API only supports temporary path credentials for external locations and external tables, and volumes will be supported in the future.`, GroupID: "catalog", @@ -87,7 +87,7 @@ func newGenerateTemporaryPathCredentials() *cobra.Command { cmd.Use = "generate-temporary-path-credentials URL OPERATION" cmd.Short = `Generate a temporary path credential.` cmd.Long = `Generate a temporary path credential. - + Get a short-lived credential for directly accessing cloud storage locations registered in Databricks. The Generate Temporary Path Credentials API is only supported for external storage paths, specifically external locations and @@ -101,7 +101,7 @@ func newGenerateTemporaryPathCredentials() *cobra.Command { Arguments: URL: URL for path-based access. - OPERATION: The operation being performed on the path. + OPERATION: The operation being performed on the path. Supported values: [PATH_CREATE_TABLE, PATH_READ, PATH_READ_WRITE]` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/temporary-table-credentials/temporary-table-credentials.go b/cmd/workspace/temporary-table-credentials/temporary-table-credentials.go index 1bb949fd3a..7059742952 100755 --- a/cmd/workspace/temporary-table-credentials/temporary-table-credentials.go +++ b/cmd/workspace/temporary-table-credentials/temporary-table-credentials.go @@ -27,7 +27,7 @@ func New() *cobra.Command { via AWS Security Token Service (STS), Azure utilizes Shared Access Signatures (SAS) for its data storage services, and Google Cloud supports temporary credentials through OAuth 2.0. - + Temporary table credentials ensure that data access is limited in scope and duration, reducing the risk of unauthorized access or misuse. To use the temporary table credentials API, a metastore admin needs to enable the @@ -77,7 +77,7 @@ func newGenerateTemporaryTableCredentials() *cobra.Command { cmd.Use = "generate-temporary-table-credentials" cmd.Short = `Generate a temporary table credential.` cmd.Long = `Generate a temporary table credential. - + Get a short-lived credential for directly accessing the table data on cloud storage. The metastore must have **external_access_enabled** flag set to true (default false). The caller must have the **EXTERNAL_USE_SCHEMA** privilege on diff --git a/cmd/workspace/token-management/token-management.go b/cmd/workspace/token-management/token-management.go index 438769a936..f3501c78f1 100755 --- a/cmd/workspace/token-management/token-management.go +++ b/cmd/workspace/token-management/token-management.go @@ -72,7 +72,7 @@ func newCreateOboToken() *cobra.Command { cmd.Use = "create-obo-token APPLICATION_ID" cmd.Short = `Create on-behalf token.` cmd.Long = `Create on-behalf token. - + Creates a token on behalf of a service principal. Arguments: @@ -165,7 +165,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete TOKEN_ID" cmd.Short = `Delete a token.` cmd.Long = `Delete a token. - + Deletes a token, specified by its ID. Arguments: @@ -233,7 +233,7 @@ func newGet() *cobra.Command { cmd.Use = "get TOKEN_ID" cmd.Short = `Get token info.` cmd.Long = `Get token info. - + Gets information about a token, specified by its ID. Arguments: @@ -298,7 +298,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels" cmd.Short = `Get token permission levels.` cmd.Long = `Get token permission levels. - + Gets the permission levels that a user can have on an object.` cmd.Annotations = make(map[string]string) @@ -340,7 +340,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions" cmd.Short = `Get token permissions.` cmd.Long = `Get token permissions. - + Gets the permissions of all tokens. Tokens can inherit permissions from their root object.` @@ -389,7 +389,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List all tokens.` cmd.Long = `List all tokens. - + Lists all tokens associated with the specified workspace or user.` cmd.Annotations = make(map[string]string) @@ -442,7 +442,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions" cmd.Short = `Set token permissions.` cmd.Long = `Set token permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.` @@ -513,7 +513,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions" cmd.Short = `Update token permissions.` cmd.Long = `Update token permissions. - + Updates the permissions on all tokens. Tokens can inherit permissions from their root object.` diff --git a/cmd/workspace/tokens/tokens.go b/cmd/workspace/tokens/tokens.go index 52d3390efb..8bd9beb06d 100755 --- a/cmd/workspace/tokens/tokens.go +++ b/cmd/workspace/tokens/tokens.go @@ -66,7 +66,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a user token.` cmd.Long = `Create a user token. - + Creates and returns a token for a user. If this call is made through token authentication, it creates a token with the same client ID as the authenticated token. If the user's token quota is exceeded, this call returns @@ -136,9 +136,9 @@ func newDelete() *cobra.Command { cmd.Use = "delete TOKEN_ID" cmd.Short = `Revoke token.` cmd.Long = `Revoke token. - + Revokes an access token. - + If a token with the specified ID is not valid, this call returns an error **RESOURCE_DOES_NOT_EXIST**. @@ -228,7 +228,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List tokens.` cmd.Long = `List tokens. - + Lists all the valid tokens for a user-workspace pair.` cmd.Annotations = make(map[string]string) diff --git a/cmd/workspace/users-v2/users-v2.go b/cmd/workspace/users-v2/users-v2.go index c7484f091c..0379f889f9 100755 --- a/cmd/workspace/users-v2/users-v2.go +++ b/cmd/workspace/users-v2/users-v2.go @@ -20,7 +20,7 @@ func New() *cobra.Command { Use: "users-v2", Short: `User identities recognized by Databricks and represented by email addresses.`, Long: `User identities recognized by Databricks and represented by email addresses. - + Databricks recommends using SCIM provisioning to sync users and groups automatically from your identity provider to your Databricks workspace. SCIM streamlines onboarding a new employee or team by using your identity provider @@ -89,7 +89,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new user.` cmd.Long = `Create a new user. - + Creates a new user in the Databricks workspace. This new user will also be added to the Databricks account.` @@ -154,7 +154,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a user.` cmd.Long = `Delete a user. - + Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the user. @@ -219,7 +219,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get user details.` cmd.Long = `Get user details. - + Gets information for a specific user in Databricks workspace. Arguments: @@ -275,7 +275,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels" cmd.Short = `Get password permission levels.` cmd.Long = `Get password permission levels. - + Gets the permission levels that a user can have on an object.` cmd.Annotations = make(map[string]string) @@ -321,7 +321,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions" cmd.Short = `Get password permissions.` cmd.Long = `Get password permissions. - + Gets the permissions of all passwords. Passwords can inherit permissions from their root object.` @@ -376,7 +376,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List users.` cmd.Long = `List users. - + Gets details for all the users associated with a Databricks workspace.` cmd.Annotations = make(map[string]string) @@ -430,7 +430,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update user details.` cmd.Long = `Update user details. - + Partially updates a user resource by applying the supplied operations on specific user attributes. @@ -504,7 +504,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions" cmd.Short = `Set password permissions.` cmd.Long = `Set password permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.` @@ -584,7 +584,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace a user.` cmd.Long = `Replace a user. - + Replaces a user's information with the data supplied in request. Arguments: @@ -657,7 +657,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions" cmd.Short = `Update password permissions.` cmd.Long = `Update password permissions. - + Updates the permissions on all passwords. Passwords can inherit permissions from their root object.` diff --git a/cmd/workspace/users/users.go b/cmd/workspace/users/users.go index da1c58df99..b7ea06316d 100755 --- a/cmd/workspace/users/users.go +++ b/cmd/workspace/users/users.go @@ -22,7 +22,7 @@ func New() *cobra.Command { Use: "users", Short: `User identities recognized by Databricks and represented by email addresses.`, Long: `User identities recognized by Databricks and represented by email addresses. - + Databricks recommends using SCIM provisioning to sync users and groups automatically from your identity provider to your Databricks workspace. SCIM streamlines onboarding a new employee or team by using your identity provider @@ -91,7 +91,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a new user.` cmd.Long = `Create a new user. - + Creates a new user in the Databricks workspace. This new user will also be added to the Databricks account.` @@ -156,7 +156,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a user.` cmd.Long = `Delete a user. - + Deletes a user. Deleting a user from a Databricks workspace also removes objects associated with the user. @@ -233,7 +233,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get user details.` cmd.Long = `Get user details. - + Gets information for a specific user in Databricks workspace. Arguments: @@ -298,7 +298,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels" cmd.Short = `Get password permission levels.` cmd.Long = `Get password permission levels. - + Gets the permission levels that a user can have on an object.` cmd.Annotations = make(map[string]string) @@ -340,7 +340,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions" cmd.Short = `Get password permissions.` cmd.Long = `Get password permissions. - + Gets the permissions of all passwords. Passwords can inherit permissions from their root object.` @@ -394,7 +394,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List users.` cmd.Long = `List users. - + Gets details for all the users associated with a Databricks workspace.` cmd.Annotations = make(map[string]string) @@ -448,7 +448,7 @@ func newPatch() *cobra.Command { cmd.Use = "patch ID" cmd.Short = `Update user details.` cmd.Long = `Update user details. - + Partially updates a user resource by applying the supplied operations on specific user attributes. @@ -534,7 +534,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions" cmd.Short = `Set password permissions.` cmd.Long = `Set password permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.` @@ -615,7 +615,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update ID" cmd.Short = `Replace a user.` cmd.Long = `Replace a user. - + Replaces a user's information with the data supplied in request. Arguments: @@ -700,7 +700,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions" cmd.Short = `Update password permissions.` cmd.Long = `Update password permissions. - + Updates the permissions on all passwords. Passwords can inherit permissions from their root object.` diff --git a/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go b/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go index ef5d757e60..4132fab5ab 100755 --- a/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go +++ b/cmd/workspace/vector-search-endpoints/vector-search-endpoints.go @@ -74,12 +74,12 @@ func newCreateEndpoint() *cobra.Command { cmd.Use = "create-endpoint NAME ENDPOINT_TYPE" cmd.Short = `Create an endpoint.` cmd.Long = `Create an endpoint. - + Create a new endpoint. Arguments: NAME: Name of the vector search endpoint - ENDPOINT_TYPE: Type of endpoint + ENDPOINT_TYPE: Type of endpoint Supported values: [STANDARD]` cmd.Annotations = make(map[string]string) @@ -179,7 +179,7 @@ func newDeleteEndpoint() *cobra.Command { cmd.Use = "delete-endpoint ENDPOINT_NAME" cmd.Short = `Delete an endpoint.` cmd.Long = `Delete an endpoint. - + Delete a vector search endpoint. Arguments: @@ -235,7 +235,7 @@ func newGetEndpoint() *cobra.Command { cmd.Use = "get-endpoint ENDPOINT_NAME" cmd.Short = `Get an endpoint.` cmd.Long = `Get an endpoint. - + Get details for a single vector search endpoint. Arguments: @@ -293,7 +293,7 @@ func newListEndpoints() *cobra.Command { cmd.Use = "list-endpoints" cmd.Short = `List all endpoints.` cmd.Long = `List all endpoints. - + List all vector search endpoints in the workspace.` cmd.Annotations = make(map[string]string) @@ -344,7 +344,7 @@ func newUpdateEndpointBudgetPolicy() *cobra.Command { cmd.Use = "update-endpoint-budget-policy ENDPOINT_NAME BUDGET_POLICY_ID" cmd.Short = `Update the budget policy of an endpoint.` cmd.Long = `Update the budget policy of an endpoint. - + Update the budget policy of an endpoint Arguments: diff --git a/cmd/workspace/vector-search-indexes/vector-search-indexes.go b/cmd/workspace/vector-search-indexes/vector-search-indexes.go index 1fe0bcd6d1..1fb09ab3ed 100755 --- a/cmd/workspace/vector-search-indexes/vector-search-indexes.go +++ b/cmd/workspace/vector-search-indexes/vector-search-indexes.go @@ -23,7 +23,7 @@ func New() *cobra.Command { Short: `**Index**: An efficient representation of your embedding vectors that supports real-time and efficient approximate nearest neighbor (ANN) search queries.`, Long: `**Index**: An efficient representation of your embedding vectors that supports real-time and efficient approximate nearest neighbor (ANN) search queries. - + There are 2 types of Vector Search indexes: - **Delta Sync Index**: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table @@ -80,14 +80,14 @@ func newCreateIndex() *cobra.Command { cmd.Use = "create-index NAME ENDPOINT_NAME PRIMARY_KEY INDEX_TYPE" cmd.Short = `Create an index.` cmd.Long = `Create an index. - + Create a new index. Arguments: NAME: Name of the index ENDPOINT_NAME: Name of the endpoint to be used for serving the index PRIMARY_KEY: Primary key of the index - INDEX_TYPE: + INDEX_TYPE: Supported values: [DELTA_SYNC, DIRECT_ACCESS]` cmd.Annotations = make(map[string]string) @@ -177,7 +177,7 @@ func newDeleteDataVectorIndex() *cobra.Command { cmd.Use = "delete-data-vector-index INDEX_NAME" cmd.Short = `Delete data from index.` cmd.Long = `Delete data from index. - + Handles the deletion of data from a specified vector index. Arguments: @@ -360,7 +360,7 @@ func newListIndexes() *cobra.Command { cmd.Use = "list-indexes ENDPOINT_NAME" cmd.Short = `List indexes.` cmd.Long = `List indexes. - + List all indexes in the given endpoint. Arguments: @@ -425,7 +425,7 @@ func newQueryIndex() *cobra.Command { cmd.Use = "query-index INDEX_NAME" cmd.Short = `Query an index.` cmd.Long = `Query an index. - + Query the specified vector index. Arguments: @@ -501,7 +501,7 @@ func newQueryNextPage() *cobra.Command { cmd.Use = "query-next-page INDEX_NAME" cmd.Short = `Query next page.` cmd.Long = `Query next page. - + Use next_page_token returned from previous QueryVectorIndex or QueryVectorIndexNextPage request to fetch next page of results. @@ -576,7 +576,7 @@ func newScanIndex() *cobra.Command { cmd.Use = "scan-index INDEX_NAME" cmd.Short = `Scan an index.` cmd.Long = `Scan an index. - + Scan the specified vector index and return the first num_results entries after the exclusive primary_key. @@ -645,7 +645,7 @@ func newSyncIndex() *cobra.Command { cmd.Use = "sync-index INDEX_NAME" cmd.Short = `Synchronize an index.` cmd.Long = `Synchronize an index. - + Triggers a synchronization process for a specified vector index. Arguments: @@ -704,7 +704,7 @@ func newUpsertDataVectorIndex() *cobra.Command { cmd.Use = "upsert-data-vector-index INDEX_NAME INPUTS_JSON" cmd.Short = `Upsert data into an index.` cmd.Long = `Upsert data into an index. - + Handles the upserting of data into a specified vector index. Arguments: diff --git a/cmd/workspace/volumes/volumes.go b/cmd/workspace/volumes/volumes.go index 7e14adabd0..2f7864b0b3 100755 --- a/cmd/workspace/volumes/volumes.go +++ b/cmd/workspace/volumes/volumes.go @@ -74,20 +74,20 @@ func newCreate() *cobra.Command { cmd.Use = "create CATALOG_NAME SCHEMA_NAME NAME VOLUME_TYPE" cmd.Short = `Create a Volume.` cmd.Long = `Create a Volume. - + Creates a new volume. - + The user could create either an external volume or a managed volume. An external volume will be created in the specified external location, while a managed volume will be located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore. - + For the volume creation to succeed, the user must satisfy following conditions: - The caller must be a metastore admin, or be the owner of the parent catalog and schema, or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. - The caller must have **CREATE VOLUME** privilege on the parent schema. - + For an external volume, following conditions also need to satisfy - The caller must have **CREATE EXTERNAL VOLUME** privilege on the external location. - There are no other tables, nor volumes existing in the specified storage @@ -102,8 +102,8 @@ func newCreate() *cobra.Command { external location. A managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore. [Learn more] - - [Learn more]: https://docs.databricks.com/aws/en/volumes/managed-vs-external + + [Learn more]: https://docs.databricks.com/aws/en/volumes/managed-vs-external Supported values: [EXTERNAL, MANAGED]` cmd.Annotations = make(map[string]string) @@ -190,9 +190,9 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete a Volume.` cmd.Long = `Delete a Volume. - + Deletes a volume from the specified parent catalog and schema. - + The caller must be a metastore admin or an owner of the volume. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. @@ -266,19 +266,19 @@ func newList() *cobra.Command { cmd.Use = "list CATALOG_NAME SCHEMA_NAME" cmd.Short = `List Volumes.` cmd.Long = `List Volumes. - + Gets an array of volumes for the current metastore under the parent catalog and schema. - + The returned volumes are filtered based on the privileges of the calling user. For example, the metastore admin is able to list all the volumes. A regular user needs to be the owner or have the **READ VOLUME** privilege on the volume to receive the volumes in the response. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. - + There is no guarantee of a specific ordering of the elements in the array. - + PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the @@ -338,9 +338,9 @@ func newRead() *cobra.Command { cmd.Use = "read NAME" cmd.Short = `Get a Volume.` cmd.Long = `Get a Volume. - + Gets a volume from the metastore for a specific catalog and schema. - + The caller must be a metastore admin or an owner of (or have the **READ VOLUME** privilege on) the volume. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and @@ -418,13 +418,13 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update a Volume.` cmd.Long = `Update a Volume. - + Updates the specified volume under the specified parent catalog and schema. - + The caller must be a metastore admin or an owner of the volume. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. - + Currently only the name, the owner or the comment of the volume could be updated. diff --git a/cmd/workspace/warehouses/warehouses.go b/cmd/workspace/warehouses/warehouses.go index 966b886444..ec5d5e0278 100755 --- a/cmd/workspace/warehouses/warehouses.go +++ b/cmd/workspace/warehouses/warehouses.go @@ -95,7 +95,7 @@ func newCreate() *cobra.Command { cmd.Use = "create" cmd.Short = `Create a warehouse.` cmd.Long = `Create a warehouse. - + Creates a new SQL warehouse.` cmd.Annotations = make(map[string]string) @@ -178,7 +178,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete ID" cmd.Short = `Delete a warehouse.` cmd.Long = `Delete a warehouse. - + Deletes a SQL warehouse. Arguments: @@ -269,7 +269,7 @@ func newEdit() *cobra.Command { cmd.Use = "edit ID" cmd.Short = `Update a warehouse.` cmd.Long = `Update a warehouse. - + Updates the configuration for a SQL warehouse. Arguments: @@ -368,7 +368,7 @@ func newGet() *cobra.Command { cmd.Use = "get ID" cmd.Short = `Get warehouse info.` cmd.Long = `Get warehouse info. - + Gets the information for a single SQL warehouse. Arguments: @@ -436,7 +436,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels WAREHOUSE_ID" cmd.Short = `Get SQL warehouse permission levels.` cmd.Long = `Get SQL warehouse permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -504,7 +504,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions WAREHOUSE_ID" cmd.Short = `Get SQL warehouse permissions.` cmd.Long = `Get SQL warehouse permissions. - + Gets the permissions of a SQL warehouse. SQL warehouses can inherit permissions from their root object. @@ -570,7 +570,7 @@ func newGetWorkspaceWarehouseConfig() *cobra.Command { cmd.Use = "get-workspace-warehouse-config" cmd.Short = `Get the workspace configuration.` cmd.Long = `Get the workspace configuration. - + Gets the workspace level configuration that is shared by all SQL warehouses in a workspace.` @@ -620,7 +620,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List warehouses.` cmd.Long = `List warehouses. - + Lists all SQL warehouses that a user has access to.` cmd.Annotations = make(map[string]string) @@ -673,7 +673,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions WAREHOUSE_ID" cmd.Short = `Set SQL warehouse permissions.` cmd.Long = `Set SQL warehouse permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -769,7 +769,7 @@ func newSetWorkspaceWarehouseConfig() *cobra.Command { cmd.Use = "set-workspace-warehouse-config" cmd.Short = `Set the workspace configuration.` cmd.Long = `Set the workspace configuration. - + Sets the workspace level configuration that is shared by all SQL warehouses in a workspace.` @@ -840,7 +840,7 @@ func newStart() *cobra.Command { cmd.Use = "start ID" cmd.Short = `Start a warehouse.` cmd.Long = `Start a warehouse. - + Starts a SQL warehouse. Arguments: @@ -933,7 +933,7 @@ func newStop() *cobra.Command { cmd.Use = "stop ID" cmd.Short = `Stop a warehouse.` cmd.Long = `Stop a warehouse. - + Stops a SQL warehouse. Arguments: @@ -1025,7 +1025,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions WAREHOUSE_ID" cmd.Short = `Update SQL warehouse permissions.` cmd.Long = `Update SQL warehouse permissions. - + Updates the permissions on a SQL warehouse. SQL warehouses can inherit permissions from their root object. diff --git a/cmd/workspace/workspace-bindings/workspace-bindings.go b/cmd/workspace/workspace-bindings/workspace-bindings.go index 194be2961e..a6f7f8b39d 100755 --- a/cmd/workspace/workspace-bindings/workspace-bindings.go +++ b/cmd/workspace/workspace-bindings/workspace-bindings.go @@ -23,19 +23,19 @@ func New() *cobra.Command { __OPEN__ securable can be accessed from any workspace, while an __ISOLATED__ securable can only be accessed from a configured list of workspaces. This API allows you to configure (bind) securables to workspaces. - + NOTE: The __isolation_mode__ is configured for the securable itself (using its Update method) and the workspace bindings are only consulted when the securable's __isolation_mode__ is set to __ISOLATED__. - + A securable's workspace bindings can be configured by a metastore admin or the owner of the securable. - + The original path (/api/2.1/unity-catalog/workspace-bindings/catalogs/{name}) is deprecated. Please use the new path (/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}) which introduces the ability to bind a securable in READ_ONLY mode (catalogs only). - + Securable types that support binding: - catalog - storage_credential - credential - external_location`, GroupID: "catalog", @@ -76,7 +76,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get catalog workspace bindings.` cmd.Long = `Get catalog workspace bindings. - + Gets workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog. @@ -136,13 +136,13 @@ func newGetBindings() *cobra.Command { cmd.Use = "get-bindings SECURABLE_TYPE SECURABLE_NAME" cmd.Short = `Get securable workspace bindings.` cmd.Long = `Get securable workspace bindings. - + Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable. - + NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon. - + PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only @@ -207,7 +207,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update catalog workspace bindings.` cmd.Long = `Update catalog workspace bindings. - + Updates workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog. @@ -282,7 +282,7 @@ func newUpdateBindings() *cobra.Command { cmd.Use = "update-bindings SECURABLE_TYPE SECURABLE_NAME" cmd.Short = `Update securable workspace bindings.` cmd.Long = `Update securable workspace bindings. - + Updates workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable. diff --git a/cmd/workspace/workspace-conf/workspace-conf.go b/cmd/workspace/workspace-conf/workspace-conf.go index 69b6ab2d8c..9a22f2281a 100755 --- a/cmd/workspace/workspace-conf/workspace-conf.go +++ b/cmd/workspace/workspace-conf/workspace-conf.go @@ -58,7 +58,7 @@ func newGetStatus() *cobra.Command { cmd.Use = "get-status KEYS" cmd.Short = `Check configuration status.` cmd.Long = `Check configuration status. - + Gets the configuration status for a workspace.` cmd.Annotations = make(map[string]string) @@ -114,7 +114,7 @@ func newSetStatus() *cobra.Command { cmd.Use = "set-status" cmd.Short = `Enable/disable features.` cmd.Long = `Enable/disable features. - + Sets the configuration status for a workspace, including enabling or disabling it.` diff --git a/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go b/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go index b6674fcfbb..71cb80cbea 100755 --- a/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go +++ b/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go @@ -63,7 +63,7 @@ func newGetWorkspaceAccessDetailLocal() *cobra.Command { cmd.Use = "get-workspace-access-detail-local PRINCIPAL_ID" cmd.Short = `Get workspace access details for a principal.` cmd.Long = `Get workspace access details for a principal. - + Returns the access details for a principal in the current workspace. Allows for checking access details for any provisioned principal (user, service principal, or group) in the current workspace. * Provisioned principal here @@ -131,7 +131,7 @@ func newResolveGroupProxy() *cobra.Command { cmd.Use = "resolve-group-proxy EXTERNAL_ID" cmd.Short = `Resolve an external group in the Databricks account.` cmd.Long = `Resolve an external group in the Databricks account. - + Resolves a group with the given external ID from the customer's IdP. If the group does not exist, it will be created in the account. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an @@ -214,7 +214,7 @@ func newResolveServicePrincipalProxy() *cobra.Command { cmd.Use = "resolve-service-principal-proxy EXTERNAL_ID" cmd.Short = `Resolve an external service principal in the Databricks account.` cmd.Long = `Resolve an external service principal in the Databricks account. - + Resolves an SP with the given external ID from the customer's IdP. If the SP does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error. @@ -296,7 +296,7 @@ func newResolveUserProxy() *cobra.Command { cmd.Use = "resolve-user-proxy EXTERNAL_ID" cmd.Short = `Resolve an external user in the Databricks account.` cmd.Long = `Resolve an external user in the Databricks account. - + Resolves a user with the given external ID from the customer's IdP. If the user does not exist, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error. diff --git a/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go b/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go index b8ae4b6644..08785536e5 100755 --- a/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go +++ b/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go @@ -57,7 +57,7 @@ func newGetPublicWorkspaceSetting() *cobra.Command { cmd.Use = "get-public-workspace-setting NAME" cmd.Short = `Get a workspace setting.` cmd.Long = `Get a workspace setting. - + Get a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for list of setting available via public APIs.` @@ -115,7 +115,7 @@ func newListWorkspaceSettingsMetadata() *cobra.Command { cmd.Use = "list-workspace-settings-metadata" cmd.Short = `List valid setting keys and their metadata.` cmd.Long = `List valid setting keys and their metadata. - + List valid setting keys and metadata. These settings are available to be referenced via GET :method:settingsv2/getpublicworkspacesetting and PATCH :method:settingsv2/patchpublicworkspacesetting APIs` @@ -187,7 +187,7 @@ func newPatchPublicWorkspaceSetting() *cobra.Command { cmd.Use = "patch-public-workspace-setting NAME" cmd.Short = `Update a workspace setting.` cmd.Long = `Update a workspace setting. - + Patch a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for list of setting available via public APIs at workspace level.` diff --git a/cmd/workspace/workspace/workspace.go b/cmd/workspace/workspace/workspace.go index 502b11fdb7..a0399d1bf0 100755 --- a/cmd/workspace/workspace/workspace.go +++ b/cmd/workspace/workspace/workspace.go @@ -23,7 +23,7 @@ func New() *cobra.Command { Short: `The Workspace API allows you to list, import, export, and delete notebooks and folders.`, Long: `The Workspace API allows you to list, import, export, and delete notebooks and folders. - + A notebook is a web-based interface to a document that contains runnable code, visualizations, and explanatory text.`, GroupID: "workspace", @@ -75,13 +75,13 @@ func newDelete() *cobra.Command { cmd.Use = "delete PATH" cmd.Short = `Delete a workspace object.` cmd.Long = `Delete a workspace object. - + Deletes an object or a directory (and optionally recursively deletes all objects in the directory). * If path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST. * If path is a non-empty directory and recursive is set to false, this call returns an error DIRECTORY_NOT_EMPTY. - + Object deletion cannot be undone and deleting a directory recursively is not atomic. @@ -185,12 +185,12 @@ func newExport() *cobra.Command { cmd.Use = "export PATH" cmd.Short = `Export a workspace object.` cmd.Long = `Export a workspace object. - + Exports an object or the contents of an entire directory. - + If path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST. - + If the exported data would exceed size limit, this call returns MAX_NOTEBOOK_SIZE_EXCEEDED. Currently, this API does not support exporting a library. @@ -261,7 +261,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID" cmd.Short = `Get workspace object permission levels.` cmd.Long = `Get workspace object permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -319,7 +319,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID" cmd.Short = `Get workspace object permissions.` cmd.Long = `Get workspace object permissions. - + Gets the permissions of a workspace object. Workspace objects can inherit permissions from their parent objects or root object. @@ -378,7 +378,7 @@ func newGetStatus() *cobra.Command { cmd.Use = "get-status PATH" cmd.Short = `Get status.` cmd.Long = `Get status. - + Gets the status of an object or a directory. If path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST. @@ -451,7 +451,7 @@ func newImport() *cobra.Command { cmd.Use = "import PATH" cmd.Short = `Import a workspace object.` cmd.Long = `Import a workspace object. - + Imports a workspace object (for example, a notebook or file) or the contents of an entire directory. If path already exists and overwrite is set to false, this call returns an error RESOURCE_ALREADY_EXISTS. To import a @@ -536,7 +536,7 @@ func newList() *cobra.Command { cmd.Use = "list PATH" cmd.Short = `List contents.` cmd.Long = `List contents. - + Lists the contents of a directory, or the object if it is not a directory. If the input path does not exist, this call returns an error RESOURCE_DOES_NOT_EXIST. @@ -594,11 +594,11 @@ func newMkdirs() *cobra.Command { cmd.Use = "mkdirs PATH" cmd.Short = `Create a directory.` cmd.Long = `Create a directory. - + Creates the specified directory (and necessary parent directories if they do not exist). If there is an object (not a directory) at any prefix of the input path, this call returns an error RESOURCE_ALREADY_EXISTS. - + Note that if this operation fails it may have succeeded in creating some of the necessary parent directories. @@ -698,7 +698,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID" cmd.Short = `Set workspace object permissions.` cmd.Long = `Set workspace object permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their parent objects or root object. @@ -775,7 +775,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID" cmd.Short = `Update workspace object permissions.` cmd.Long = `Update workspace object permissions. - + Updates the permissions on a workspace object. Workspace objects can inherit permissions from their parent objects or root object. diff --git a/tools/post-generate.sh b/tools/post-generate.sh index 84923c69a9..1cdf5a2b71 100755 --- a/tools/post-generate.sh +++ b/tools/post-generate.sh @@ -30,3 +30,6 @@ go tool -modfile=tools/go.mod yamlfmt .github/workflows/tagging.yml # Generate PyDABs code. make -C python codegen + +# Fix whitespace issues in the generated code. +make wsfix diff --git a/tools/validate_whitespace.py b/tools/validate_whitespace.py index 868d45ba65..8fac3bba60 100755 --- a/tools/validate_whitespace.py +++ b/tools/validate_whitespace.py @@ -60,13 +60,41 @@ def validate_contents(data): yield f" {newlines} newlines at the end" +def fix_contents(data): + """Fix whitespace issues in file contents.""" + if not data: + return data + try: + text = data.decode("utf") + except Exception: + # Can't decode, return as-is + return data + + # Split into lines and fix each one + lines = text.split("\n") + fixed_lines = [] + for line in lines: + # Remove trailing whitespace and whitespace-only lines + fixed_lines.append(line.rstrip()) + + # Join lines back together + fixed_text = "\n".join(fixed_lines) + + # Ensure file ends with exactly one newline + fixed_text = fixed_text.rstrip("\n") + "\n" + + return fixed_text.encode("utf") + + def main(): quiet = "-q" in sys.argv + fix_mode = "--fix" in sys.argv files = subprocess.check_output(["git", "ls-files"], encoding="utf-8").split() ignores = load_ignores() n_checked = 0 n_skipped = 0 n_errored = 0 + n_fixed = 0 for f in files: if not os.path.isfile(f): n_skipped += 1 @@ -76,15 +104,30 @@ def main(): continue with open(f, "rb") as file: data = file.read() - error = False - for msg in validate_contents(data): - print(f"{f}:{msg}") - error = True - n_checked += 1 - n_errored += 1 if error else 0 + + if fix_mode: + # Fix whitespace issues + fixed_data = fix_contents(data) + if fixed_data != data: + with open(f, "wb") as file: + file.write(fixed_data) + print(f"{f}: Fixed") + n_fixed += 1 + n_checked += 1 + else: + # Validate mode + error = False + for msg in validate_contents(data): + print(f"{f}:{msg}") + error = True + n_checked += 1 + n_errored += 1 if error else 0 if not quiet: - sys.stderr.write(f"{n_checked} checked, {n_skipped} skipped, {n_errored} failed.\n") + if fix_mode: + sys.stderr.write(f"{n_checked} checked, {n_skipped} skipped, {n_fixed} fixed.\n") + else: + sys.stderr.write(f"{n_checked} checked, {n_skipped} skipped, {n_errored} failed.\n") sys.exit(1 if n_errored else 0) From 10dd023fba7fc213f5c475629af0ecf562bb5890 Mon Sep 17 00:00:00 2001 From: Pieter Noordhuis Date: Mon, 24 Nov 2025 10:01:29 +0100 Subject: [PATCH 5/5] Lint --- cmd/workspace/apps/apps.go | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/cmd/workspace/apps/apps.go b/cmd/workspace/apps/apps.go index 34824ddba0..e9c426af87 100755 --- a/cmd/workspace/apps/apps.go +++ b/cmd/workspace/apps/apps.go @@ -97,7 +97,7 @@ func newCreate() *cobra.Command { cmd.Use = "create NAME" cmd.Short = `Create an app.` cmd.Long = `Create an app. - + Creates a new app. Arguments: @@ -205,20 +205,20 @@ func newCreateUpdate() *cobra.Command { cmd.Use = "create-update APP_NAME UPDATE_MASK" cmd.Short = `Create an app update.` cmd.Long = `Create an app update. - + Creates an app update and starts the update process. The update process is asynchronous and the status of the update can be checked with the GetAppUpdate method. Arguments: - APP_NAME: + APP_NAME: UPDATE_MASK: The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. - + A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the @@ -315,7 +315,7 @@ func newDelete() *cobra.Command { cmd.Use = "delete NAME" cmd.Short = `Delete an app.` cmd.Long = `Delete an app. - + Deletes an app. Arguments: @@ -387,7 +387,7 @@ func newDeploy() *cobra.Command { cmd.Use = "deploy APP_NAME" cmd.Short = `Create an app deployment.` cmd.Long = `Create an app deployment. - + Creates an app deployment for the app with the supplied name. Arguments: @@ -474,7 +474,7 @@ func newGet() *cobra.Command { cmd.Use = "get NAME" cmd.Short = `Get an app.` cmd.Long = `Get an app. - + Retrieves information for the app with the supplied name. Arguments: @@ -530,7 +530,7 @@ func newGetDeployment() *cobra.Command { cmd.Use = "get-deployment APP_NAME DEPLOYMENT_ID" cmd.Short = `Get an app deployment.` cmd.Long = `Get an app deployment. - + Retrieves information for the app deployment with the supplied name and deployment id. @@ -589,7 +589,7 @@ func newGetPermissionLevels() *cobra.Command { cmd.Use = "get-permission-levels APP_NAME" cmd.Short = `Get app permission levels.` cmd.Long = `Get app permission levels. - + Gets the permission levels that a user can have on an object. Arguments: @@ -645,7 +645,7 @@ func newGetPermissions() *cobra.Command { cmd.Use = "get-permissions APP_NAME" cmd.Short = `Get app permissions.` cmd.Long = `Get app permissions. - + Gets the permissions of an app. Apps can inherit permissions from their root object. @@ -702,7 +702,7 @@ func newGetUpdate() *cobra.Command { cmd.Use = "get-update APP_NAME" cmd.Short = `Get an app update.` cmd.Long = `Get an app update. - + Gets the status of an app update. Arguments: @@ -761,7 +761,7 @@ func newList() *cobra.Command { cmd.Use = "list" cmd.Short = `List apps.` cmd.Long = `List apps. - + Lists all apps in the workspace.` cmd.Annotations = make(map[string]string) @@ -812,7 +812,7 @@ func newListDeployments() *cobra.Command { cmd.Use = "list-deployments APP_NAME" cmd.Short = `List app deployments.` cmd.Long = `List app deployments. - + Lists all app deployments for the app with the supplied name. Arguments: @@ -870,7 +870,7 @@ func newSetPermissions() *cobra.Command { cmd.Use = "set-permissions APP_NAME" cmd.Short = `Set app permissions.` cmd.Long = `Set app permissions. - + Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object. @@ -946,7 +946,7 @@ func newStart() *cobra.Command { cmd.Use = "start NAME" cmd.Short = `Start an app.` cmd.Long = `Start an app. - + Start the last active deployment of the app in the workspace. Arguments: @@ -1027,7 +1027,7 @@ func newStop() *cobra.Command { cmd.Use = "stop NAME" cmd.Short = `Stop an app.` cmd.Long = `Stop an app. - + Stops the active deployment of the app in the workspace. Arguments: @@ -1117,7 +1117,7 @@ func newUpdate() *cobra.Command { cmd.Use = "update NAME" cmd.Short = `Update an app.` cmd.Long = `Update an app. - + Updates the app with the supplied name. Arguments: @@ -1191,7 +1191,7 @@ func newUpdatePermissions() *cobra.Command { cmd.Use = "update-permissions APP_NAME" cmd.Short = `Update app permissions.` cmd.Long = `Update app permissions. - + Updates the permissions on an app. Apps can inherit permissions from their root object.