From 65aa2d52910b62a86b32b96d7087c834469fbdce Mon Sep 17 00:00:00 2001 From: "databricks-ci-ghec-2[bot]" <184307802+databricks-ci-ghec-2[bot]@users.noreply.github.com> Date: Tue, 10 Nov 2026 04:02:34 +0000 Subject: [PATCH] Update Go SDK to v0.196.0 --- .codegen/_openapi_sha | 2 +- .codegen/cli.json | 7290 +++++++++++++---- .gitattributes | 2 + .../dependency-updates/go-sdk-v0.196.0.md | 1 + .../refschema/output/materialization_sets.txt | 3 + .../output/vector_search_endpoints.txt | 5 + .../direct/dresources/apitypes.generated.yml | 2 + ...internal_immutable_snapshots.generated.yml | 5 + bundle/schema/jsonschema.json | 129 +- cmd/account/iam-v2/iam-v2.go | 504 +- cmd/account/settings-v2/settings-v2.go | 2 + cmd/workspace/ai-search/ai-search.go | 6 +- cmd/workspace/cmd.go | 4 + .../feature-engineering.go | 137 + cmd/workspace/lakewatch/lakewatch.go | 62 +- cmd/workspace/postgres/postgres.go | 1316 ++- .../serverless-compute-service.go | 190 + .../software-artifacts/software-artifacts.go | 512 ++ .../workspace-iam-v2/workspace-iam-v2.go | 466 +- .../workspace-settings-v2.go | 2 + go.mod | 2 +- go.sum | 4 +- .../_models/confidential_compute_type.py | 2 - .../clusters/_models/gcp_attributes.py | 4 +- .../bundles/features/_models/sdp_source.py | 4 +- .../jobs/_models/confidential_compute_type.py | 2 - .../bundles/jobs/_models/cron_schedule.py | 4 +- .../bundles/jobs/_models/gcp_attributes.py | 4 +- .../_models/sql_condition_configuration.py | 16 +- .../_models/sql_condition_trigger_mode.py | 6 +- .../bundles/jobs/_models/subscription.py | 4 +- .../jobs/_models/subscription_attachment.py | 8 +- ...subscription_attachment_data_attachment.py | 12 +- ...ption_attachment_data_attachment_widget.py | 8 +- ...subscription_attachment_page_attachment.py | 8 +- .../jobs/_models/trigger_configuration.py | 4 +- .../bundles/jobs/_models/trigger_settings.py | 4 +- .../bundles/materialization_sets/__init__.py | 8 + .../_models/cron_schedule.py | 26 + .../_models/external_trigger.py | 35 + .../_models/materialized_feature.py | 22 + .../_models/table_trigger.py | 26 + ...el_service_config_external_model_config.py | 8 +- .../_models/confidential_compute_type.py | 2 - .../pipelines/_models/gcp_attributes.py | 4 +- 45 files changed, 8631 insertions(+), 2236 deletions(-) create mode 100644 .nextchanges/dependency-updates/go-sdk-v0.196.0.md create mode 100644 bundle/direct/dresources/configs/internal_immutable_snapshots.generated.yml create mode 100644 cmd/workspace/serverless-compute-service/serverless-compute-service.go create mode 100644 cmd/workspace/software-artifacts/software-artifacts.go create mode 100644 python/databricks/bundles/materialization_sets/_models/external_trigger.py diff --git a/.codegen/_openapi_sha b/.codegen/_openapi_sha index d583f8ce571..c30e448de57 100644 --- a/.codegen/_openapi_sha +++ b/.codegen/_openapi_sha @@ -1 +1 @@ -ced34d63e64d234affc3213758ac687edbf6f3c3 \ No newline at end of file +7346efba99de661d9327d805d92dc67f461933c1 \ No newline at end of file diff --git a/.codegen/cli.json b/.codegen/cli.json index be795c9140e..636dae966b1 100644 --- a/.codegen/cli.json +++ b/.codegen/cli.json @@ -697,7 +697,7 @@ ] }, "source_type": { - "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.", + "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.\nWhile the workspace's default-source-type rollout flag is on, omitted or UNSPECIFIED is stored\nas AGENT. While it is off, omitted is stored unset and UNSPECIFIED as UNSPECIFIED.", "ref": "agentkit.ManagedMemoryEntrySourceType", "launch_stage": "PUBLIC_BETA", "behaviors": [ @@ -2181,6 +2181,36 @@ "aisearch.EndpointScalingInfo": { "description": "Scaling information for a Standard endpoint: the current scaling state, the requested QPS\ntarget, and the progress of an in-progress scaling change.", "fields": { + "delayed_reason": { + "description": "Reason the in-progress scaling change is delayed. When set, `estimated_completion_time` is\nunset. Unset when the change is not delayed or no scaling change is in progress.", + "ref": "aisearch.EndpointScalingInfoDelayReason", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "estimated_completion_time": { + "description": "Estimated time at which the in-progress scaling change will complete. The estimate may\nchange as the scaling change progresses. Unset when no scaling change is in progress,\nwhen no estimate is available, or when the change is delayed (see `delayed_reason`).", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "index_initialization_percentage": { + "description": "Percentage of index initialization completed, from 0 to 100. Set only during the\n`INITIALIZING_INDEX` phase; unset in other phases or when progress is not available.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "phase": { + "description": "Current phase of the in-progress scaling change. Unset when no scaling change is in\nprogress or the phase is not available.", + "ref": "aisearch.EndpointScalingInfoPhase", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, "requested_target_qps": { "description": "The requested QPS target for the endpoint. Best-effort; the system does not\nguarantee this QPS will be achieved.", "launch_stage": "PUBLIC_PREVIEW", @@ -2195,9 +2225,42 @@ "behaviors": [ "OUTPUT_ONLY" ] + }, + "target_qps_change_allowed_after_time": { + "description": "Earliest time a new Target QPS change is accepted. Set only while a scaling change is in\nprogress, the change lock is on, and the endpoint has a recorded last throughput change; may\nbe in the past once the lock has expired.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] } } }, + "aisearch.EndpointScalingInfoDelayReason": { + "description": "Reason an in-progress scaling change is delayed.", + "enum": [ + "CAPACITY_UNAVAILABLE", + "SCALE_DOWN_BLOCKED", + "TAKING_LONGER_THAN_EXPECTED" + ], + "enum_launch_stages": { + "CAPACITY_UNAVAILABLE": "PUBLIC_BETA", + "SCALE_DOWN_BLOCKED": "PUBLIC_BETA", + "TAKING_LONGER_THAN_EXPECTED": "PUBLIC_BETA" + } + }, + "aisearch.EndpointScalingInfoPhase": { + "description": "Phase of an in-progress scaling change.", + "enum": [ + "ADJUSTING_CAPACITY", + "INITIALIZING_INDEX", + "ESTIMATING" + ], + "enum_launch_stages": { + "ADJUSTING_CAPACITY": "PUBLIC_BETA", + "ESTIMATING": "PUBLIC_BETA", + "INITIALIZING_INDEX": "PUBLIC_BETA" + } + }, "aisearch.EndpointStatus": { "description": "Lifecycle and health state of an AI Search endpoint, along with any human-readable detail\nabout that state.", "fields": { @@ -12814,7 +12877,7 @@ "description": "Configuration for an external-foundation-model destination. Provider auth\nand provider-specific cloud configuration are owned by a separate, governed\nModelProviderService entity referenced via `model_provider_service`; the\nplatform resolves the provider at invocation time.", "fields": { "model_provider_service": { - "description": "Resource name of the governed ModelProviderService that owns provider\nauth and provider-specific configuration. The referenced\nModelProviderService also carries the provider type, so this message\ndoes not surface it directly.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.", + "description": "Resource name of the governed ModelProviderService that owns provider\nauth and provider-specific configuration.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.", "launch_stage": "GA" }, "target": { @@ -17808,6 +17871,21 @@ } } }, + "compute.AllowedComputeProducts": { + "description": "Compute products allowed by a policy and their product-specific constraints. At least one\nproduct must be set.", + "fields": { + "automated": { + "description": "Constraints for serverless automated compute. Absence disallows automated compute.", + "ref": "compute.AutomatedConstraints", + "launch_stage": "PRIVATE_PREVIEW" + }, + "lakebase": { + "description": "Constraints for Lakebase instances. Absence disallows Lakebase.", + "ref": "compute.LakebaseConstraints", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "compute.AutoScale": { "fields": { "max_workers": { @@ -17820,6 +17898,16 @@ } } }, + "compute.AutomatedConstraints": { + "description": "Constraints applied to serverless automated workloads by a compute policy.", + "fields": { + "per_workload_max": { + "description": "Maximum per-workload Spark executor allocation. Absence imposes no limit.", + "ref": "compute.RateLimitConfig", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "compute.AwsAttributes": { "description": "Attributes set during cluster creation which are related to Amazon Web Services.", "fields": { @@ -18922,6 +19010,56 @@ } } }, + "compute.ComputePolicy": { + "description": "A compute policy resource. A workspace-scoped policy that allows one or more compute products,\neach with product-specific constraints.", + "fields": { + "allowed_compute_products": { + "description": "The compute products allowed by this policy and their constraints. At least one product must\nbe set.", + "ref": "compute.AllowedComputeProducts", + "launch_stage": "PRIVATE_PREVIEW" + }, + "can_manage": { + "description": "Whether the calling user has manage permission on this compute policy. Manage includes use, so\ncan_use is also true whenever this is true.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "can_use": { + "description": "Whether the calling user has use permission on this compute policy.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "compute_policy_id": { + "description": "The unique identifier of the compute policy (UUID). Server-assigned on create.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "create_time": { + "description": "The creation timestamp.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "display_name": { + "description": "The display name of the compute policy.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "is_default": { + "description": "Whether this is the workspace default policy for its single allowed compute product. Default\npolicies are system-provisioned and cannot be deleted or renamed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "tags": { + "description": "User-defined key/value tags on the compute policy, provided at creation and validated.\nunified-tagging is the system of record for tag assignments.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "compute.ConfidentialComputeType": { "description": "Confidential computing technology for GCP instances.\nAligns with gcloud's --confidential-compute-type flag and the REST API's\nconfidentialInstanceConfig.confidentialInstanceType field.\nSee: https://cloud.google.com/confidential-computing/confidential-vm/docs/create-a-confidential-vm-instance", "enum": [ @@ -18929,8 +19067,8 @@ "SEV_SNP" ], "enum_launch_stages": { - "CONFIDENTIAL_COMPUTE_TYPE_NONE": "PRIVATE_PREVIEW", - "SEV_SNP": "PRIVATE_PREVIEW" + "CONFIDENTIAL_COMPUTE_TYPE_NONE": "PUBLIC_BETA", + "SEV_SNP": "PUBLIC_BETA" } }, "compute.ContextStatus": { @@ -20207,7 +20345,7 @@ "confidential_compute_type": { "description": "The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", "ref": "compute.ConfidentialComputeType", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" }, "first_on_demand": { "description": "The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster.", @@ -21142,6 +21280,19 @@ "CLASSIC_PREVIEW": "GA" } }, + "compute.LakebaseConstraints": { + "description": "Constraints applied to Lakebase instances by a compute policy.", + "fields": { + "max_capacity_units_per_instance": { + "description": "Maximum capacity units permitted per instance. Absence imposes no limit.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "max_idle_minutes_before_scale_to_zero": { + "description": "Maximum idle time in minutes before scale-to-zero. Absence imposes no requirement.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "compute.Language": { "enum": [ "python", @@ -21396,6 +21547,37 @@ "DEFAULT": "GA" } }, + "compute.ListComputePoliciesRequest": { + "fields": { + "page_size": { + "description": "Maximum number of policies to return per response. Unset or zero defaults to 100. The server\ncaps requests above 150.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Token for cursor-based pagination.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "compute.ListComputePoliciesResponse": { + "description": "Response for listing compute policies.", + "fields": { + "compute_policies": { + "description": "The list of compute policies.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_page_token": { + "description": "Token for the next page of results. Empty if no more results.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "compute.ListGlobalInitScriptsRequest": {}, "compute.ListGlobalInitScriptsResponse": { "fields": { @@ -21462,6 +21644,37 @@ } } }, + "compute.ListServerlessComputesRequest": { + "fields": { + "page_size": { + "description": "Maximum number of computes to return per response. Unset or zero defaults\nto 100. The server caps requests above 150 to bound per-request RBAC fan-out.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Token for cursor-based pagination.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "compute.ListServerlessComputesResponse": { + "description": "Response for listing serverless computes.", + "fields": { + "next_page_token": { + "description": "Token for the next page of results. Empty if no more results.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "serverless_computes": { + "description": "The list of serverless computes.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "compute.ListSortColumn": { "enum": [ "POLICY_CREATION_TIME", @@ -21812,6 +22025,22 @@ } } }, + "compute.RateLimitConfig": { + "description": "Rate-limit configuration for serverless compute workloads.", + "fields": { + "t_shirt_size": { + "ref": "compute.TshirtSize", + "launch_stage": "PRIVATE_PREVIEW" + }, + "t_shirt_size_name": { + "description": "Proto enum name of t_shirt_size (e.g. T_SHIRT_SIZE_SMALL). Output-only; derived\non read so a minting client that does not know a new enum value can still put\nthe name on the cost-control token.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, "compute.RemoveInstanceProfile": { "fields": { "instance_profile_arn": { @@ -21955,6 +22184,50 @@ } } }, + "compute.ServerlessCompute": { + "description": "A serverless compute resource.", + "fields": { + "can_manage": { + "description": "Whether the calling user has ManageServerlessComputePermission on this compute.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "can_use": { + "description": "Whether the calling user has UseServerlessComputePermission on this compute.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "create_time": { + "description": "The creation timestamp.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "is_default": { + "description": "Whether this is the workspace default compute for its compute_type.\nDefault computes are system-provisioned and cannot be deleted or renamed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The display name of the serverless compute.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "serverless_compute_id": { + "description": "The unique identifier of the serverless compute (UUID).", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, "compute.SparkNode": { "description": "Describes a specific Spark driver or executor.", "fields": { @@ -22457,6 +22730,29 @@ "SUCCESS": "GA" } }, + "compute.TshirtSize": { + "description": "T-shirt size for per-workload Spark executor limits.", + "enum": [ + "T_SHIRT_SIZE_UNSPECIFIED", + "T_SHIRT_SIZE_SMALL", + "T_SHIRT_SIZE_MEDIUM", + "T_SHIRT_SIZE_LARGE", + "T_SHIRT_SIZE_X_LARGE", + "T_SHIRT_SIZE_2X_LARGE", + "T_SHIRT_SIZE_3X_LARGE", + "T_SHIRT_SIZE_4X_LARGE" + ], + "enum_launch_stages": { + "T_SHIRT_SIZE_2X_LARGE": "PRIVATE_PREVIEW", + "T_SHIRT_SIZE_3X_LARGE": "PRIVATE_PREVIEW", + "T_SHIRT_SIZE_4X_LARGE": "PRIVATE_PREVIEW", + "T_SHIRT_SIZE_LARGE": "PRIVATE_PREVIEW", + "T_SHIRT_SIZE_MEDIUM": "PRIVATE_PREVIEW", + "T_SHIRT_SIZE_SMALL": "PRIVATE_PREVIEW", + "T_SHIRT_SIZE_UNSPECIFIED": "PRIVATE_PREVIEW", + "T_SHIRT_SIZE_X_LARGE": "PRIVATE_PREVIEW" + } + }, "compute.UninstallLibraries": { "fields": { "cluster_id": { @@ -25121,7 +25417,7 @@ "launch_stage": "GA" }, "purpose": { - "description": "Purpose of this text attachment. A completed message may contain more than\none text attachment (for example a clarifying follow-up question alongside\nthe final answer); use this field to tell them apart. `TEXT_ATTACHMENT_PURPOSE_ANSWER`\nmarks the final answer/summary and `FOLLOW_UP_QUESTION` marks a clarifying question.", + "description": "Purpose of this text attachment. A completed message may contain more than\none text attachment (for example a clarifying follow-up question alongside\nthe final answer); use this field to tell them apart. `TEXT_ATTACHMENT_PURPOSE_ANSWER`\nmarks the final answer/summary and `FOLLOW_UP_QUESTION` marks a clarifying question.\nAgent-mode messages return the answer as their only text attachment.", "ref": "dashboards.TextAttachmentPurpose", "launch_stage": "GA" } @@ -31273,7 +31569,7 @@ "iamv2.CreateDirectGroupMemberProxyRequest": { "fields": { "direct_group_member": { - "description": "Required. The group membership to create.", + "description": "The member to add. Set its `principal_id`.", "ref": "iamv2.DirectGroupMember", "launch_stage": "GA" } @@ -31282,7 +31578,7 @@ "iamv2.CreateDirectGroupMemberRequest": { "fields": { "direct_group_member": { - "description": "Required. The direct group member to be added to the group.", + "description": "The member to add. Set its `principal_id`.", "ref": "iamv2.DirectGroupMember", "launch_stage": "GA" } @@ -31291,12 +31587,12 @@ "iamv2.CreateGroupProxyRequest": { "fields": { "group": { - "description": "Required. Group to be created in Databricks", + "description": "The group to create.", "ref": "iamv2.Group", "launch_stage": "GA" }, "parent": { - "description": "The resource name of the account to create the group in, `accounts/{account_id}`.\nOptional: defaults to the account of the calling workspace, and any other account is\nrejected.", + "description": "The resource name of the account to create the group in, in the format `accounts/{account_id}`.\nDefaults to the account that contains this workspace. Any other account is rejected.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -31307,7 +31603,7 @@ "iamv2.CreateGroupRequest": { "fields": { "group": { - "description": "Required. Group to be created in Databricks", + "description": "The group to create.", "ref": "iamv2.Group", "launch_stage": "GA" } @@ -31316,12 +31612,12 @@ "iamv2.CreateIdentityVisibilityFilterRequest": { "fields": { "identity_visibility_filter": { - "description": "Required. The filter to create. Set `principal_type` to `GROUP` and specify exactly one of\n`exact`, `prefix`, or `regex`. The server assigns the resource name; any supplied `name` is ignored.", + "description": "The filter to create. Set `principal_type` to `GROUP` and exactly one of `exact`, `prefix`,\nor `regex`. Databricks sets `name`, so any value you set is ignored.", "ref": "iamv2.IdentityVisibilityFilter", "launch_stage": "GA" }, "identity_visibility_filter_id": { - "description": "Optional. The ID to use for the filter, which becomes the final component of its resource name.\nIf not specified or empty, the server generates one. Must not contain `/`.", + "description": "The ID to give the filter, which becomes the last part of its resource name. If you leave it\nempty, Databricks generates one. It can't contain `/`.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -31332,14 +31628,14 @@ "iamv2.CreateServicePrincipalProxyRequest": { "fields": { "parent": { - "description": "The resource name of the account to create the service principal in, `accounts/{account_id}`.\nOptional: defaults to the account of the calling workspace, and any other account is\nrejected.", + "description": "The resource name of the account to create the service principal in, in the format\n`accounts/{account_id}`. Defaults to the account that contains this workspace. Any other\naccount is rejected.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "service_principal": { - "description": "Required. Service principal to be created in Databricks", + "description": "The service principal to create.", "ref": "iamv2.ServicePrincipal", "launch_stage": "GA" } @@ -31348,7 +31644,7 @@ "iamv2.CreateServicePrincipalRequest": { "fields": { "service_principal": { - "description": "Required. Service principal to be created in Databricks", + "description": "The service principal to create.", "ref": "iamv2.ServicePrincipal", "launch_stage": "GA" } @@ -31357,14 +31653,14 @@ "iamv2.CreateUserProxyRequest": { "fields": { "parent": { - "description": "The resource name of the account to create the user in, `accounts/{account_id}`.\nOptional: defaults to the account of the calling workspace, and any other account is\nrejected.", + "description": "The resource name of the account to create the user in, in the format\n`accounts/{account_id}`. Defaults to the account that contains this workspace. Any other\naccount is rejected.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "user": { - "description": "Required. User to be created in Databricks", + "description": "The user to create.", "ref": "iamv2.User", "launch_stage": "GA" } @@ -31373,7 +31669,7 @@ "iamv2.CreateUserRequest": { "fields": { "user": { - "description": "Required. User to be created in Databricks", + "description": "The user to create.", "ref": "iamv2.User", "launch_stage": "GA" } @@ -31400,14 +31696,14 @@ "iamv2.CreateWorkspaceAssignmentProxyRequest": { "fields": { "parent": { - "description": "The resource name of the workspace to assign the principal to,\n`accounts/{account_id}/workspaces/{workspace_id}`. Optional: defaults to the calling workspace,\nand any other workspace is rejected.", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`. Defaults to this workspace. Any other\nworkspace is rejected.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "workspace_assignment": { - "description": "Required. Workspace assignment to be created in Databricks.", + "description": "The assignment to create. Set its `principal_id` and `entitlements`.", "ref": "iamv2.WorkspaceAssignment", "launch_stage": "GA" } @@ -31416,7 +31712,7 @@ "iamv2.CreateWorkspaceAssignmentRequest": { "fields": { "workspace_assignment": { - "description": "Required. Workspace assignment to be created in Databricks.", + "description": "The assignment to create. Set its `principal_id` and `entitlements`.", "ref": "iamv2.WorkspaceAssignment", "launch_stage": "GA" } @@ -31436,24 +31732,24 @@ "iamv2.DeleteWorkspaceAssignmentProxyRequest": {}, "iamv2.DeleteWorkspaceAssignmentRequest": {}, "iamv2.DirectGroupMember": { - "description": "Represents a principal that is a direct member of a group, with its source of membership.", + "description": "A user, service principal, or group that's a direct member of a group.", "fields": { "display_name": { - "description": "Display name of the principal.", + "description": "The member's display name.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "external_id": { - "description": "The external ID of the principal in the customer's IdP.", + "description": "The ID of the member in your identity provider (IdP).", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "group_id": { - "description": "The internal ID of the group this member belongs to.", + "description": "The Databricks ID of the group.", "launch_stage": "GA", "behaviors": [ "OPTIONAL", @@ -31461,7 +31757,7 @@ ] }, "membership_source": { - "description": "The source of group membership (internal or from identity provider).", + "description": "Where the membership comes from.", "ref": "iamv2.GroupMembershipSource", "launch_stage": "GA", "behaviors": [ @@ -31469,11 +31765,11 @@ ] }, "name": { - "description": "The resource name of the group membership. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}\n- Workspace-scoped: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`\n- Workspace APIs: `groups/{group_id}/direct-members/{principal_id}`", "launch_stage": "GA" }, "parent": { - "description": "The resource name of the group that contains the membership. The format depends on the API\nthat returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -31481,14 +31777,14 @@ ] }, "principal_id": { - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" ] }, "principal_type": { - "description": "The type of the principal (user/service principal/group).", + "description": "Whether the member is a user, service principal, or group.", "ref": "iamv2.PrincipalType", "launch_stage": "GA", "behaviors": [ @@ -31498,6 +31794,7 @@ } }, "iamv2.Entitlement": { + "description": "A permission to use part of a Databricks workspace.", "enum": [ "WORKSPACE_ACCESS", "WORKSPACE_CONSUME", @@ -31516,10 +31813,10 @@ } }, "iamv2.ExactMatchRule": { - "description": "An exact-match rule that matches a group's external ID from the identity provider.", + "description": "A rule that matches a group by its ID in your identity provider (IdP).", "fields": { "external_id": { - "description": "The identity provider's external ID for the group to match. This is not the Databricks group ID.\nThe value must be non-empty and is matched exactly, including case.", + "description": "The ID of the group in your IdP, not its Databricks ID. It's matched exactly, including case.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" @@ -31528,38 +31825,38 @@ } }, "iamv2.ExternalGroup": { - "description": "An external group from the customer's Identity Provider, resolved into\nDatabricks. This is a read-only resource keyed by the IdP external ID.\nThe Get method may trigger an idempotent sync from the customer's IdP to\nprovision or refresh the group's data in Databricks.", + "description": "A group from your identity provider (IdP), identified by its ID in your IdP. This resource is\nread-only. Getting an external group syncs its name and parent groups from your IdP, and adds\nit to your account if it isn't already there. If your account has group visibility filters, the\ngroup must match them.", "fields": { "account_id": { - "description": "The parent account ID, from Databricks.", + "description": "The ID of the account that contains the group.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "display_name": { - "description": "Display name of the group from the customer's IdP.", + "description": "The name of the group, from your IdP. It's the same as the group's `group_name`.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "external_group_id": { - "description": "The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "internal_id": { - "description": "Internal groupId of the group in Databricks.", + "description": "The Databricks ID of the group. Use it as the `group_id` in the group APIs.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "name": { - "description": "The resource name of the external group. The format depends on the API that\nreturned it:\n- Account-scoped: accounts/{account_id}/external-groups/{external_group_id}\n- Workspace-scoped: external-groups/{external_group_id}", + "description": "The resource name of the external group, in one of these formats:\n- Account APIs: `accounts/{account_id}/external-groups/{external_group_id}`\n- Workspace APIs: `external-groups/{external_group_id}`", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -31568,17 +31865,17 @@ } }, "iamv2.ExternalServicePrincipal": { - "description": "An external service principal from the customer's Identity Provider, resolved\ninto Databricks. This is a read-only resource keyed by the IdP external ID.\nThe Get method may trigger an idempotent sync from the customer's IdP to\nprovision or refresh the service principal's data in Databricks.", + "description": "A service principal from your identity provider (IdP), identified by its ID in your IdP. This\nresource is read-only and requires Microsoft Entra ID as your IdP. Getting an external service\nprincipal syncs its details and group memberships from your IdP, and adds it to your account if\nit isn't already there.", "fields": { "account_id": { - "description": "The parent account ID, from Databricks.", + "description": "The ID of the account that contains the service principal.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "account_sp_status": { - "description": "The activity status of the service principal in the Databricks account.", + "description": "Whether the service principal is active in the account.", "ref": "iamv2.State", "launch_stage": "GA", "behaviors": [ @@ -31586,35 +31883,35 @@ ] }, "application_id": { - "description": "Application ID of the service principal, from the customer's IdP.", + "description": "The service principal's application ID, from your IdP.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "display_name": { - "description": "Display name of the service principal, from the customer's IdP.", + "description": "The service principal's display name, from your IdP.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "external_service_principal_id": { - "description": "The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "internal_id": { - "description": "Internal servicePrincipalId of the service principal in Databricks.", + "description": "The Databricks ID of the service principal. Use it as the `service_principal_id` in the\nservice principal APIs.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "name": { - "description": "The resource name of the external service principal. The format depends on\nthe API that returned it:\n- Account-scoped: accounts/{account_id}/external-service-principals/{external_service_principal_id}\n- Workspace-scoped: external-service-principals/{external_service_principal_id}", + "description": "The resource name of the external service principal, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/external-service-principals/{external_service_principal_id}`\n- Workspace APIs: `external-service-principals/{external_service_principal_id}`", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -31623,17 +31920,17 @@ } }, "iamv2.ExternalUser": { - "description": "An external user from the customer's Identity Provider, resolved into\nDatabricks. This is a read-only resource that allows customers to look up\nexternal user identities by their IdP external ID and retrieve the\ncorresponding Databricks internal ID and metadata. The Get method may\ntrigger an idempotent sync from the customer's IdP to provision or refresh\nthe user's data in Databricks.", + "description": "A user from your identity provider (IdP), identified by their ID in your IdP. This resource is\nread-only. Getting an external user syncs the user's details and group memberships from your\nIdP, and adds the user to your account if they aren't already there.", "fields": { "account_id": { - "description": "The parent account ID, from Databricks.", + "description": "The ID of the account that contains the user.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "account_user_status": { - "description": "The activity status of the user in the Databricks account.", + "description": "Whether the user is active in the account.", "ref": "iamv2.State", "launch_stage": "GA", "behaviors": [ @@ -31641,21 +31938,21 @@ ] }, "display_name": { - "description": "Display name of the user from the customer's IdP.", + "description": "The user's given and family names from your IdP, separated by a space.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "external_user_id": { - "description": "The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "full_name": { - "description": "The full name of the user, from the customer's IdP.", + "description": "The user's name, from your IdP.", "ref": "iamv2.FullName", "launch_stage": "GA", "behaviors": [ @@ -31663,21 +31960,21 @@ ] }, "internal_id": { - "description": "Internal userId of the user in Databricks.", + "description": "The Databricks ID of the user. Use it as the `user_id` in the user APIs.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "name": { - "description": "The resource name of the external user. The format depends on the API that\nreturned it:\n- Account-scoped: accounts/{account_id}/external-users/{external_user_id}\n- Workspace-scoped: external-users/{external_user_id}", + "description": "The resource name of the external user, in one of these formats:\n- Account APIs: `accounts/{account_id}/external-users/{external_user_id}`\n- Workspace APIs: `external-users/{external_user_id}`", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "username": { - "description": "Username/email of the user, from Databricks.", + "description": "The user's username, which is their email address.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -31686,17 +31983,17 @@ } }, "iamv2.FullName": { - "description": "The full name of a user.", + "description": "A user's name, from your identity provider (IdP).", "fields": { "family_name": { - "description": "The family (last) name of the user, from the customer's IdP.", + "description": "The user's family (last) name.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "given_name": { - "description": "The given (first) name of the user, from the customer's IdP.", + "description": "The user's given (first) name.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" @@ -31749,10 +32046,10 @@ "iamv2.GetWorkspaceAssignmentRequest": {}, "iamv2.GetWorkspaceIdentityDetailRequest": {}, "iamv2.Group": { - "description": "The details of a Group resource.", + "description": "A group in your Databricks account.", "fields": { "account_id": { - "description": "The parent account ID for group in Databricks.", + "description": "The ID of the account that contains the group.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -31760,14 +32057,14 @@ ] }, "external_id": { - "description": "ExternalId of the group in the customer's IdP.", + "description": "The ID of the group in your identity provider (IdP).", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "group_id": { - "description": "Internal group ID of the group in Databricks.", + "description": "The Databricks ID of the group.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -31775,18 +32072,18 @@ ] }, "group_name": { - "description": "Display name of the group.", + "description": "The name of the group.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "name": { - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "launch_stage": "GA" }, "parent": { - "description": "The resource name of the account that contains the group, `accounts/{account_id}`. Both the\naccount-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the group, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -31796,7 +32093,7 @@ } }, "iamv2.GroupMembershipSource": { - "description": "The source of the group membership (internal or from identity provider).", + "description": "Where a group membership comes from.", "enum": [ "INTERNAL", "IDENTITY_PROVIDER" @@ -31807,10 +32104,10 @@ } }, "iamv2.IdentityVisibilityFilter": { - "description": "An account-level rule that controls which identity provider groups are discoverable in directory\nsearch and group pickers when automatic identity management is enabled. Filters apply across all\nworkspaces in the account.\n\nIf no group filters are configured, all groups are visible. Otherwise, a group is visible if it\nor any of its transitive parent groups matches at least one rule. A group is also visible if it\nor any transitive parent group is already provisioned in the account. Local Databricks groups\nremain visible regardless of the filters.\n\nOnly group filters can be created. Filters do not change provisioning or sign-in for users and\nservice principals. Filters are immutable: to change a rule, delete it and create a new one.", + "description": "An account-level rule that controls which groups from your identity provider (IdP) can be found\nin directory search and group pickers when automatic identity management is on. Filters apply to\nevery workspace in the account.\n\nIf you have no group filters, all groups are visible. Otherwise, a group is visible if it or any\nof its parent groups matches at least one filter. A group is also visible if it or any of its\nparent groups is already in your account. Local Databricks groups are always visible.\n\nYou can only create group filters. Filters don't affect provisioning or sign-in for users and\nservice principals. You can't change a filter: to change a rule, delete it and create a new one.", "fields": { "exact": { - "description": "Exact match on the group's external ID from the identity provider.", + "description": "Matches a group by its ID in your IdP.", "ref": "iamv2.ExactMatchRule", "launch_stage": "GA", "behaviors": [ @@ -31819,14 +32116,14 @@ ] }, "name": { - "description": "The resource name of the identity-visibility filter.\nFormat: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}", + "description": "The resource name of the filter, in the format\n`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "prefix": { - "description": "Case-sensitive starts-with match on the group's display name.", + "description": "Matches groups whose display name starts with a prefix.", "ref": "iamv2.PrefixMatchRule", "launch_stage": "GA", "behaviors": [ @@ -31835,7 +32132,7 @@ ] }, "principal_type": { - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "ref": "iamv2.PrincipalType", "launch_stage": "GA", "behaviors": [ @@ -31843,7 +32140,7 @@ ] }, "regex": { - "description": "Full, case-sensitive RE2 match on the identity's display name.", + "description": "Matches groups whose display name matches a regular expression.", "ref": "iamv2.RegexMatchRule", "launch_stage": "GA", "behaviors": [ @@ -31855,14 +32152,14 @@ "iamv2.ListDirectGroupMembersProxyRequest": { "fields": { "page_size": { - "description": "The maximum number of members to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of members to return, up to 1000. The default is 1000. A page can contain\nfewer members.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token from a previous list call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -31873,14 +32170,14 @@ "iamv2.ListDirectGroupMembersRequest": { "fields": { "page_size": { - "description": "The maximum number of members to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of members to return, up to 1000. The default is 1000. A page can contain\nfewer members.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListDirectGroupMembers call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -31889,14 +32186,14 @@ } }, "iamv2.ListDirectGroupMembersResponse": { - "description": "Response message for listing direct group members.", + "description": "A page of direct members of a group.", "fields": { "direct_group_members": { - "description": "The list of direct group members with their membership source type.", + "description": "The members on this page.", "launch_stage": "GA" }, "next_page_token": { - "description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "description": "The token for the next page. Not set on the last page.", "launch_stage": "GA" } } @@ -31904,28 +32201,28 @@ "iamv2.ListGroupsProxyRequest": { "fields": { "filter": { - "description": "Optional. Allows filtering groups by group name or external id.", + "description": "Filters groups by `group_name` or `external_id`, for example `group_name eq \"Data engineers\"`.\nPut the value in quotes.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_size": { - "description": "The maximum number of groups to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of groups to return, up to 1000. The default is 1000. A page can contain\nfewer groups.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "parent": { - "description": "The resource name of the account to list groups in, `accounts/{account_id}`. Optional:\ndefaults to the account of the calling workspace, and any other account is rejected.", + "description": "The resource name of the account to list groups in, in the format `accounts/{account_id}`.\nDefaults to the account that contains this workspace. Any other account is rejected.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -31936,21 +32233,21 @@ "iamv2.ListGroupsRequest": { "fields": { "filter": { - "description": "Optional. Allows filtering groups by group name or external id.", + "description": "Filters groups by `group_name` or `external_id`, for example `group_name eq \"Data engineers\"`.\nPut the value in quotes.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_size": { - "description": "The maximum number of groups to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of groups to return, up to 1000. The default is 1000. A page can contain\nfewer groups.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -31959,13 +32256,14 @@ } }, "iamv2.ListGroupsResponse": { - "description": "Response message containing a page of groups in the account.", + "description": "A page of groups.", "fields": { "groups": { + "description": "The groups on this page.", "launch_stage": "GA" }, "next_page_token": { - "description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "description": "The token for the next page. Not set on the last page.", "launch_stage": "GA" } } @@ -31973,14 +32271,14 @@ "iamv2.ListIdentityVisibilityFiltersRequest": { "fields": { "page_size": { - "description": "The maximum number of filters to return. The service may return fewer than this value.\nIf omitted or non-positive, defaults to 100. Values above 1000 are reduced to 1000.", + "description": "The maximum number of filters to return, up to 1000. The default is 100. A page can contain\nfewer filters.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListIdentityVisibilityFilters call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -31989,14 +32287,14 @@ } }, "iamv2.ListIdentityVisibilityFiltersResponse": { - "description": "Response message containing a page of identity-visibility filters in the account.", + "description": "A page of group visibility filters.", "fields": { "identity_visibility_filters": { - "description": "The filters in this page. These are filter rules, not the groups matched by the rules.", + "description": "The filters on this page. These are the rules, not the groups they match.", "launch_stage": "GA" }, "next_page_token": { - "description": "A token, which can be sent as page_token to retrieve the next page. If omitted, there are no subsequent pages.", + "description": "The token for the next page. Not set on the last page.", "launch_stage": "GA" } } @@ -32004,28 +32302,28 @@ "iamv2.ListServicePrincipalsProxyRequest": { "fields": { "filter": { - "description": "Optional. Allows filtering service principals by application id or external id.", + "description": "Filters service principals by `application_id` or `external_id`, for example\n`application_id eq \"\u003capplication-id\u003e\"`. Put the value in quotes.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_size": { - "description": "The maximum number of SPs to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of service principals to return, up to 1000. The default is 1000. A page\ncan contain fewer service principals.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListServicePrincipals call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "parent": { - "description": "The resource name of the account to list service principals in, `accounts/{account_id}`. Optional:\ndefaults to the account of the calling workspace, and any other account is rejected.", + "description": "The resource name of the account to list service principals in, in the format\n`accounts/{account_id}`. Defaults to the account that contains this workspace. Any other\naccount is rejected.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -32036,21 +32334,21 @@ "iamv2.ListServicePrincipalsRequest": { "fields": { "filter": { - "description": "Optional. Allows filtering service principals by application id or external id.", + "description": "Filters service principals by `application_id` or `external_id`, for example\n`application_id eq \"\u003capplication-id\u003e\"`. Put the value in quotes.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_size": { - "description": "The maximum number of service principals to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of service principals to return, up to 1000. The default is 1000. A page\ncan contain fewer service principals.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListServicePrincipals call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -32059,13 +32357,14 @@ } }, "iamv2.ListServicePrincipalsResponse": { - "description": "Response message containing a page of service principals in the account.", + "description": "A page of service principals.", "fields": { "next_page_token": { - "description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "description": "The token for the next page. Not set on the last page.", "launch_stage": "GA" }, "service_principals": { + "description": "The service principals on this page.", "launch_stage": "GA" } } @@ -32073,14 +32372,14 @@ "iamv2.ListTransitiveParentGroupsProxyRequest": { "fields": { "page_size": { - "description": "The maximum number of parent groups to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of groups to return, up to 1000. The default is 1000. A page can contain\nfewer groups.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListTransitiveParentGroups call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -32091,14 +32390,14 @@ "iamv2.ListTransitiveParentGroupsRequest": { "fields": { "page_size": { - "description": "The maximum number of parent groups to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of groups to return, up to 1000. The default is 1000. A page can contain\nfewer groups.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListTransitiveParentGroups call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -32107,14 +32406,14 @@ } }, "iamv2.ListTransitiveParentGroupsResponse": { - "description": "Response message for listing all transitive parent groups of a principal.", + "description": "A page of the groups a principal belongs to.", "fields": { "next_page_token": { - "description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "description": "The token for the next page. Not set on the last page.", "launch_stage": "GA" }, "transitive_parent_groups": { - "description": "The list of transitive parent groups.", + "description": "The groups on this page.", "launch_stage": "GA" } } @@ -32122,28 +32421,28 @@ "iamv2.ListUsersProxyRequest": { "fields": { "filter": { - "description": "Optional. Allows filtering users by username or external id.", + "description": "Filters users by `username` or `external_id`, for example\n`username eq \"someone@example.com\"`. Put the value in quotes.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_size": { - "description": "The maximum number of users to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of users to return, up to 1000. The default is 1000. A page can contain\nfewer users.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "parent": { - "description": "The resource name of the account to list users in, `accounts/{account_id}`. Optional:\ndefaults to the account of the calling workspace, and any other account is rejected.", + "description": "The resource name of the account to list users in, in the format `accounts/{account_id}`.\nDefaults to the account that contains this workspace. Any other account is rejected.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -32154,21 +32453,21 @@ "iamv2.ListUsersRequest": { "fields": { "filter": { - "description": "Optional. Allows filtering users by username or external id.", + "description": "Filters users by `username` or `external_id`, for example\n`username eq \"someone@example.com\"`. Put the value in quotes.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_size": { - "description": "The maximum number of users to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of users to return, up to 1000. The default is 1000. A page can contain\nfewer users.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -32177,12 +32476,14 @@ } }, "iamv2.ListUsersResponse": { + "description": "A page of users.", "fields": { "next_page_token": { - "description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "description": "The token for the next page. Not set on the last page.", "launch_stage": "GA" }, "users": { + "description": "The users on this page.", "launch_stage": "GA" } } @@ -32238,21 +32539,21 @@ "iamv2.ListWorkspaceAssignmentsProxyRequest": { "fields": { "page_size": { - "description": "The maximum number of workspace assignments to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of assignments to return, up to 1000. The default is 1000. A page can\ncontain fewer assignments.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token from a previous list call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "parent": { - "description": "The resource name of the workspace to list assignments of,\n`accounts/{account_id}/workspaces/{workspace_id}`. Optional: defaults to the calling workspace,\nand any other workspace is rejected.", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`. Defaults to this workspace. Any other\nworkspace is rejected.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -32263,14 +32564,14 @@ "iamv2.ListWorkspaceAssignmentsRequest": { "fields": { "page_size": { - "description": "The maximum number of workspace assignments to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of assignments to return, up to 1000. The default is 1000. A page can\ncontain fewer assignments.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "page_token": { - "description": "A page token, received from a previous ListWorkspaceAssignments call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -32279,22 +32580,23 @@ } }, "iamv2.ListWorkspaceAssignmentsResponse": { - "description": "Response message for listing workspace assignments.", + "description": "A page of workspace assignments.", "fields": { "next_page_token": { - "description": "A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "description": "The token for the next page. Not set on the last page.", "launch_stage": "GA" }, "workspace_assignments": { + "description": "The assignments on this page.", "launch_stage": "GA" } } }, "iamv2.PrefixMatchRule": { - "description": "A starts-with rule that matches groups whose display name begins with a specified prefix.\nMatching is case-sensitive. For example, the prefix `data-` matches `data-platform`.", + "description": "A rule that matches groups whose display name starts with a prefix. Matching is case-sensitive.\nFor example, the prefix `data-` matches `data-platform`.", "fields": { "display_name_prefix": { - "description": "The display-name prefix to match. Must contain at least one non-whitespace character.\nLeading and trailing whitespace are preserved, and matching is case-sensitive.", + "description": "The prefix to match. It must contain at least one non-whitespace character. Leading and\ntrailing spaces are kept.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" @@ -32303,7 +32605,7 @@ } }, "iamv2.PrincipalType": { - "description": "The type of the principal (user/sp/group).", + "description": "The type of a principal.", "enum": [ "USER", "SERVICE_PRINCIPAL", @@ -32316,100 +32618,103 @@ } }, "iamv2.RegexMatchRule": { - "description": "A rule that matches an identity whose complete display name matches an RE2 regular expression.\nMatching is case-sensitive. Use .* explicitly when substring matching is desired.", + "description": "A rule that matches groups whose whole display name matches an RE2 regular expression. Matching\nis case-sensitive. To match part of a name, add `.*`, for example `.*-admins`.", "fields": { "display_name_regex": { - "description": "The RE2 regular expression matched against the complete display name.", + "description": "The RE2 regular expression to match against the whole display name. At most 255 characters.", "launch_stage": "GA" } } }, "iamv2.ResolveGroupProxyRequest": { - "description": "Request message for resolving a group with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the group's name and inherited parent groups.", + "description": "Request to resolve a group by its ID in your identity provider (IdP).", "fields": { "external_id": { - "description": "Required. The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "launch_stage": "PUBLIC_BETA" } } }, "iamv2.ResolveGroupRequest": { - "description": "Request message for resolving a group with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the group's name and inherited parent groups.", + "description": "Request to resolve a group by its ID in your identity provider (IdP).", "fields": { "external_id": { - "description": "Required. The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "launch_stage": "PUBLIC_BETA" } } }, "iamv2.ResolveGroupResponse": { + "description": "The response to resolving a group.", "fields": { "group": { - "description": "The group that was resolved.", + "description": "The resolved group.", "ref": "iamv2.Group", "launch_stage": "PUBLIC_BETA" } } }, "iamv2.ResolveServicePrincipalProxyRequest": { - "description": "Request message for resolving a service principal with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the service principal's display name, status, and inherited parent groups.", + "description": "Request to resolve a service principal by its ID in your identity provider (IdP).", "fields": { "external_id": { - "description": "Required. The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "launch_stage": "PUBLIC_BETA" } } }, "iamv2.ResolveServicePrincipalRequest": { - "description": "Request message for resolving a service principal with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the service principal's display name, status, and inherited parent groups.", + "description": "Request to resolve a service principal by its ID in your identity provider (IdP).", "fields": { "external_id": { - "description": "Required. The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "launch_stage": "PUBLIC_BETA" } } }, "iamv2.ResolveServicePrincipalResponse": { + "description": "The response to resolving a service principal.", "fields": { "service_principal": { - "description": "The service principal that was resolved.", + "description": "The resolved service principal.", "ref": "iamv2.ServicePrincipal", "launch_stage": "PUBLIC_BETA" } } }, "iamv2.ResolveUserProxyRequest": { - "description": "Request message for resolving a user with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the user's display name, status, and inherited parent groups.", + "description": "Request to resolve a user by their ID in your identity provider (IdP).", "fields": { "external_id": { - "description": "Required. The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "launch_stage": "PUBLIC_BETA" } } }, "iamv2.ResolveUserRequest": { - "description": "Request message for resolving a user with the given external ID from the customer's IdP into Databricks.\nWill resolve metadata such as the user's display name, status, and inherited parent groups.", + "description": "Request to resolve a user by their ID in your identity provider (IdP).", "fields": { "external_id": { - "description": "Required. The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "launch_stage": "PUBLIC_BETA" } } }, "iamv2.ResolveUserResponse": { + "description": "The response to resolving a user.", "fields": { "user": { - "description": "The user that was resolved.", + "description": "The resolved user.", "ref": "iamv2.User", "launch_stage": "PUBLIC_BETA" } } }, "iamv2.ServicePrincipal": { - "description": "The details of a ServicePrincipal resource.", + "description": "A service principal in your Databricks account.", "fields": { "account_id": { - "description": "The parent account ID for the service principal in Databricks.", + "description": "The ID of the account that contains the service principal.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32417,12 +32722,12 @@ ] }, "account_sp_status": { - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "ref": "iamv2.State", "launch_stage": "GA" }, "application_id": { - "description": "Application ID of the service principal. Set at creation time and cannot be changed\nafterwards; when omitted, the server generates one.", + "description": "The service principal's application ID, a UUID. If you don't set it when you create the\nservice principal, Databricks generates one. It must be unique in the account and can't be\nchanged.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32430,22 +32735,22 @@ ] }, "display_name": { - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "launch_stage": "GA" }, "external_id": { - "description": "ExternalId of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your identity provider (IdP).", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "name": { - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "launch_stage": "GA" }, "parent": { - "description": "The resource name of the account that contains the service principal,\n`accounts/{account_id}`. Both the account-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the service principal, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32453,7 +32758,7 @@ ] }, "service_principal_id": { - "description": "Internal service principal ID of the service principal in Databricks.", + "description": "The Databricks ID of the service principal.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32463,7 +32768,7 @@ } }, "iamv2.State": { - "description": "The activity status of a user or service principal in a Databricks account or workspace.", + "description": "Whether a user or service principal is active in an account or workspace.", "enum": [ "ACTIVE", "INACTIVE" @@ -32474,31 +32779,31 @@ } }, "iamv2.TransitiveParentGroup": { - "description": "Represents a group that is a transitive parent of a principal.", + "description": "A group that a principal belongs to, either directly or through another group.", "fields": { "account_id": { - "description": "The parent account ID for group in Databricks.", + "description": "The ID of the account that contains the group.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "external_id": { - "description": "ExternalId of the group in the customer's IdP.", + "description": "The ID of the group in your identity provider (IdP).", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "group_id": { - "description": "Internal group ID of the group in Databricks.", + "description": "The Databricks ID of the group.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "name": { - "description": "The resource name of the transitive parent group. The format depends on the API that\nreturned it:\n- Account-scoped: accounts/{account_id}/principals/{principal_id}/transitive-parent-groups/{group_id}\n- Workspace-scoped: principals/{principal_id}/transitive-parent-groups/{group_id}", + "description": "The resource name of the parent group, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/principals/{principal_id}/transitive-parent-groups/{group_id}`\n- Workspace APIs: `principals/{principal_id}/transitive-parent-groups/{group_id}`", "launch_stage": "GA" } } @@ -32506,12 +32811,12 @@ "iamv2.UpdateGroupProxyRequest": { "fields": { "group": { - "description": "Required. Group to be updated in Databricks", + "description": "The group to update. Its `name` identifies the group.", "ref": "iamv2.Group", "launch_stage": "GA" }, "update_mask": { - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `group_name` and `external_id`.", "launch_stage": "GA" } } @@ -32519,12 +32824,12 @@ "iamv2.UpdateGroupRequest": { "fields": { "group": { - "description": "Required. Group to be updated in Databricks", + "description": "The group to update. Its `name` identifies the group.", "ref": "iamv2.Group", "launch_stage": "GA" }, "update_mask": { - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `group_name` and `external_id`.", "launch_stage": "GA" } } @@ -32532,12 +32837,12 @@ "iamv2.UpdateServicePrincipalProxyRequest": { "fields": { "service_principal": { - "description": "Required. Service principal to be updated in Databricks", + "description": "The service principal to update. Its `name` identifies the service principal.", "ref": "iamv2.ServicePrincipal", "launch_stage": "GA" }, "update_mask": { - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `display_name`,\n`account_sp_status`, and `external_id`.", "launch_stage": "GA" } } @@ -32545,12 +32850,12 @@ "iamv2.UpdateServicePrincipalRequest": { "fields": { "service_principal": { - "description": "Required. Service Principal to be updated in Databricks", + "description": "The service principal to update. Its `name` identifies the service principal.", "ref": "iamv2.ServicePrincipal", "launch_stage": "GA" }, "update_mask": { - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `display_name`,\n`account_sp_status`, and `external_id`.", "launch_stage": "GA" } } @@ -32558,11 +32863,11 @@ "iamv2.UpdateUserProxyRequest": { "fields": { "update_mask": { - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `full_name.given_name`,\n`full_name.family_name`, `account_user_status`, and `external_id`.", "launch_stage": "GA" }, "user": { - "description": "Required. User to be updated in Databricks", + "description": "The user to update. Its `name` identifies the user.", "ref": "iamv2.User", "launch_stage": "GA" } @@ -32571,11 +32876,11 @@ "iamv2.UpdateUserRequest": { "fields": { "update_mask": { - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `full_name.given_name`,\n`full_name.family_name`, `account_user_status`, and `external_id`.", "launch_stage": "GA" }, "user": { - "description": "Required. User to be updated in Databricks", + "description": "The user to update. Its `name` identifies the user.", "ref": "iamv2.User", "launch_stage": "GA" } @@ -32610,11 +32915,11 @@ "iamv2.UpdateWorkspaceAssignmentProxyRequest": { "fields": { "update_mask": { - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `entitlements`.", "launch_stage": "GA" }, "workspace_assignment": { - "description": "Required. Workspace assignment to be updated in Databricks.", + "description": "The assignment to update. Its `name` identifies the assignment.", "ref": "iamv2.WorkspaceAssignment", "launch_stage": "GA" } @@ -32623,11 +32928,11 @@ "iamv2.UpdateWorkspaceAssignmentRequest": { "fields": { "update_mask": { - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `entitlements`.", "launch_stage": "GA" }, "workspace_assignment": { - "description": "Required. Workspace assignment to be updated in Databricks.", + "description": "The assignment to update. Its `name` identifies the assignment.", "ref": "iamv2.WorkspaceAssignment", "launch_stage": "GA" } @@ -32636,21 +32941,21 @@ "iamv2.UpdateWorkspaceIdentityDetailRequest": { "fields": { "update_mask": { - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `workspace_identity_status`.", "launch_stage": "GA" }, "workspace_identity_detail": { - "description": "Required. Workspace identity detail to be updated in Databricks.", + "description": "The workspace identity detail to update. Its `name` identifies the principal.", "ref": "iamv2.WorkspaceIdentityDetail", "launch_stage": "GA" } } }, "iamv2.User": { - "description": "The details of a User resource.", + "description": "A user in your Databricks account.", "fields": { "account_id": { - "description": "The accountId parent of the user in Databricks.", + "description": "The ID of the account that contains the user.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32658,27 +32963,28 @@ ] }, "account_user_status": { - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "ref": "iamv2.State", "launch_stage": "GA" }, "external_id": { - "description": "ExternalId of the user in the customer's IdP.", + "description": "The ID of the user in your identity provider (IdP).", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "full_name": { + "description": "The user's name.", "ref": "iamv2.UserFullName", "launch_stage": "GA" }, "name": { - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "launch_stage": "GA" }, "parent": { - "description": "The resource name of the account that contains the user, `accounts/{account_id}`. Both the\naccount-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the user, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32686,7 +32992,7 @@ ] }, "user_id": { - "description": "Internal userId of the user in Databricks.", + "description": "The Databricks ID of the user.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32694,7 +33000,7 @@ ] }, "username": { - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" @@ -32703,14 +33009,17 @@ } }, "iamv2.UserFullName": { + "description": "A user's name.", "fields": { "family_name": { + "description": "The user's family (last) name.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "given_name": { + "description": "The user's given (first) name.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -32800,10 +33109,10 @@ } }, "iamv2.WorkspaceAssignment": { - "description": "The direct assignment of a provisioned account-level principal (user, service\nprincipal, or group) to a workspace, together with the entitlements that\nassignment grants in the workspace.\n\nThis resource covers only principals assigned directly to the workspace.\nPrincipals that inherit workspace access through a group are not represented\nhere. See WorkspaceAccessDetail and WorkspaceIdentityDetail for the effective,\ndirect-or-indirect view. Creating the resource assigns the principal to the\nworkspace, and deleting it removes the assignment.\n\n`entitlements` is the only client-settable field. It holds the entitlements\ngranted directly on this assignment, including any the principal also holds\nthrough a group. `effective_entitlements` is the read-only union of those and\nany granted through group membership.\n\nA direct assignment always carries at least one directly-assigned entitlement,\nbecause the assignment is what grants it. Create and update both reject an\nempty `entitlements` set. To remove a principal's assignment entirely, delete\nthe resource.\n\nThis resource replaces workspace assignment previously managed through the\nworkspace SCIM and permission-assignment APIs, and is intended for account\nand workspace admins.", + "description": "A principal's direct assignment to a workspace, and the entitlements it grants there.\n\nOnly principals assigned directly to the workspace have an assignment. A principal that gets\naccess only through a group doesn't. Creating an assignment gives the principal access to the\nworkspace, and deleting it removes that direct access. These APIs replace managing workspace\nassignments through SCIM and the permission assignment APIs. They require a workspace with\nidentity federation enabled. You can't assign, change, or unassign principals that Databricks\nmanages.\n\n`entitlements` is the only field you set. `effective_entitlements` also includes the\nentitlements the principal gets through its groups. An assignment must grant at least one\nentitlement. To remove a principal's direct access, delete the assignment.", "fields": { "account_id": { - "description": "The account ID parent of the workspace where the principal is assigned", + "description": "The ID of the account that contains the workspace.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32811,7 +33120,7 @@ ] }, "effective_entitlements": { - "description": "Every entitlement the principal holds in this workspace, whether granted directly or through\ngroup membership. Get responses populate this field. List responses leave it empty.", + "description": "Every entitlement the principal has in the workspace, granted directly or through a group. List\nresponses leave it empty.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY", @@ -32819,7 +33128,7 @@ ] }, "entitlements": { - "description": "Entitlements granted directly to the principal on this workspace. This is the only\nclient-settable field. Create and update manage exactly this set, including entitlements the\nprincipal also holds through a group.\nList responses leave this field empty. Get a single principal to read its entitlements.", + "description": "The entitlements granted directly by this assignment. Create and update set exactly this list,\neven if the principal also gets some of these entitlements through a group. List responses\nleave it empty.", "launch_stage": "GA", "behaviors": [ "OPTIONAL", @@ -32827,11 +33136,11 @@ ] }, "name": { - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "launch_stage": "GA" }, "parent": { - "description": "The resource name of the workspace that contains the assignment,\n`accounts/{account_id}/workspaces/{workspace_id}`. Both the account-scoped and workspace-scoped\nAPIs return it.", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`. Workspace APIs return the same format.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32839,14 +33148,14 @@ ] }, "principal_id": { - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE" ] }, "principal_type": { - "description": "The type of the principal (user/service principal/group) that is assigned.", + "description": "Whether the assigned principal is a user, service principal, or group.", "ref": "iamv2.PrincipalType", "launch_stage": "GA", "behaviors": [ @@ -32854,7 +33163,7 @@ ] }, "workspace_id": { - "description": "The workspace ID where the principal is assigned.", + "description": "The ID of the workspace.", "launch_stage": "GA", "behaviors": [ "IMMUTABLE", @@ -32912,10 +33221,10 @@ } }, "iamv2.WorkspaceIdentityDetail": { - "description": "The details of a directly or indirectly assigned principal's details in a workspace.", + "description": "A user, service principal, or group's status in a workspace, and whether it has access to the\nworkspace directly or through a group. Update it to activate or deactivate a user or service\nprincipal in the workspace.", "fields": { "assignment_type": { - "description": "The type of assignment the principal has to the workspace (direct or indirect).", + "description": "Whether the principal is assigned to the workspace directly or has access through a group.", "ref": "iamv2.WorkspaceIdentityDetailAssignmentType", "launch_stage": "GA", "behaviors": [ @@ -32923,18 +33232,18 @@ ] }, "name": { - "description": "The resource name of the workspace identity detail.\nFormat: principals/{principal_id}/workspace-identity-detail", + "description": "The resource name of the workspace identity detail, in the format\n`principals/{principal_id}/workspace-identity-detail`.", "launch_stage": "GA" }, "principal_id": { - "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "description": "The Databricks ID of the user, service principal, or group.", "launch_stage": "GA", "behaviors": [ "OUTPUT_ONLY" ] }, "principal_type": { - "description": "The type of the principal (user/service principal/group).", + "description": "Whether the principal is a user, service principal, or group.", "ref": "iamv2.PrincipalType", "launch_stage": "GA", "behaviors": [ @@ -32942,7 +33251,7 @@ ] }, "workspace_identity_status": { - "description": "The activity status of an identity in a Databricks workspace.", + "description": "Whether the principal is active in the workspace. Groups are always `ACTIVE`.", "ref": "iamv2.State", "launch_stage": "GA", "behaviors": [ @@ -32952,7 +33261,7 @@ } }, "iamv2.WorkspaceIdentityDetailAssignmentType": { - "description": "The type of assignment the principal has to the workspace.", + "description": "How a principal has access to a workspace.", "enum": [ "DIRECT", "INDIRECT" @@ -34105,7 +34414,7 @@ "sql_condition": { "description": "SQL condition that must be satisfied before a scheduled run is triggered. The condition is evaluated\nafter the cron expression fires and must return a truthy result for the run to proceed.", "ref": "jobs.SqlConditionConfiguration", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" }, "timezone_id": { "description": "A Java timezone ID. The schedule for a job is resolved with respect to this timezone. See [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details. This field is required.", @@ -35838,7 +36147,7 @@ "sql_condition": { "description": "State for SQL condition evaluation, can coexist with other trigger states.", "ref": "jobs.SqlConditionState", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" }, "table_update": { "ref": "jobs.TableTriggerState", @@ -36342,7 +36651,7 @@ "ai_function_task": { "description": "Resolved values for an AI Function task: the Delta table input with\nupstream-task references replaced by concrete values before the run.", "ref": "jobs.ResolvedValuesAiFunctionTaskResolvedValues", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" }, "ai_runtime_task": { "description": "Resolved values for an AI Runtime task — env_vars with\n`{{tasks.\u003ckey\u003e.values.\u003cname\u003e}}` references substituted to concrete\nvalues before submission to the training service.", @@ -36396,7 +36705,14 @@ } }, "jobs.ResolvedValuesAiFunctionTaskResolvedValues": { - "description": "Resolved values for an AI Function task's Delta table input." + "description": "Resolved values for an AI Function task's Delta table input.", + "fields": { + "delta_table": { + "description": "The Delta table source with any upstream-task references (such as\n`{{tasks.\u003ctask_key\u003e.values.output_table_name}}`) in the table name replaced by concrete\nvalues before the run.", + "ref": "jobs.DeltaTableSource", + "launch_stage": "PUBLIC_BETA" + } + } }, "jobs.ResolvedValuesAiRuntimeTaskResolvedValues": { "description": "Resolved values for an AiRuntimeTask after dynamic-value substitution, so\nJobs can expand `{{tasks.\u003ckey\u003e.values.\u003cname\u003e}}` references before\nsubmission." @@ -37475,16 +37791,16 @@ "fields": { "sql_query_id": { "description": "The ID of the SQL query to evaluate as the trigger condition.", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" }, "trigger_mode": { "description": "Determines how the SQL query result is interpreted to decide whether the condition fires.\nMust be set to a recognized value when provided.\nWhen unset on an existing serialized configuration, the server preserves the original\nsemantics by interpreting it as `QUERY_RETURNS_ROWS`. New configurations should set this\nexplicitly — explicit `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED` is rejected at validation.", "ref": "jobs.SqlConditionTriggerMode", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" }, "warehouse_id": { "description": "The canonical identifier of the SQL warehouse to run the condition query against.", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" } } }, @@ -37492,44 +37808,46 @@ "description": "SQL condition evaluation details captured at the time the run was triggered", "fields": { "condition_evaluation_satisfied": { - "description": "Whether the last condition evaluation was satisfied (query returned truthy result).", - "launch_stage": "PRIVATE_PREVIEW" + "description": "Whether the last condition evaluation was satisfied. For QUERY_RETURNS_ROWS, the query\nreturned at least one row. For RESULT_VALUE_CHANGES, the result value changed.", + "launch_stage": "PUBLIC_BETA" }, "condition_evaluation_sql_session_id": { - "description": "The ID of the SQL session, used by the UI to track session context.\nSet for the QUERY_RETURNS_ROWS trigger mode.", + "description": "The ID of the SQL session of the condition evaluation. Not set by current evaluations.\nUse condition_evaluation_sql_statement_id instead.", + "deprecated": true, "launch_stage": "PRIVATE_PREVIEW" }, "condition_evaluation_sql_statement_id": { - "description": "The SQL statement ID of the condition evaluation, set when the condition is\nevaluated by running a single SQL statement (the RESULT_VALUE_CHANGES trigger\nmode). The UI uses it to link to the query execution details.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "The SQL statement ID of the condition evaluation. Set for both the QUERY_RETURNS_ROWS\nand RESULT_VALUE_CHANGES trigger modes.", + "launch_stage": "PUBLIC_BETA" } } }, "jobs.SqlConditionState": { "fields": { "latest_condition_evaluation_satisfied": { - "description": "Whether the last condition evaluation was satisfied (query returned truthy result).", - "launch_stage": "PRIVATE_PREVIEW" + "description": "Whether the last condition evaluation was satisfied. For QUERY_RETURNS_ROWS, the query\nreturned at least one row. For RESULT_VALUE_CHANGES, the result value changed.", + "launch_stage": "PUBLIC_BETA" }, "latest_condition_evaluation_sql_session_id": { - "description": "The ID of the SQL session, used by UI to track session context.\nPopulated for QUERY_RETURNS_ROWS, which executes the query through Redash.", + "description": "The ID of the SQL session of the latest condition evaluation. Not set by current\nevaluations. Use latest_condition_evaluation_sql_statement_id instead.", + "deprecated": true, "launch_stage": "PRIVATE_PREVIEW" }, "latest_condition_evaluation_sql_statement_id": { - "description": "The SEA statement ID of the SQL statement executed for the latest condition evaluation.\nPopulated for RESULT_VALUE_CHANGES, which executes the query through the SQL execution API.", - "launch_stage": "PRIVATE_PREVIEW" + "description": "The ID of the SQL statement executed for the latest condition evaluation.\nPopulated for both QUERY_RETURNS_ROWS and RESULT_VALUE_CHANGES.", + "launch_stage": "PUBLIC_BETA" } } }, "jobs.SqlConditionTriggerMode": { - "description": "The strategy used to evaluate a SQL condition trigger against a query result set.\n\n* `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`: Sentinel zero-value. Not a valid input — the\nvalidator rejects this when sent explicitly. Internally treated as `QUERY_RETURNS_ROWS`\nwhen reading legacy data that predates this field.\n* `QUERY_RETURNS_ROWS`: Fires whenever the result set has at least one row. Zero rows means\nthe condition is not met. This is the original SQL condition behavior.\n* `RESULT_VALUE_CHANGES`: Fires whenever the query's single result value differs from the\nprevious evaluation. The first evaluation always fires. Queries must return exactly one\ncell (one row, one column).", + "description": "The strategy used to evaluate a SQL condition trigger against a query result set.\n\n* `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`: Sentinel zero-value. Not a valid input — the\nvalidator rejects this when sent explicitly. Internally treated as `QUERY_RETURNS_ROWS`\nwhen reading legacy data that predates this field.\n* `QUERY_RETURNS_ROWS`: Fires whenever the result set has at least one row. Zero rows means\nthe condition is not met. This is the original SQL condition behavior.\n* `RESULT_VALUE_CHANGES`: Fires whenever the query's single result value differs from the\nprevious evaluation. The first evaluation stores the result as a baseline and does not\nfire. Queries must return exactly one cell (one row, one column).", "enum": [ "QUERY_RETURNS_ROWS", "RESULT_VALUE_CHANGES" ], "enum_launch_stages": { - "QUERY_RETURNS_ROWS": "PRIVATE_PREVIEW", - "RESULT_VALUE_CHANGES": "PRIVATE_PREVIEW" + "QUERY_RETURNS_ROWS": "PUBLIC_BETA", + "RESULT_VALUE_CHANGES": "PUBLIC_BETA" }, "enum_descriptions": { "QUERY_RETURNS_ROWS": "Fires whenever the result set has at least one row. Zero rows means", @@ -38145,7 +38463,7 @@ "attachment": { "description": "Optional: The configuration for the files attached to the dashboard snapshot notification. It\ncontrols the underlying data of dashboard widgets that is attached as data files and which\npages are included in the attached PDF. If not specified, the notification is sent with only\nthe default snapshot.", "ref": "jobs.SubscriptionAttachment", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -38170,7 +38488,7 @@ "data_attachment": { "description": "Optional: The configuration for the underlying data of dashboard widgets attached as tabular\ndata files. If not specified, no tabular data is attached.", "ref": "jobs.SubscriptionAttachmentDataAttachment", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -38178,7 +38496,7 @@ "page_attachment": { "description": "Optional: The selection of dashboard pages included in the attached PDF. If not specified,\nonly the first page is included.", "ref": "jobs.SubscriptionAttachmentPageAttachment", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -38191,18 +38509,18 @@ "file_format": { "description": "The file format of the exported tabular data files.", "ref": "jobs.SubscriptionAttachmentDataAttachmentFileFormat", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "include_applied_filters": { "description": "When true, the dashboard's applied filter values are included alongside the tabular data as\nan additional attached file.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] }, "widgets": { "description": "The widgets whose underlying data is exported. At least one widget must be referenced.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" } } }, @@ -38214,9 +38532,9 @@ "FILE_FORMAT_EXCEL" ], "enum_launch_stages": { - "FILE_FORMAT_CSV": "PUBLIC_PREVIEW", - "FILE_FORMAT_EXCEL": "PUBLIC_PREVIEW", - "FILE_FORMAT_TSV": "PUBLIC_PREVIEW" + "FILE_FORMAT_CSV": "GA", + "FILE_FORMAT_EXCEL": "GA", + "FILE_FORMAT_TSV": "GA" } }, "jobs.SubscriptionAttachmentDataAttachmentWidget": { @@ -38224,11 +38542,11 @@ "fields": { "page_id": { "description": "The URL identifier of the page containing the widget. This is the value of the `name`\nfield of the corresponding entry under `pages` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" }, "widget_id": { "description": "The URL identifier of the widget. This is the value of the `name` field of the\ncorresponding widget under that page's `layout` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", - "launch_stage": "PUBLIC_PREVIEW" + "launch_stage": "GA" } } }, @@ -38237,7 +38555,7 @@ "fields": { "page_ids": { "description": "The identifiers of the pages to include in the PDF. Only specified when `page_selection` is\n`PAGE_SELECTION_SUBSET`. Each value is the identifier of a page in the dashboard's\nserialized definition returned by the Get dashboard API (`serialized_dashboard`): the value\nof the `name` field of an entry under `pages`.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -38245,7 +38563,7 @@ "page_selection": { "description": "How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to\ninclude are listed in `page_ids`.", "ref": "jobs.SubscriptionAttachmentPageAttachmentPageSelection", - "launch_stage": "PUBLIC_PREVIEW", + "launch_stage": "GA", "behaviors": [ "OPTIONAL" ] @@ -38259,8 +38577,8 @@ "PAGE_SELECTION_SUBSET" ], "enum_launch_stages": { - "PAGE_SELECTION_ALL": "PUBLIC_PREVIEW", - "PAGE_SELECTION_SUBSET": "PUBLIC_PREVIEW" + "PAGE_SELECTION_ALL": "GA", + "PAGE_SELECTION_SUBSET": "GA" } }, "jobs.SubscriptionSubscriber": { @@ -38782,7 +39100,7 @@ "sql_condition": { "description": "Optional SQL condition that gates whether this trigger fires.", "ref": "jobs.SqlConditionConfiguration", - "launch_stage": "PRIVATE_PREVIEW", + "launch_stage": "PUBLIC_BETA", "behaviors": [ "OPTIONAL" ] @@ -38868,7 +39186,7 @@ "sql_condition": { "description": "SQL condition evaluation details for this run", "ref": "jobs.SqlConditionRunInfoDetails", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" } } }, @@ -38904,7 +39222,7 @@ "sql_condition": { "description": "SQL condition that must be satisfied for the trigger to fire. Can be used in combination with other trigger types and\nruns *after* other trigger types conditions are evaluated.", "ref": "jobs.SqlConditionConfiguration", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" }, "table_update": { "ref": "jobs.TableUpdateTriggerConfiguration", @@ -38933,7 +39251,7 @@ "sql_condition": { "description": "State for SQL condition evaluation, can coexist with other trigger states.", "ref": "jobs.SqlConditionState", - "launch_stage": "PRIVATE_PREVIEW" + "launch_stage": "PUBLIC_BETA" }, "table": { "ref": "jobs.TableTriggerState", @@ -39953,11 +40271,8 @@ ] }, "datasource_name": { - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "IMMUTABLE" - ] + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", + "launch_stage": "PUBLIC_BETA" }, "description": { "description": "Free-form description of the datasource.", @@ -40082,10 +40397,11 @@ ] }, "warehouse_id": { - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", + "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request except a rename-only PATCH; there is no default warehouse. The requester\nmust be able to use the warehouse. It is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", "launch_stage": "PUBLIC_BETA", "behaviors": [ - "INPUT_ONLY" + "INPUT_ONLY", + "OPTIONAL" ] } } @@ -40816,11 +41132,8 @@ ] }, "rule_name": { - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", - "launch_stage": "PUBLIC_BETA", - "behaviors": [ - "IMMUTABLE" - ] + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", + "launch_stage": "PUBLIC_BETA" }, "run_as_principal": { "description": "The principal whose identity this rule's job runs as, given as a\nuser email or service-principal application ID. When supplied on\ncreate/update, Lakewatch resolves the principal, records it on the rule, and\ncreates the delegation to run as that principal — the requester must be\nauthorized to delegate to it, or the request is rejected. When omitted on\ncreate, the requester's own identity is used. An update whose mask does not\ninclude `run_as_principal` keeps the current identity, and the requester must\nstill be authorized to delegate to it; an editor who is not must supply a\nrun_as_principal they can delegate to (for example, their own identity), or\nclear it, either of which reassigns the rule. An update whose mask includes\n`run_as_principal` but supplies no value clears it: the rule then runs as the\nrequester, exactly as when it is omitted on create. Reads return the value as\nsupplied; the identity the rule runs as is reported in\n`effective_run_as_principal`.", @@ -44155,6 +44468,13 @@ "OPTIONAL" ] }, + "paused": { + "description": "Whether automatic materialization is paused. Defaults to `false`.\nSupported only for materializations in a materialization set.\nUse the `UpdateMaterializationSet` API to pause or resume the set.\n\nPausing does not cancel running or queued runs. Runs can still be\ntriggered through the `TriggerMaterializationSet` API. Resuming does\nnot submit a run. Creating a paused materialization skips its initial run.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, "timezone_id": { "description": "A Java timezone ID. The schedule is resolved with respect to this timezone. Defaults to UTC\nwhen omitted. Can only be configured for MANUAL schedules; DERIVED schedules are always aligned\nto UTC.", "launch_stage": "PRIVATE_PREVIEW", @@ -44942,6 +45262,9 @@ } } }, + "ml.ExternalTrigger": { + "description": "A trigger that disables automatic materialization, including the initial run\nat creation. Runs are instead triggered through the `TriggerMaterializationSet`\nAPI. Supported only for batch materializations in a materialization set." + }, "ml.Feature": { "fields": { "catalog_name": { @@ -46951,6 +47274,51 @@ } } }, + "ml.MaterializationRunProgress": { + "description": "Progress of a requested run, which may materialize multiple members of the set.", + "fields": { + "error": { + "description": "The failure, including a failure to submit the run. Present when `state` is `FAILED`.", + "ref": "ml.DatabricksServiceExceptionWithDetailsProto", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "materialized_feature_ids": { + "description": "IDs of the materialized features assigned to this run when the operation was created.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "state": { + "description": "Current state of the requested run.", + "ref": "ml.MaterializationRunProgressState", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "ml.MaterializationRunProgressState": { + "description": "Lifecycle state of a requested materialization run.", + "enum": [ + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ], + "enum_launch_stages": { + "CANCELLED": "PRIVATE_PREVIEW", + "FAILED": "PRIVATE_PREVIEW", + "PENDING": "PRIVATE_PREVIEW", + "RUNNING": "PRIVATE_PREVIEW", + "SUCCEEDED": "PRIVATE_PREVIEW" + } + }, "ml.MaterializationSet": { "description": "A group of materialized features created and managed as a single unit.", "fields": { @@ -47031,6 +47399,14 @@ "OUTPUT_ONLY" ] }, + "trigger_progress": { + "description": "Set by a `TriggerMaterializationSet` operation.", + "ref": "ml.MaterializationSetTriggerProgress", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, "update_progress": { "description": "Set by an `UpdateMaterializationSet` operation.", "ref": "ml.MaterializationSetUpdateProgress", @@ -47058,6 +47434,18 @@ "SUCCEEDED": "PRIVATE_PREVIEW" } }, + "ml.MaterializationSetTriggerProgress": { + "description": "Progress and outcomes of the runs requested by `TriggerMaterializationSet`.\nEntries remain available after the operation finishes.\n\nOnce all requested runs have finished, the operation fails if any run failed. Otherwise,\nit is cancelled if any run was cancelled, and succeeds if all runs succeeded.", + "fields": { + "runs": { + "description": "One entry per requested run, including runs that fail or are cancelled before submission.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, "ml.MaterializationSetUpdateProgress": { "description": "Progress and outcomes of an `UpdateMaterializationSet` operation.", "fields": { @@ -47119,6 +47507,14 @@ "OPTIONAL" ] }, + "external_trigger": { + "description": "A trigger that disables automatic materialization, including the initial run\nat creation. Runs are instead triggered through the `TriggerMaterializationSet`\nAPI. Supported only for batch materializations in a materialization set.", + "ref": "ml.ExternalTrigger", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, "feature_name": { "description": "The full name of the feature in Unity Catalog.", "launch_stage": "GA" @@ -48746,7 +49142,7 @@ ] }, "input_tables": { - "description": "The full three-part names of the tables the pipeline reads from. Required to materialize this\nfeature with a TableTrigger, which starts a run when these tables update. Each table must exist\nwhen the feature is created. Feature Store doesn't confirm that the pipeline reads from these\ntables. At most 100 tables.", + "description": "The full three-part names of the tables the pipeline reads from. Required to materialize this\nfeature with a TableTrigger, which starts a run when these tables update. Each table must exist\nwhen the feature is created. Feature Store doesn't confirm that the pipeline reads from these\ntables. At most 25 tables.", "launch_stage": "PRIVATE_PREVIEW", "behaviors": [ "OPTIONAL" @@ -49553,6 +49949,13 @@ "OPTIONAL" ] }, + "paused": { + "description": "Whether automatic materialization is paused. Defaults to `false`.\nSupported only for materializations in a materialization set.\nUse the `UpdateMaterializationSet` API to pause or resume the set.\n\nPausing does not cancel running or queued runs. Runs can still be\ntriggered through the `TriggerMaterializationSet` API. Resuming does\nnot submit a run. Creating a paused materialization skips its initial run.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, "wait_after_last_change": { "description": "How long the source table must go without updates before a run starts, so a series of\nupdates settles before the run. If not set, a run starts as soon as the source table updates.", "launch_stage": "PRIVATE_PREVIEW", @@ -49714,6 +50117,21 @@ } } }, + "ml.TriggerMaterializationSetRequest": { + "description": "Request to trigger materialization for a materialization set.", + "fields": { + "request_id": { + "description": "Idempotency token in UUID format. Reusing it returns the original operation without starting\nadditional runs, even if the request differs or the operation has finished.\nIf omitted, each request triggers independently.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "ml.TriggerMaterializationSetResponse": { + "description": "Result of a successful `TriggerMaterializationSet` operation." + }, "ml.TumblingWindow": { "fields": { "delay": { @@ -54823,6 +55241,191 @@ } } }, + "postgres.AcknowledgeAssessmentWarningsRequest": { + "description": "Request to acknowledge assessment warnings." + }, + "postgres.AcknowledgeAssessmentWarningsResponse": { + "description": "Response produced after assessment warnings are acknowledged.", + "fields": { + "assessment": { + "description": "The assessment after its warnings are acknowledged.", + "ref": "postgres.Assessment", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.AssessMigrationRequest": { + "description": "Request to assess a migration." + }, + "postgres.AssessMigrationResponse": { + "description": "Response produced after an assessment run is created.", + "fields": { + "assessment": { + "description": "The assessment run created for the migration.", + "ref": "postgres.Assessment", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.Assessment": { + "description": "A server-managed assessment of a migration's source configuration. Completed check results are immutable.", + "fields": { + "checks": { + "description": "Output-only. Results of the checks performed by this assessment.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "complete_time": { + "description": "Output-only. The time when the assessment completed.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "create_time": { + "description": "Output-only. The time when the assessment started.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "expire_time": { + "description": "Output-only. The time when the assessment expires.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "The assessment resource name, in the format `migrations/{migration}/assessments/{assessment}`.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "state": { + "description": "Output-only. The aggregate assessment state.", + "ref": "postgres.AssessmentState", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.AssessmentCheck": { + "description": "The result of one assessment check.", + "fields": { + "blocks_migration": { + "description": "Output-only. Whether this result blocks migration from starting.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "check_id": { + "description": "Output-only. Stable identifier of the check.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "database": { + "description": "Output-only. The source database the check evaluated. Unset for checks that assess the whole\nsource server rather than a single database.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "details": { + "description": "Output-only. Measurements observed by this check. Absent when unavailable.", + "ref": "postgres.AssessmentCheckDetails", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "reason": { + "description": "Output-only. Explanation of the result.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "verdict": { + "description": "Output-only. The check verdict.", + "ref": "postgres.AssessmentCheckVerdict", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.AssessmentCheckDetails": { + "description": "Measurements observed when an assessment check ran. Unset for older assessments.", + "fields": { + "database_size": { + "description": "Output-only. Physical size of the source database observed by this check.", + "ref": "postgres.DatabaseSizeDetails", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "long_transaction": { + "description": "Output-only. Age of the oldest source transaction observed by this check.", + "ref": "postgres.LongTransactionDetails", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.AssessmentCheckVerdict": { + "description": "The verdict of a single assessment check.", + "enum": [ + "ASSESSMENT_CHECK_VERDICT_PASS", + "ASSESSMENT_CHECK_VERDICT_WARNING", + "ASSESSMENT_CHECK_VERDICT_ACTION_REQUIRED", + "ASSESSMENT_CHECK_VERDICT_UNSUPPORTED", + "ASSESSMENT_CHECK_VERDICT_ERROR" + ], + "enum_launch_stages": { + "ASSESSMENT_CHECK_VERDICT_ACTION_REQUIRED": "PRIVATE_PREVIEW", + "ASSESSMENT_CHECK_VERDICT_ERROR": "PRIVATE_PREVIEW", + "ASSESSMENT_CHECK_VERDICT_PASS": "PRIVATE_PREVIEW", + "ASSESSMENT_CHECK_VERDICT_UNSUPPORTED": "PRIVATE_PREVIEW", + "ASSESSMENT_CHECK_VERDICT_WARNING": "PRIVATE_PREVIEW" + } + }, + "postgres.AssessmentState": { + "description": "The aggregate state of an assessment run.", + "enum": [ + "ASSESSMENT_STATE_ASSESSING", + "ASSESSMENT_STATE_READY", + "ASSESSMENT_STATE_AWAITING_ACK", + "ASSESSMENT_STATE_FAILED", + "ASSESSMENT_STATE_EXPIRED", + "ASSESSMENT_STATE_NEEDS_ACTION", + "ASSESSMENT_STATE_BLOCKED" + ], + "enum_launch_stages": { + "ASSESSMENT_STATE_ASSESSING": "PRIVATE_PREVIEW", + "ASSESSMENT_STATE_AWAITING_ACK": "PRIVATE_PREVIEW", + "ASSESSMENT_STATE_BLOCKED": "PRIVATE_PREVIEW", + "ASSESSMENT_STATE_EXPIRED": "PRIVATE_PREVIEW", + "ASSESSMENT_STATE_FAILED": "PRIVATE_PREVIEW", + "ASSESSMENT_STATE_NEEDS_ACTION": "PRIVATE_PREVIEW", + "ASSESSMENT_STATE_READY": "PRIVATE_PREVIEW" + } + }, "postgres.Branch": { "fields": { "branch_id": { @@ -55401,6 +56004,19 @@ } } }, + "postgres.CreateMigrationRequest": { + "fields": { + "migration": { + "description": "Required. The migration to create.", + "ref": "postgres.Migration", + "launch_stage": "PRIVATE_PREVIEW" + }, + "migration_id": { + "description": "Required. The ID to use for the migration. It becomes the final component of the resource name\n(`migrations/{migration_id}`). It must be 1-63 characters long, start with a lowercase letter,\nand contain only lowercase letters, numbers, and hyphens.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "postgres.CreateProjectRequest": { "fields": { "project": { @@ -55417,7 +56033,7 @@ "postgres.CreateRoleRequest": { "fields": { "replace_existing": { - "description": "If true, update the role if it already exists instead of returning an\nerror. This requires `role_id` to be set. Without `role_id`, the request\nfollows the normal create path and fails if the role name already exists.\n\nWhen the role already exists, only mutable fields are updated.\nAttributes omitted from the request retain their current values.\nSet an attribute explicitly to false to disable it.\n`identity_type`, `auth_method`, and `postgres_role` retain their\nexisting values; supplied values for these fields are ignored.\n`membership_roles` is overwritten, not merged. Leaving\n`membership_roles` empty clears all of the role's existing memberships,\nincluding `DATABRICKS_SUPERUSER`. Always send the complete desired list\nof memberships when using this field.", + "description": "If true, update the role if it already exists instead of returning an\nerror. This requires `role_id` to be set. Without `role_id`, the request\nfollows the normal create path and fails if the role name already exists.\n\nWhen the role already exists, only mutable fields are updated.\nAttributes omitted from the request retain their current values.\nSet an attribute explicitly to false to disable it.\n`identity_type`, `auth_method`, and `postgres_role` retain their\nexisting values. Omit these fields or supply their current values.\nA differing supplied value returns INVALID_PARAMETER_VALUE and rejects\nthe entire request, including changes to mutable fields.\n`membership_roles` is overwritten, not merged. Leaving\n`membership_roles` empty clears all of the role's existing memberships,\nincluding `DATABRICKS_SUPERUSER`. Always send the complete desired list\nof memberships when using this field.", "launch_stage": "GA", "behaviors": [ "INPUT_ONLY", @@ -55781,7 +56397,42 @@ } } }, + "postgres.DatabaseMapping": { + "description": "A mapping between one source and target database.", + "fields": { + "effective_target_database": { + "description": "Output-only. The resolved target PostgreSQL database name. Equal to `target_database` when\nprovided; otherwise equal to `source_database`.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "source_database": { + "description": "Required. The exact PostgreSQL database name on the source server.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "target_database": { + "description": "The PostgreSQL database name to create on the target branch. When omitted, the source database\nname is preserved.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, "postgres.DatabaseOperationMetadata": {}, + "postgres.DatabaseSizeDetails": { + "description": "Physical database size, including indexes and bloat; not a dump archive size estimate.", + "fields": { + "size_bytes": { + "description": "Size reported by pg_database_size, in bytes. Zero is a measured empty size.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, "postgres.DatabricksServiceExceptionWithDetailsProto": { "description": "Databricks Error that is returned by all Databricks APIs.", "fields": { @@ -55847,6 +56498,7 @@ "postgres.DeleteDataApiRequest": {}, "postgres.DeleteDatabaseRequest": {}, "postgres.DeleteEndpointRequest": {}, + "postgres.DeleteMigrationRequest": {}, "postgres.DeleteProjectRequest": { "fields": { "purge": { @@ -56407,6 +57059,7 @@ } } }, + "postgres.GetAssessmentRequest": {}, "postgres.GetBranchRequest": {}, "postgres.GetCatalogRequest": {}, "postgres.GetCdfConfigRequest": {}, @@ -56414,6 +57067,7 @@ "postgres.GetDataApiRequest": {}, "postgres.GetDatabaseRequest": {}, "postgres.GetEndpointRequest": {}, + "postgres.GetMigrationRequest": {}, "postgres.GetOperationRequest": {}, "postgres.GetProjectRequest": {}, "postgres.GetRoleRequest": {}, @@ -56473,6 +57127,37 @@ } } }, + "postgres.ListAssessmentsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of assessments to return. The server default is 100; values above 1000 are\ncapped to 1000.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token from a previous call.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.ListAssessmentsResponse": { + "description": "Response to list assessments.", + "fields": { + "assessments": { + "description": "Assessment runs ordered from newest to oldest.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_page_token": { + "description": "A token for retrieving the next page. Empty when there are no more results.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "postgres.ListBranchesRequest": { "fields": { "page_size": { @@ -56638,6 +57323,44 @@ } } }, + "postgres.ListMigrationsRequest": { + "fields": { + "page_size": { + "description": "The maximum number of migrations to return. The server default is 100; values above 1000 are\ncapped to 1000.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "A page token from a previous call.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "show_deleted": { + "description": "Whether to include soft-deleted migrations in the response. Hard-deleted and already-purged\nmigrations are never returned.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "postgres.ListMigrationsResponse": { + "description": "Response to list migrations.", + "fields": { + "migrations": { + "description": "Migrations visible to the caller.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "next_page_token": { + "description": "A token for retrieving the next page. Empty when there are no more results.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "postgres.ListProjectsRequest": { "fields": { "page_size": { @@ -56735,6 +57458,150 @@ } } }, + "postgres.LongTransactionDetails": { + "description": "Oldest active source transaction at assessment time.", + "fields": { + "oldest_transaction_age": { + "description": "Age of the oldest active transaction when assessed. Zero when none is active.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.Migration": { + "description": "A managed migration of PostgreSQL databases into a Lakebase branch.", + "fields": { + "create_time": { + "description": "Output-only. The time when the migration was created.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "database_mappings": { + "description": "Required. Mappings from source databases to target databases.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "delete_time": { + "description": "Output-only. The time when the migration was soft-deleted. Empty if the migration is active.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "error": { + "description": "Output-only. The current error preventing migration progress, if any.", + "ref": "postgres.MigrationError", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "migration_type": { + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "ref": "postgres.MigrationType", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "IMMUTABLE" + ] + }, + "name": { + "description": "The migration resource name, in the format `migrations/{migration}`.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "purge_time": { + "description": "Output-only. The time when the soft-deleted migration is scheduled for permanent deletion.\nEmpty if the migration is active or permanent deletion is not scheduled.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "source_connection": { + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "launch_stage": "PRIVATE_PREVIEW" + }, + "state": { + "description": "Output-only. The authoritative migration lifecycle state.", + "ref": "postgres.MigrationState", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "target_branch": { + "description": "The Lakebase branch receiving the migrated databases, in the format\n`projects/{project_id}/branches/{branch_id}`. May be omitted during assessment, but must be\nset before the migration starts, and may be changed until then.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OPTIONAL" + ] + }, + "update_time": { + "description": "Output-only. The time when the migration was last updated.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.MigrationError": { + "description": "An error that prevents migration progress.", + "fields": { + "code": { + "description": "A stable machine-readable error code.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "message": { + "description": "A concise explanation of the failure.", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "postgres.MigrationOperationMetadata": { + "description": "Metadata for a long-running operation that applies an action to a migration." + }, + "postgres.MigrationState": { + "description": "The lifecycle state of a migration.", + "enum": [ + "MIGRATION_STATE_DRAFT", + "MIGRATION_STATE_ASSESSING", + "MIGRATION_STATE_ASSESSMENT_NEEDS_ACTION", + "MIGRATION_STATE_READY_TO_START", + "MIGRATION_STATE_SCHEMA_LOAD", + "MIGRATION_STATE_INITIAL_DATA_LOAD", + "MIGRATION_STATE_COMPLETED", + "MIGRATION_STATE_FAILED" + ], + "enum_launch_stages": { + "MIGRATION_STATE_ASSESSING": "PRIVATE_PREVIEW", + "MIGRATION_STATE_ASSESSMENT_NEEDS_ACTION": "PRIVATE_PREVIEW", + "MIGRATION_STATE_COMPLETED": "PRIVATE_PREVIEW", + "MIGRATION_STATE_DRAFT": "PRIVATE_PREVIEW", + "MIGRATION_STATE_FAILED": "PRIVATE_PREVIEW", + "MIGRATION_STATE_INITIAL_DATA_LOAD": "PRIVATE_PREVIEW", + "MIGRATION_STATE_READY_TO_START": "PRIVATE_PREVIEW", + "MIGRATION_STATE_SCHEMA_LOAD": "PRIVATE_PREVIEW" + } + }, + "postgres.MigrationType": { + "description": "The intended data transfer mode of a migration.", + "enum": [ + "MIGRATION_TYPE_ONE_TIME_COPY", + "MIGRATION_TYPE_ONLINE" + ], + "enum_launch_stages": { + "MIGRATION_TYPE_ONE_TIME_COPY": "PRIVATE_PREVIEW", + "MIGRATION_TYPE_ONLINE": "PRIVATE_PREVIEW" + } + }, "postgres.MonthlySchedule": { "description": "Take a snapshot once per month, on the configured day at the configured hour.", "fields": { @@ -57322,7 +58189,7 @@ ] }, "auth_method": { - "description": "Controls how the Postgres role authenticates when a client opens a database\nconnection. Supported values:\n\n* LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks\nOAuth access token derived from the backing managed identity (the\nDatabricks user, service principal, or group named by the role's\n`postgres_role`). No static password exists for roles using this method.\n* PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres\npassword verified server-side using the SCRAM-SHA-256 mechanism.\nLakebase generates a password for the role.\n* NO_LOGIN: the role cannot open a Postgres session at all. Useful for\nroles that exist only to own objects or to aggregate privileges that\nare then granted to other, loginable roles.\n\nIf auth_method is left unspecified, a meaningful authentication method is derived from the identity_type:\n* For the managed identities, OAUTH is used.\n* For the regular postgres roles, authentication based on postgres passwords is used.\n\nNOTE: for the Databricks identity type GROUP, LAKEBASE_OAUTH_V1\nis the default auth method (group can login as well).\n\nThis field is set when the role is created and cannot be changed by\nUpdateRole. If provided in an UpdateRole request body, its value is\nignored and the existing value is retained. Do not include this field\nas an explicit path in update_mask.", + "description": "Controls how the Postgres role authenticates when a client opens a database\nconnection. Supported values:\n\n* LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks\nOAuth access token derived from the backing managed identity (the\nDatabricks user, service principal, or group named by the role's\n`postgres_role`). No static password exists for roles using this method.\n* PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres\npassword verified server-side using the SCRAM-SHA-256 mechanism.\nLakebase generates a password for the role.\n* NO_LOGIN: the role cannot open a Postgres session at all. Useful for\nroles that exist only to own objects or to aggregate privileges that\nare then granted to other, loginable roles.\n\nIf auth_method is left unspecified, a meaningful authentication method is derived from the identity_type:\n* For the managed identities, OAUTH is used.\n* For the regular postgres roles, authentication based on postgres passwords is used.\n\nNOTE: for the Databricks identity type GROUP, LAKEBASE_OAUTH_V1\nis the default auth method (group can login as well).\n\nThis field is set when the role is created and cannot be changed.\nWhen replacing an existing role with replace_existing=true, omit this\nfield or supply its current value. A differing value returns\nINVALID_PARAMETER_VALUE and rejects the entire request, including changes\nto mutable fields.\nWith `*` or masks containing only mutable fields, supplied values are ignored.\nIncluding this field as an explicit path in update_mask returns\nINVALID_PARAMETER_VALUE.", "ref": "postgres.RoleAuthMethod", "launch_stage": "GA", "behaviors": [ @@ -57330,7 +58197,7 @@ ] }, "identity_type": { - "description": "The type of role.\nWhen specifying a managed-identity, the chosen role_id must be a valid:\n\n* application ID for SERVICE_PRINCIPAL\n* user email for USER\n* group name for GROUP\n\nThis field is set when the role is created and cannot be changed by\nUpdateRole. If provided in an UpdateRole request body, its value is\nignored and the existing value is retained. Do not include this field\nas an explicit path in update_mask.", + "description": "The type of role.\nWhen specifying a managed-identity, the chosen role_id must be a valid:\n\n* application ID for SERVICE_PRINCIPAL\n* user email for USER\n* group name for GROUP\n\nThis field is set when the role is created and cannot be changed.\nWhen replacing an existing role with replace_existing=true, omit this\nfield or supply its current value. A differing value returns\nINVALID_PARAMETER_VALUE and rejects the entire request, including changes\nto mutable fields.\nWith `*` or masks containing only mutable fields, supplied values are ignored.\nIncluding this field as an explicit path in update_mask returns\nINVALID_PARAMETER_VALUE.", "ref": "postgres.RoleIdentityType", "launch_stage": "GA", "behaviors": [ @@ -57345,7 +58212,7 @@ ] }, "postgres_role": { - "description": "The name of the Postgres role.\n\nThis expects a valid Postgres identifier as specified in the link below.\nhttps://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS\n\nRequired when creating the Role.\n\nIf you wish to create a Postgres Role backed by a managed Databricks identity, then postgres_role\nmust be one of the following:\n\n1. user email for IdentityType.USER\n2. app ID for IdentityType.SERVICE_PRINCIPAL\n2. group name for IdentityType.GROUP\n\nThis field is set when the role is created and cannot be changed by\nUpdateRole. If provided in an UpdateRole request body, its value is\nignored and the existing value is retained. Do not include this field\nas an explicit path in update_mask.", + "description": "The name of the Postgres role.\n\nThis expects a valid Postgres identifier as specified in the link below.\nhttps://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS\n\nRequired when creating the Role.\n\nIf you wish to create a Postgres Role backed by a managed Databricks identity, then postgres_role\nmust be one of the following:\n\n1. user email for IdentityType.USER\n2. app ID for IdentityType.SERVICE_PRINCIPAL\n2. group name for IdentityType.GROUP\n\nThis field is set when the role is created and cannot be changed.\nWhen replacing an existing role with replace_existing=true, omit this\nfield or supply its current value. A differing value returns\nINVALID_PARAMETER_VALUE and rejects the entire request, including changes\nto mutable fields.\nWith `*` or masks containing only mutable fields, supplied values are ignored.\nIncluding this field as an explicit path in update_mask returns\nINVALID_PARAMETER_VALUE.", "launch_stage": "GA", "behaviors": [ "OPTIONAL" @@ -57587,6 +58454,22 @@ } } }, + "postgres.StartMigrationRequest": { + "description": "Request to start a migration." + }, + "postgres.StartMigrationResponse": { + "description": "Response produced after migration preparation has started.", + "fields": { + "migration": { + "description": "The migration after the start action is applied.", + "ref": "postgres.Migration", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, "postgres.SyncedTable": { "fields": { "create_time": { @@ -57981,6 +58864,22 @@ } }, "postgres.UndeleteBranchRequest": {}, + "postgres.UndeleteMigrationRequest": { + "description": "Request to restore a soft-deleted migration before it is permanently purged." + }, + "postgres.UndeleteMigrationResponse": { + "description": "Response produced after a soft-deleted migration is restored.", + "fields": { + "migration": { + "description": "The restored migration.", + "ref": "postgres.Migration", + "launch_stage": "PRIVATE_PREVIEW", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, "postgres.UndeleteProjectRequest": { "description": "Request to restore a soft-deleted project within its retention period." }, @@ -58036,6 +58935,19 @@ } } }, + "postgres.UpdateMigrationRequest": { + "fields": { + "migration": { + "description": "Required. The migration containing the user-owned fields to update.", + "ref": "postgres.Migration", + "launch_stage": "PRIVATE_PREVIEW" + }, + "update_mask": { + "description": "Required. The fields to update.", + "launch_stage": "PRIVATE_PREVIEW" + } + } + }, "postgres.UpdateProjectRequest": { "fields": { "project": { @@ -58057,7 +58969,7 @@ "launch_stage": "GA" }, "update_mask": { - "description": "The list of fields to update. Supported fields are\n`spec.membership_roles`, `spec.attributes.createdb`,\n`spec.attributes.createrole`, and `spec.attributes.bypassrls`.\n\n`spec.identity_type`, `spec.auth_method`, and `spec.postgres_role`\ncannot be changed. Values supplied for these fields in the request\nbody are ignored. Including one of these fields as an explicit path\nin update_mask returns an INVALID_PARAMETER_VALUE error.\nWhen `spec` is the only path in the mask, only the supplied mutable\nattributes are updated.\n`*` by itself, or `spec` combined with other supported paths, selects all\nsupported mutable fields. For these masks, all three attributes\n(`createdb`, `createrole`, and `bypassrls`) must be supplied; omitting any\nreturns an INVALID_PARAMETER_VALUE error.\nEach of these mask forms replaces `membership_roles`.\nOmitting it or supplying an empty list clears all memberships, including\n`DATABRICKS_SUPERUSER`.", + "description": "The list of fields to update. Supported fields are\n`spec.membership_roles`, `spec.attributes.createdb`,\n`spec.attributes.createrole`, and `spec.attributes.bypassrls`.\n\n`spec.identity_type`, `spec.auth_method`, and `spec.postgres_role`\ncannot be changed. Including an immutable field as an explicit path in\nupdate_mask returns INVALID_PARAMETER_VALUE. With `*` or masks containing\nonly mutable fields, supplied values for these immutable fields are ignored.\n`*` by itself selects all supported mutable fields. For this mask,\nall three attributes (`createdb`, `createrole`, and `bypassrls`) must be\nsupplied; omitting any returns an INVALID_PARAMETER_VALUE error.\nThe `*` mask replaces `membership_roles`.\nOmitting it or supplying an empty list clears all memberships, including\n`DATABRICKS_SUPERUSER`.", "launch_stage": "GA" } } @@ -66127,6 +67039,614 @@ "DENY_ALL": "PRIVATE_PREVIEW" } }, + "settingsv2.DashboardTheme": { + "description": "Theme settings for customizing AI/BI dashboard UI, including visualization colors,\nfont colors, background colors, and more.", + "fields": { + "axis_line_color": { + "description": "Color of the zero-value grid line, making it visually distinct from other grid lines.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "canvas_background_color": { + "description": "The background color of the dashboard canvas.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "continuous_gradient": { + "description": "The continuous gradient configuration for the dashboard.", + "ref": "settingsv2.DashboardThemeContinuousGradient", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "font_color": { + "description": "The default font color applied to all text in the dashboard.\nSuperseded by font_settings.base.font_color when font_settings is set.\nMore specific font settings in turn override base.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "font_family": { + "description": "Font family to customize all text within the dashboard.\nUnsupported font names fall back to the default font.\nSuperseded by font_settings.base.font_family when font_settings is set.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "font_settings": { + "description": "The per-category typography overrides for the dashboard.", + "ref": "settingsv2.DashboardThemeFontSettings", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "grid_line_color": { + "description": "Color of chart grid lines in visualizations (horizontal and vertical guide lines).", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "mark_corner_radius": { + "description": "The corner radius in pixels for rectangular marks in visualizations (bars, columns, histogram bins, etc.).", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "selection_color": { + "description": "The highlight color for selected elements in widgets.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "sentiment_colors": { + "description": "The sentiment color palette for the dashboard.", + "ref": "settingsv2.DashboardThemeSentimentColors", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "text_box_vertical_align": { + "description": "The default vertical alignment for all text box widgets in the dashboard.\nIndividual text box widgets can override this.", + "ref": "settingsv2.DashboardThemeVerticalAlign", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_01": { + "description": "Color palette for visualizations. Colors are applied in order (visualization_color_01, visualization_color_02, etc.).\nInvalid color values are preserved but ignored during rendering.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_02": { + "description": "The color at position 2 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_03": { + "description": "The color at position 3 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_04": { + "description": "The color at position 4 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_05": { + "description": "The color at position 5 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_06": { + "description": "The color at position 6 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_07": { + "description": "The color at position 7 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_08": { + "description": "The color at position 8 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_09": { + "description": "The color at position 9 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_10": { + "description": "The color at position 10 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_11": { + "description": "The color at position 11 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_12": { + "description": "The color at position 12 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_13": { + "description": "The color at position 13 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_14": { + "description": "The color at position 14 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_15": { + "description": "The color at position 15 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_16": { + "description": "The color at position 16 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_17": { + "description": "The color at position 17 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_18": { + "description": "The color at position 18 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_19": { + "description": "The color at position 19 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "visualization_color_20": { + "description": "The color at position 20 in the visualization color palette.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "widget_background_color": { + "description": "The background color of widgets.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "widget_border_color": { + "description": "The border color of widgets.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "widget_corner_radius": { + "description": "The widget border radius in pixels.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "widget_header_alignment": { + "description": "Alignment setting for all widget titles and descriptions at the dashboard level.", + "ref": "settingsv2.DashboardThemeAlignment", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "widget_margin": { + "description": "The gap between widgets in pixels.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "widget_padding": { + "description": "The content padding inside each widget in pixels.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "widget_shadow": { + "description": "The shadow intensity level applied to widgets (0 = no shadow, 100 = maximum).\nThe actual CSS box-shadow is computed at render time from this value, factoring in\nbackground colors and color mode.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.DashboardThemeAlignment": { + "description": "Horizontal alignment options for widget titles and descriptions.", + "enum": [ + "LEFT", + "CENTER", + "RIGHT" + ], + "enum_launch_stages": { + "CENTER": "PUBLIC_BETA", + "LEFT": "PUBLIC_BETA", + "RIGHT": "PUBLIC_BETA" + } + }, + "settingsv2.DashboardThemeContinuousGradient": { + "description": "Configuration for continuous color gradients, with separate values for light and dark mode.\nEach mode's gradient can reference the visualization color palette via\nfrom_categorical_index, use a named color scheme, or define a custom sequential or diverging ramp.", + "fields": { + "dark_mode": { + "description": "Gradient value used when the dashboard is rendered in dark mode.", + "ref": "settingsv2.DashboardThemeContinuousGradientGradientValue", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "light_mode": { + "description": "Gradient value used when the dashboard is rendered in light mode.", + "ref": "settingsv2.DashboardThemeContinuousGradientGradientValue", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.DashboardThemeContinuousGradientCustomDivergingRamp": { + "description": "A custom three-stop diverging gradient ramp.", + "fields": { + "end": { + "description": "The color at the end of the gradient (highest value).", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "mid": { + "description": "The color at the midpoint of the gradient.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "start": { + "description": "The color at the start of the gradient (lowest value).", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.DashboardThemeContinuousGradientCustomSequentialRamp": { + "description": "A custom two-stop sequential gradient ramp.", + "fields": { + "end": { + "description": "The color at the end of the gradient (highest value).", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "start": { + "description": "The color at the start of the gradient (lowest value).", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.DashboardThemeContinuousGradientGradientValue": { + "description": "The gradient for one color mode. Set at most one field.", + "fields": { + "color": { + "description": "A static color string (for example, '#FF0000').", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "color_scheme": { + "description": "A named color scheme (for example, 'blues', 'viridis', 'spectral').", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "custom_diverging": { + "description": "A custom three-stop diverging gradient.", + "ref": "settingsv2.DashboardThemeContinuousGradientCustomDivergingRamp", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "custom_sequential": { + "description": "A custom two-stop sequential gradient.", + "ref": "settingsv2.DashboardThemeContinuousGradientCustomSequentialRamp", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "from_categorical_index": { + "description": "A 0-based index into the visualization color palette, where 0 is visualization_color_01. Valid values are 0 to 19.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.DashboardThemeDashboardThemeColor": { + "description": "Represents a color value with optional overrides for light and dark modes.\nAuthors can customize colors separately to cater to each mode,\nbased on the viewer's user-level theme preference.", + "fields": { + "dark": { + "description": "The color used when the dashboard is rendered in dark mode (for example, '#FF0000').", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "light": { + "description": "The color used when the dashboard is rendered in light mode (for example, '#FF0000').", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.DashboardThemeFontConfig": { + "description": "Defines the typography settings for a single text category.", + "fields": { + "font_color": { + "description": "The font color applied to text in this category.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "font_family": { + "description": "The font family name used for text in this category.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "font_size": { + "description": "The font size in pixels.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "font_style": { + "description": "The font style (slant) applied to text in this category.", + "ref": "settingsv2.DashboardThemeFontStyle", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "font_weight": { + "description": "The font weight value (for example, 400 for normal, 700 for bold).", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "text_case": { + "description": "The text case transformation applied to text in this category.", + "ref": "settingsv2.DashboardThemeTextCase", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "text_decoration": { + "description": "The text decoration applied to text in this category.", + "ref": "settingsv2.DashboardThemeTextDecoration", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.DashboardThemeFontSettings": { + "description": "Per-category typography overrides. When font_settings.base is set, it takes precedence\nover the top-level font_family and font_color. More specific categories\n(widget_title, widget_description, field_title, field_value) in turn override base.", + "fields": { + "base": { + "description": "The default font config applied to all text unless overridden by a more specific category.", + "ref": "settingsv2.DashboardThemeFontConfig", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "field_title": { + "description": "The font config applied to field titles (for example, axis titles, table heading titles).", + "ref": "settingsv2.DashboardThemeFontConfig", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "field_value": { + "description": "The font config applied to field values (for example, axis tick labels, table cell values, tooltip values).", + "ref": "settingsv2.DashboardThemeFontConfig", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "widget_description": { + "description": "The font config applied to widget descriptions.", + "ref": "settingsv2.DashboardThemeFontConfig", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "widget_title": { + "description": "The font config applied to widget titles.", + "ref": "settingsv2.DashboardThemeFontConfig", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.DashboardThemeFontStyle": { + "description": "Defines the font style (slant) applied to rendered text.", + "enum": [ + "FONT_STYLE_NORMAL", + "FONT_STYLE_ITALIC" + ], + "enum_launch_stages": { + "FONT_STYLE_ITALIC": "PUBLIC_BETA", + "FONT_STYLE_NORMAL": "PUBLIC_BETA" + } + }, + "settingsv2.DashboardThemeSentimentColors": { + "description": "Shared sentiment colors reusable across visualizations, primarily for conditional\nformatting, ensuring consistent positive, negative, and neutral meaning throughout the dashboard.", + "fields": { + "negative": { + "description": "The color applied to negative sentiment values.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "neutral": { + "description": "The color applied to neutral sentiment values.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "positive": { + "description": "The color applied to positive sentiment values.", + "ref": "settingsv2.DashboardThemeDashboardThemeColor", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "settingsv2.DashboardThemeTextCase": { + "description": "Defines the text case transformation applied to rendered text.", + "enum": [ + "TEXT_CASE_UPPERCASE", + "TEXT_CASE_CAPITALIZE", + "TEXT_CASE_LOWERCASE" + ], + "enum_launch_stages": { + "TEXT_CASE_CAPITALIZE": "PUBLIC_BETA", + "TEXT_CASE_LOWERCASE": "PUBLIC_BETA", + "TEXT_CASE_UPPERCASE": "PUBLIC_BETA" + } + }, + "settingsv2.DashboardThemeTextDecoration": { + "description": "Defines the decoration line applied to rendered text.", + "enum": [ + "TEXT_DECORATION_NONE", + "TEXT_DECORATION_UNDERLINE" + ], + "enum_launch_stages": { + "TEXT_DECORATION_NONE": "PUBLIC_BETA", + "TEXT_DECORATION_UNDERLINE": "PUBLIC_BETA" + } + }, + "settingsv2.DashboardThemeVerticalAlign": { + "description": "Vertical alignment options for text box content.", + "enum": [ + "VERTICAL_ALIGN_TOP", + "VERTICAL_ALIGN_CENTER", + "VERTICAL_ALIGN_BOTTOM" + ], + "enum_launch_stages": { + "VERTICAL_ALIGN_BOTTOM": "PUBLIC_BETA", + "VERTICAL_ALIGN_CENTER": "PUBLIC_BETA", + "VERTICAL_ALIGN_TOP": "PUBLIC_BETA" + } + }, "settingsv2.GetPublicAccountSettingRequest": {}, "settingsv2.GetPublicAccountUserPreferenceRequest": {}, "settingsv2.GetPublicWorkspaceSettingRequest": {}, @@ -66457,6 +67977,14 @@ "OUTPUT_ONLY" ] }, + "effective_workspace_dashboard_theme": { + "description": "Effective setting value for the workspace_dashboard_theme setting. This is the final effective value of the setting. To set a value, use workspace_dashboard_theme.", + "ref": "settingsv2.DashboardTheme", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, "effective_workspace_label": { "description": "Effective setting value for workspace_label setting. This is the final effective value of setting. To set a value use workspace_label.", "ref": "settingsv2.WorkspaceLabelMessage", @@ -66509,6 +68037,14 @@ "OPTIONAL" ] }, + "workspace_dashboard_theme": { + "description": "Setting value for the workspace_dashboard_theme setting. This is the setting value set by consumers. Check effective_workspace_dashboard_theme for the final setting value.", + "ref": "settingsv2.DashboardTheme", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, "workspace_label": { "description": "Setting value for workspace_label setting. This is the setting value set by consumers, check effective_workspace_label for final setting value.", "ref": "settingsv2.WorkspaceLabelMessage", @@ -68228,6 +69764,245 @@ } } }, + "softwareartifacts.GetSoftwareArtifactRequest": {}, + "softwareartifacts.GetSoftwareArtifactVersionRequest": {}, + "softwareartifacts.ImageAccelerationDetail": { + "description": "Image acceleration information for a software artifact version.", + "fields": { + "status": { + "description": "Image acceleration status for the version.", + "ref": "softwareartifacts.ImageAccelerationDetailStatus", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "softwareartifacts.ImageAccelerationDetailStatus": { + "description": "Image acceleration status for a software artifact version.", + "enum": [ + "UNSPECIFIED", + "SUCCESS" + ], + "enum_launch_stages": { + "SUCCESS": "PUBLIC_BETA", + "UNSPECIFIED": "PUBLIC_BETA" + } + }, + "softwareartifacts.ListSoftwareArtifactVersionsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of versions to return. If omitted or set to 0, the page size defaults to 50.\nThe maximum value is 50; values above 50 or below 0 are rejected.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Opaque continuation token from a previous response's next_page_token. Omit for the first page.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + } + } + }, + "softwareartifacts.ListSoftwareArtifactVersionsResponse": { + "description": "Response containing a page of software artifact versions.", + "fields": { + "next_page_token": { + "description": "Opaque token to pass as the next request's page_token. Empty when there are no more pages.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "software_artifact_versions": { + "description": "The versions of the requested software artifact.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "softwareartifacts.ListSoftwareArtifactsRequest": { + "fields": { + "page_size": { + "description": "Maximum number of software artifacts to return. If omitted or set to 0, the page size defaults\nto 50. The maximum value is 50; values above 50 or below 0 are rejected.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "page_token": { + "description": "Opaque continuation token from a previous response's next_page_token. Omit for the first page.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "parent": { + "description": "Resource name of the parent schema, of the form `schemas/{catalog}.{schema}`.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "softwareartifacts.ListSoftwareArtifactsResponse": { + "description": "Response containing a page of software artifacts.", + "fields": { + "next_page_token": { + "description": "Opaque token to pass as the next request's page_token. Empty when there are no more pages.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "software_artifacts": { + "description": "The software artifacts under the requested schema.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "softwareartifacts.ResolveSoftwareArtifactVersionRequest": { + "description": "Request to resolve a software artifact version from its tag alias.", + "fields": { + "alias": { + "description": "Image tag alias selecting the version.", + "launch_stage": "PUBLIC_BETA" + } + } + }, + "softwareartifacts.ResolveSoftwareArtifactVersionResponse": { + "description": "Response containing the resolved software artifact version.", + "fields": { + "software_artifact_version": { + "description": "The software artifact version selected by the alias.", + "ref": "softwareartifacts.SoftwareArtifactVersion", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "softwareartifacts.SoftwareArtifact": { + "description": "A software artifact in a Unity Catalog schema.", + "fields": { + "create_time": { + "description": "Time at which this software artifact was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Principal name of the software artifact creator.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Resource name of the artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "launch_stage": "PUBLIC_BETA" + }, + "owner": { + "description": "Principal name (a user, service principal, or group) that owns this artifact.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OPTIONAL" + ] + }, + "update_time": { + "description": "Time at which this software artifact was last updated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "Principal name that last updated this software artifact.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "softwareartifacts.SoftwareArtifactVersion": { + "description": "An immutable version of a software artifact, identified by its content digest.", + "fields": { + "create_time": { + "description": "Time at which this software artifact version was created.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "created_by": { + "description": "Principal name of the software artifact version creator.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "digest": { + "description": "Content digest of the version, for example `sha256:...`.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "image_acceleration_details": { + "description": "Image acceleration information for this version.", + "ref": "softwareartifacts.ImageAccelerationDetail", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "name": { + "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.", + "launch_stage": "PUBLIC_BETA" + }, + "tags": { + "description": "Tags (aliases) that currently point at this version, for example `latest` or `v1.2.3`.\nBounded at 10 per version; a version pointed at by more tags returns an arbitrary 10 of them.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "update_time": { + "description": "Time at which this software artifact version was last updated.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + }, + "updated_by": { + "description": "Principal name that last updated this software artifact version.", + "launch_stage": "PUBLIC_BETA", + "behaviors": [ + "OUTPUT_ONLY" + ] + } + } + }, + "softwareartifacts.UpdateSoftwareArtifactRequest": { + "fields": { + "software_artifact": { + "description": "The software artifact to update. Its name identifies the existing artifact; only owner may be\nchanged.", + "ref": "softwareartifacts.SoftwareArtifact", + "launch_stage": "PUBLIC_BETA" + }, + "update_mask": { + "description": "Fields to update, relative to `software_artifact`. Accepts `owner` or `*`; owner is the only\nmutable field, so both select the same update. Output-only values in the resource are ignored.", + "launch_stage": "PUBLIC_BETA" + } + } + }, "sql.AccessControl": { "fields": { "group_name": { @@ -74149,6 +75924,24 @@ "vectorsearch.EndpointScalingInfo": { "description": "Scaling information for a Standard endpoint: the current scaling state, the requested QPS\ntarget, and the progress of an in-progress scaling change.", "fields": { + "delayed_reason": { + "description": "Reason the in-progress scaling change is delayed. When set, `estimated_completion_timestamp`\nis unset. Unset when the change is not delayed or no scaling change is in progress.", + "ref": "vectorsearch.EndpointScalingInfoScalingDelayReason", + "launch_stage": "PUBLIC_BETA" + }, + "estimated_completion_timestamp": { + "description": "Estimated time at which the in-progress scaling change will complete, in milliseconds\nsince the Unix epoch. The estimate may change as the scaling change progresses. Unset\nwhen no scaling change is in progress, when no estimate is available, or when the change\nis delayed (see `delayed_reason`).", + "launch_stage": "PUBLIC_BETA" + }, + "index_initialization_percentage": { + "description": "Percentage of index initialization completed, from 0 to 100. Set only during the\n`INITIALIZING_INDEX` phase; unset in other phases or when progress is not available.", + "launch_stage": "PUBLIC_BETA" + }, + "phase": { + "description": "Current phase of the in-progress scaling change. Unset when no scaling change is in\nprogress or the phase is not available.", + "ref": "vectorsearch.EndpointScalingInfoScalingPhase", + "launch_stage": "PUBLIC_BETA" + }, "requested_target_qps": { "description": "The requested QPS target for the endpoint. Best-effort; the system does not\nguarantee this QPS will be achieved.", "launch_stage": "GA" @@ -74157,9 +75950,39 @@ "description": "The current state of the scaling change request.", "ref": "vectorsearch.ScalingChangeState", "launch_stage": "PUBLIC_BETA" + }, + "target_qps_change_allowed_after_timestamp": { + "description": "Earliest time a new Target QPS change is accepted, in milliseconds since the Unix epoch. Set\nonly while a scaling change is in progress, the change lock is on, and the endpoint has a\nrecorded last throughput change; may be in the past once the lock has expired.", + "launch_stage": "PUBLIC_BETA" } } }, + "vectorsearch.EndpointScalingInfoScalingDelayReason": { + "description": "Reason an in-progress scaling change is delayed.", + "enum": [ + "CAPACITY_UNAVAILABLE", + "SCALE_DOWN_BLOCKED", + "TAKING_LONGER_THAN_EXPECTED" + ], + "enum_launch_stages": { + "CAPACITY_UNAVAILABLE": "PUBLIC_BETA", + "SCALE_DOWN_BLOCKED": "PUBLIC_BETA", + "TAKING_LONGER_THAN_EXPECTED": "PUBLIC_BETA" + } + }, + "vectorsearch.EndpointScalingInfoScalingPhase": { + "description": "Phase of an in-progress scaling change.", + "enum": [ + "ADJUSTING_CAPACITY", + "INITIALIZING_INDEX", + "ESTIMATING" + ], + "enum_launch_stages": { + "ADJUSTING_CAPACITY": "PUBLIC_BETA", + "ESTIMATING": "PUBLIC_BETA", + "INITIALIZING_INDEX": "PUBLIC_BETA" + } + }, "vectorsearch.EndpointStatus": { "description": "Status information of an endpoint", "fields": { @@ -78101,7 +79924,7 @@ }, { "name": "source_type", - "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.", + "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.\nWhile the workspace's default-source-type rollout flag is on, omitted or UNSPECIFIED is stored\nas AGENT. While it is off, omitted is stored unset and UNSPECIFIED as UNSPECIFIED.", "is_request_body_field": true, "entity": { "pascal_name": "ManagedMemoryEntrySourceType", @@ -81538,7 +83361,7 @@ }, { "name": "source_type", - "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.", + "description": "Which writer created this entry. Caller sets this on Create; immutable after creation.\nWhile the workspace's default-source-type rollout flag is on, omitted or UNSPECIFIED is stored\nas AGENT. While it is off, omitted is stored unset and UNSPECIFIED as UNSPECIFIED.", "is_request_body_field": true, "entity": { "pascal_name": "ManagedMemoryEntrySourceType", @@ -88152,7 +89975,7 @@ }, { "name": "UpdateEndpoint", - "description": "Update an existing AI Search endpoint. Multi-bucket masks are supported and\ndispatched in deterministic bucket order: budget policy, custom tags, throughput,\nthen scaling/replicas. Per-bucket dispatch is not atomic across buckets — if a\nlater bucket fails, earlier buckets may already have been applied.", + "description": "Update an existing AI Search endpoint. Multi-bucket masks are supported and\ndispatched in deterministic bucket order: budget policy, custom tags, throughput,\nscaling/replicas, then metrics export. Per-bucket dispatch is not atomic across buckets — if a\nlater bucket fails, earlier buckets may already have been applied.", "summary": "Update an AI Search endpoint.", "path": "/api/2.0/ai-search/{name=workspaces/*/endpoints/*}", "can_use_json": true, @@ -142521,6 +144344,16 @@ "is_object": true } }, + { + "name": "external_trigger", + "description": "A trigger that disables automatic materialization, including the initial run\nat creation. Runs are instead triggered through the `TriggerMaterializationSet`\nAPI. Supported only for batch materializations in a materialization set.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ExternalTrigger", + "is_object": true + } + }, { "name": "feature_name", "description": "The full name of the feature in Unity Catalog.", @@ -144813,6 +146646,87 @@ "response_type": {} } }, + { + "name": "TriggerMaterializationSet", + "description": "Requests materialization of all members of the set.\nThe set must be nonempty and contain only batch materializations.\nRuns are allowed while automatic scheduling is paused. Requested runs may wait in a\nqueue, subject to queue limits and expiry.\n\nReturns a long-running operation that completes when every requested run reaches a terminal\nstate. Success requires all runs and any required online synchronization to succeed.\nIndividual outcomes are available in `MaterializationSetTriggerProgress`.\n\nUse `CancelOperation` to request cancellation of this operation's unfinished work.\nCancellation is best effort and does not undo completed writes. Online synchronization\nalready in progress may continue.\n\nRuns use the features' configured windows and settling delay.", + "summary": "Trigger a materialization set.", + "path": "/api/2.0/feature-engineering/materialization-sets/{materialization_set_id}/trigger", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "TriggerMaterializationSetRequest", + "is_object": true, + "required_fields": [ + { + "name": "materialization_set_id", + "description": "The ID of the materialization set to trigger.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "materialization_set_id", + "description": "The ID of the materialization set to trigger.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "materialization_set_id", + "description": "The ID of the materialization set to trigger.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "request_id", + "description": "Idempotency token in UUID format. Reusing it returns the original operation without starting\nadditional runs, even if the request differs or the operation has finished.\nIf omitted, each request triggers independently.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "materialization_set_id", + "description": "The ID of the materialization set to trigger.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, { "name": "UpdateFeature", "description": "Update a Feature.", @@ -146211,6 +148125,16 @@ "is_object": true } }, + { + "name": "external_trigger", + "description": "A trigger that disables automatic materialization, including the initial run\nat creation. Runs are instead triggered through the `TriggerMaterializationSet`\nAPI. Supported only for batch materializations in a materialization set.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "ExternalTrigger", + "is_object": true + } + }, { "name": "feature_name", "description": "The full name of the feature in Unity Catalog.", @@ -158235,7 +160159,7 @@ "methods": [ { "name": "CreateDirectGroupMember", - "description": "Creates a group membership (assigns a principal to a group).\n\nAuthorization: the caller must be an account admin or a manager of the group (holds the\n`roles/group.manager` role on it).", + "description": "Adds a user, service principal, or group as a direct member of a group.\n\nIf automatic identity management is on and the group has an `external_id`, its members come\nfrom your identity provider and can't be changed in Databricks.", "summary": "Create a direct group membership.", "path": "/api/2.0/identity/{parent=accounts/*/groups/*}/direct-members", "can_use_json": true, @@ -158249,7 +160173,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the group to add the member to.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group to add the member to, in the format\n`accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -158258,7 +160182,7 @@ }, { "name": "direct_group_member", - "description": "Required. The direct group member to be added to the group.", + "description": "The member to add. Set its `principal_id`.", "required": true, "is_request_body_field": true, "entity": { @@ -158270,7 +160194,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the group to add the member to.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group to add the member to, in the format\n`accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -158281,7 +160205,7 @@ "required_request_body_fields": [ { "name": "direct_group_member", - "description": "Required. The direct group member to be added to the group.", + "description": "The member to add. Set its `principal_id`.", "required": true, "is_request_body_field": true, "entity": { @@ -158293,7 +160217,7 @@ }, "request_body_field": { "name": "direct_group_member", - "description": "Required. The direct group member to be added to the group.", + "description": "The member to add. Set its `principal_id`.", "required": true, "is_request_body_field": true, "entity": { @@ -158303,7 +160227,7 @@ "required_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -158314,7 +160238,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -158331,7 +160255,7 @@ "required_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -158342,7 +160266,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -158354,7 +160278,7 @@ "all_fields": [ { "name": "direct_group_member", - "description": "Required. The direct group member to be added to the group.", + "description": "The member to add. Set its `principal_id`.", "required": true, "is_request_body_field": true, "entity": { @@ -158364,7 +160288,7 @@ "required_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -158375,7 +160299,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -158387,7 +160311,7 @@ }, { "name": "parent", - "description": "The parent resource name of the group to add the member to.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group to add the member to, in the format\n`accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -158396,7 +160320,7 @@ }, { "name": "display_name", - "description": "Display name of the principal.", + "description": "The member's display name.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -158405,7 +160329,7 @@ }, { "name": "external_id", - "description": "The external ID of the principal in the customer's IdP.", + "description": "The ID of the member in your identity provider (IdP).", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -158414,7 +160338,7 @@ }, { "name": "group_id", - "description": "The internal ID of the group this member belongs to.", + "description": "The Databricks ID of the group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -158423,7 +160347,7 @@ }, { "name": "membership_source", - "description": "The source of group membership (internal or from identity provider).", + "description": "Where the membership comes from.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -158440,7 +160364,7 @@ }, { "name": "name", - "description": "The resource name of the group membership. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}\n- Workspace-scoped: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`\n- Workspace APIs: `groups/{group_id}/direct-members/{principal_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -158448,7 +160372,7 @@ }, { "name": "parent", - "description": "The resource name of the group that contains the membership. The format depends on the API\nthat returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -158457,7 +160381,7 @@ }, { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -158466,7 +160390,7 @@ }, { "name": "principal_type", - "description": "The type of the principal (user/service principal/group).", + "description": "Whether the member is a user, service principal, or group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -158488,7 +160412,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the group to add the member to.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group to add the member to, in the format\n`accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -158497,7 +160421,7 @@ }, { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -158508,7 +160432,7 @@ }, { "name": "CreateGroup", - "description": "Creates a local group in the Databricks account and returns the created group. A local group\nis one that is not synced from the customer's identity provider, and can be created whether or\nnot Account Identity Management (AIM) is enabled.\n\nWhen AIM is enabled, supplying an external ID returns an error. To provision the identity from\nyour identity provider, resolve it by its external ID with ResolveGroup; to read an existing\nexternal identity, use the ExternalGroup resource.", + "description": "Creates a local group, which is a group that isn't synced from your identity provider (IdP).\nYou become a manager of the new group.\n\nIf automatic identity management is on, you can't set `external_id`. To add a group from your\nIdP, get it as an external group instead.", "summary": "Create a group in the account.", "path": "/api/2.0/identity/{parent=accounts/*}/groups", "can_use_json": true, @@ -158522,7 +160446,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the group.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the group in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -158531,7 +160455,7 @@ }, { "name": "group", - "description": "Required. Group to be created in Databricks", + "description": "The group to create.", "required": true, "is_request_body_field": true, "entity": { @@ -158543,7 +160467,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the group.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the group in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -158554,7 +160478,7 @@ "required_request_body_fields": [ { "name": "group", - "description": "Required. Group to be created in Databricks", + "description": "The group to create.", "required": true, "is_request_body_field": true, "entity": { @@ -158566,7 +160490,7 @@ }, "request_body_field": { "name": "group", - "description": "Required. Group to be created in Databricks", + "description": "The group to create.", "required": true, "is_request_body_field": true, "entity": { @@ -158581,7 +160505,7 @@ "all_fields": [ { "name": "group", - "description": "Required. Group to be created in Databricks", + "description": "The group to create.", "required": true, "is_request_body_field": true, "entity": { @@ -158591,7 +160515,7 @@ }, { "name": "parent", - "description": "The parent resource name of the account in which to create the group.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the group in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -158600,7 +160524,7 @@ }, { "name": "account_id", - "description": "The parent account ID for group in Databricks.", + "description": "The ID of the account that contains the group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -158609,7 +160533,7 @@ }, { "name": "external_id", - "description": "ExternalId of the group in the customer's IdP.", + "description": "The ID of the group in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -158617,7 +160541,7 @@ }, { "name": "group_id", - "description": "Internal group ID of the group in Databricks.", + "description": "The Databricks ID of the group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -158626,7 +160550,7 @@ }, { "name": "group_name", - "description": "Display name of the group.", + "description": "The name of the group.", "is_request_body_field": true, "entity": { "is_string": true @@ -158634,7 +160558,7 @@ }, { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -158642,7 +160566,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the group, `accounts/{account_id}`. Both the\naccount-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the group, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -158653,7 +160577,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the group.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the group in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -158664,7 +160588,7 @@ }, { "name": "CreateIdentityVisibilityFilter", - "description": "Creates a group visibility filter in the account. Requires account admin privileges.\nSet `principal_type` to `GROUP` and specify exactly one of `exact` (external ID), `prefix`\n(display-name starts with), or `regex` (full RE2 display-name match).\nThe filter applies across all workspaces in the account.\nA duplicate filter ID or an existing rule with the same type and match value returns\n`ALREADY_EXISTS`. Filters are immutable; to change a rule, delete it and create a new one.", + "description": "Creates a group visibility filter. It applies to every workspace in the account.\n\nReturns `ALREADY_EXISTS` if a filter with the same ID, or the same type and match value,\nalready exists. Returns `RESOURCE_EXHAUSTED` if the account already has the maximum number of\nfilters of that type. You can't change a filter: to change a rule, delete it and create a new\none.", "summary": "Create an identity-visibility filter in the account.", "path": "/api/2.0/identity/{parent=accounts/*}/identity-visibility-filters", "can_use_json": true, @@ -158678,7 +160602,7 @@ "required_fields": [ { "name": "parent", - "description": "Required. The parent account. Format: accounts/{account_id}", + "description": "The resource name of the account, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -158687,7 +160611,7 @@ }, { "name": "identity_visibility_filter", - "description": "Required. The filter to create. Set `principal_type` to `GROUP` and specify exactly one of\n`exact`, `prefix`, or `regex`. The server assigns the resource name; any supplied `name` is ignored.", + "description": "The filter to create. Set `principal_type` to `GROUP` and exactly one of `exact`, `prefix`,\nor `regex`. Databricks sets `name`, so any value you set is ignored.", "required": true, "is_request_body_field": true, "entity": { @@ -158699,7 +160623,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "Required. The parent account. Format: accounts/{account_id}", + "description": "The resource name of the account, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -158710,7 +160634,7 @@ "required_request_body_fields": [ { "name": "identity_visibility_filter", - "description": "Required. The filter to create. Set `principal_type` to `GROUP` and specify exactly one of\n`exact`, `prefix`, or `regex`. The server assigns the resource name; any supplied `name` is ignored.", + "description": "The filter to create. Set `principal_type` to `GROUP` and exactly one of `exact`, `prefix`,\nor `regex`. Databricks sets `name`, so any value you set is ignored.", "required": true, "is_request_body_field": true, "entity": { @@ -158722,7 +160646,7 @@ }, "request_body_field": { "name": "identity_visibility_filter", - "description": "Required. The filter to create. Set `principal_type` to `GROUP` and specify exactly one of\n`exact`, `prefix`, or `regex`. The server assigns the resource name; any supplied `name` is ignored.", + "description": "The filter to create. Set `principal_type` to `GROUP` and exactly one of `exact`, `prefix`,\nor `regex`. Databricks sets `name`, so any value you set is ignored.", "required": true, "is_request_body_field": true, "entity": { @@ -158732,7 +160656,7 @@ "required_fields": [ { "name": "principal_type", - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "required": true, "is_request_body_field": true, "entity": { @@ -158754,7 +160678,7 @@ "required_request_body_fields": [ { "name": "principal_type", - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "required": true, "is_request_body_field": true, "entity": { @@ -158782,7 +160706,7 @@ "required_fields": [ { "name": "principal_type", - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "required": true, "is_request_body_field": true, "entity": { @@ -158804,7 +160728,7 @@ "required_request_body_fields": [ { "name": "principal_type", - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "required": true, "is_request_body_field": true, "entity": { @@ -158827,7 +160751,7 @@ "all_fields": [ { "name": "identity_visibility_filter", - "description": "Required. The filter to create. Set `principal_type` to `GROUP` and specify exactly one of\n`exact`, `prefix`, or `regex`. The server assigns the resource name; any supplied `name` is ignored.", + "description": "The filter to create. Set `principal_type` to `GROUP` and exactly one of `exact`, `prefix`,\nor `regex`. Databricks sets `name`, so any value you set is ignored.", "required": true, "is_request_body_field": true, "entity": { @@ -158837,7 +160761,7 @@ "required_fields": [ { "name": "principal_type", - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "required": true, "is_request_body_field": true, "entity": { @@ -158859,7 +160783,7 @@ "required_request_body_fields": [ { "name": "principal_type", - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "required": true, "is_request_body_field": true, "entity": { @@ -158882,7 +160806,7 @@ }, { "name": "identity_visibility_filter_id", - "description": "Optional. The ID to use for the filter, which becomes the final component of its resource name.\nIf not specified or empty, the server generates one. Must not contain `/`.", + "description": "The ID to give the filter, which becomes the last part of its resource name. If you leave it\nempty, Databricks generates one. It can't contain `/`.", "is_query": true, "entity": { "is_string": true @@ -158890,7 +160814,7 @@ }, { "name": "parent", - "description": "Required. The parent account. Format: accounts/{account_id}", + "description": "The resource name of the account, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -158899,7 +160823,7 @@ }, { "name": "exact", - "description": "Exact match on the group's external ID from the identity provider.", + "description": "Matches a group by its ID in your IdP.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -158909,7 +160833,7 @@ }, { "name": "name", - "description": "The resource name of the identity-visibility filter.\nFormat: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}", + "description": "The resource name of the filter, in the format\n`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -158918,7 +160842,7 @@ }, { "name": "prefix", - "description": "Case-sensitive starts-with match on the group's display name.", + "description": "Matches groups whose display name starts with a prefix.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -158928,7 +160852,7 @@ }, { "name": "principal_type", - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "required": true, "is_request_body_field": true, "entity": { @@ -158948,7 +160872,7 @@ }, { "name": "regex", - "description": "Full, case-sensitive RE2 match on the identity's display name.", + "description": "Matches groups whose display name matches a regular expression.", "is_request_body_field": true, "is_optional_object": true, "entity": { @@ -158960,7 +160884,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "Required. The parent account. Format: accounts/{account_id}", + "description": "The resource name of the account, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -158969,7 +160893,7 @@ }, { "name": "principal_type", - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "required": true, "is_request_body_field": true, "entity": { @@ -158991,7 +160915,7 @@ }, { "name": "CreateServicePrincipal", - "description": "Creates a local service principal in the Databricks account and returns the created service\nprincipal. A local service principal is one that is not synced from the customer's identity\nprovider, and can be created whether or not Account Identity Management (AIM) is enabled.\n\nWhen AIM is enabled, supplying an external ID returns an error. To provision the identity from\nyour identity provider, resolve it by its external ID with ResolveServicePrincipal; to read an\nexisting external identity, use the ExternalServicePrincipal resource.", + "description": "Creates a local service principal, which is a service principal that isn't synced from your\nidentity provider (IdP).\n\nIf automatic identity management is on, you can't set `external_id`. To add a service\nprincipal from your IdP, get it as an external service principal instead.", "summary": "Create a service principal in the account.", "path": "/api/2.0/identity/{parent=accounts/*}/service-principals", "can_use_json": true, @@ -159005,7 +160929,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the service principal.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the service principal in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -159014,7 +160938,7 @@ }, { "name": "service_principal", - "description": "Required. Service principal to be created in Databricks", + "description": "The service principal to create.", "required": true, "is_request_body_field": true, "entity": { @@ -159026,7 +160950,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the service principal.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the service principal in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -159037,7 +160961,7 @@ "required_request_body_fields": [ { "name": "service_principal", - "description": "Required. Service principal to be created in Databricks", + "description": "The service principal to create.", "required": true, "is_request_body_field": true, "entity": { @@ -159049,7 +160973,7 @@ }, "request_body_field": { "name": "service_principal", - "description": "Required. Service principal to be created in Databricks", + "description": "The service principal to create.", "required": true, "is_request_body_field": true, "entity": { @@ -159059,7 +160983,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -159068,7 +160992,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -159087,7 +161011,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -159096,7 +161020,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -159121,7 +161045,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -159130,7 +161054,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -159149,7 +161073,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -159158,7 +161082,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -159178,7 +161102,7 @@ "all_fields": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the service principal.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the service principal in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -159187,7 +161111,7 @@ }, { "name": "service_principal", - "description": "Required. Service principal to be created in Databricks", + "description": "The service principal to create.", "required": true, "is_request_body_field": true, "entity": { @@ -159197,7 +161121,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -159206,7 +161130,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -159225,7 +161149,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -159234,7 +161158,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -159254,7 +161178,7 @@ }, { "name": "account_id", - "description": "The parent account ID for the service principal in Databricks.", + "description": "The ID of the account that contains the service principal.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -159263,7 +161187,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -159280,7 +161204,7 @@ }, { "name": "application_id", - "description": "Application ID of the service principal. Set at creation time and cannot be changed\nafterwards; when omitted, the server generates one.", + "description": "The service principal's application ID, a UUID. If you don't set it when you create the\nservice principal, Databricks generates one. It must be unique in the account and can't be\nchanged.", "is_computed": true, "is_request_body_field": true, "entity": { @@ -159289,7 +161213,7 @@ }, { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -159298,7 +161222,7 @@ }, { "name": "external_id", - "description": "ExternalId of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -159306,7 +161230,7 @@ }, { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -159314,7 +161238,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the service principal,\n`accounts/{account_id}`. Both the account-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the service principal, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -159323,7 +161247,7 @@ }, { "name": "service_principal_id", - "description": "Internal service principal ID of the service principal in Databricks.", + "description": "The Databricks ID of the service principal.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -159334,7 +161258,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the service principal.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the service principal in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -159343,7 +161267,7 @@ }, { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -159352,7 +161276,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -159371,7 +161295,7 @@ }, { "name": "CreateUser", - "description": "Creates a local user in the Databricks account and returns the created user. A local user is\none that is not synced from the customer's identity provider, and can be created whether or not\nAccount Identity Management (AIM) is enabled.\n\nWhen AIM is enabled, supplying an external ID returns an error. To provision the identity from\nyour identity provider, resolve it by its external ID with ResolveUser; to read an existing\nexternal identity, use the ExternalUser resource.", + "description": "Creates a local user, which is a user that isn't synced from your identity provider (IdP).\n\nIf automatic identity management is on, you can't set `external_id`. To add a user from your\nIdP, get them as an external user instead.", "summary": "Create a user in the account.", "path": "/api/2.0/identity/{parent=accounts/*}/users", "can_use_json": true, @@ -159385,7 +161309,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the user.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the user in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -159394,7 +161318,7 @@ }, { "name": "user", - "description": "Required. User to be created in Databricks", + "description": "The user to create.", "required": true, "is_request_body_field": true, "entity": { @@ -159406,7 +161330,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the user.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the user in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -159417,7 +161341,7 @@ "required_request_body_fields": [ { "name": "user", - "description": "Required. User to be created in Databricks", + "description": "The user to create.", "required": true, "is_request_body_field": true, "entity": { @@ -159429,7 +161353,7 @@ }, "request_body_field": { "name": "user", - "description": "Required. User to be created in Databricks", + "description": "The user to create.", "required": true, "is_request_body_field": true, "entity": { @@ -159439,7 +161363,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -159448,6 +161372,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -159457,7 +161382,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -159476,7 +161401,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -159485,6 +161410,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -159494,7 +161420,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -159519,7 +161445,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -159528,6 +161454,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -159537,7 +161464,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -159556,7 +161483,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -159565,6 +161492,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -159574,7 +161502,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -159594,7 +161522,7 @@ "all_fields": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the user.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the user in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -159603,7 +161531,7 @@ }, { "name": "user", - "description": "Required. User to be created in Databricks", + "description": "The user to create.", "required": true, "is_request_body_field": true, "entity": { @@ -159613,7 +161541,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -159622,6 +161550,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -159631,7 +161560,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -159650,7 +161579,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -159659,6 +161588,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -159668,7 +161598,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -159688,7 +161618,7 @@ }, { "name": "account_id", - "description": "The accountId parent of the user in Databricks.", + "description": "The ID of the account that contains the user.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -159697,7 +161627,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -159714,7 +161644,7 @@ }, { "name": "external_id", - "description": "ExternalId of the user in the customer's IdP.", + "description": "The ID of the user in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -159722,6 +161652,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -159731,7 +161662,7 @@ }, { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -159739,7 +161670,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the user, `accounts/{account_id}`. Both the\naccount-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the user, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -159748,7 +161679,7 @@ }, { "name": "user_id", - "description": "Internal userId of the user in Databricks.", + "description": "The Databricks ID of the user.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -159757,7 +161688,7 @@ }, { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -159768,7 +161699,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the account in which to create the user.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to create the user in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -159777,7 +161708,7 @@ }, { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -159786,6 +161717,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -159795,7 +161727,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -159814,7 +161746,7 @@ }, { "name": "CreateWorkspaceAssignment", - "description": "Creates a workspace assignment for a principal. Entitlements are granted one at a time\nrather than atomically. If the request fails partway through, the principal stays assigned to\nthe workspace with only some of the requested entitlements. Get the assignment\nafterwards to confirm which entitlements were granted.", + "description": "Assigns a user, service principal, or group directly to a workspace with the given\nentitlements. Returns an error if the principal is already assigned directly.\n\nEntitlements are granted one at a time. If the request fails partway through, the principal\nstays assigned with only some of the entitlements. Get the assignment afterwards to check which\nwere granted.", "summary": "Create a workspace assignment.", "path": "/api/2.0/identity/{parent=accounts/*/workspaces/*}/workspace-assignments", "can_use_json": true, @@ -159828,7 +161760,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the workspace to assign the principal to.\nFormat: accounts/{account_id}/workspaces/{workspace_id}", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`.", "required": true, "is_path": true, "entity": { @@ -159837,7 +161769,7 @@ }, { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be created in Databricks.", + "description": "The assignment to create. Set its `principal_id` and `entitlements`.", "required": true, "is_request_body_field": true, "entity": { @@ -159849,7 +161781,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the workspace to assign the principal to.\nFormat: accounts/{account_id}/workspaces/{workspace_id}", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`.", "required": true, "is_path": true, "entity": { @@ -159860,7 +161792,7 @@ "required_request_body_fields": [ { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be created in Databricks.", + "description": "The assignment to create. Set its `principal_id` and `entitlements`.", "required": true, "is_request_body_field": true, "entity": { @@ -159872,7 +161804,7 @@ }, "request_body_field": { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be created in Databricks.", + "description": "The assignment to create. Set its `principal_id` and `entitlements`.", "required": true, "is_request_body_field": true, "entity": { @@ -159882,7 +161814,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -159893,7 +161825,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -159910,7 +161842,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -159921,7 +161853,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -159933,7 +161865,7 @@ "all_fields": [ { "name": "parent", - "description": "The parent resource name of the workspace to assign the principal to.\nFormat: accounts/{account_id}/workspaces/{workspace_id}", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`.", "required": true, "is_path": true, "entity": { @@ -159942,7 +161874,7 @@ }, { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be created in Databricks.", + "description": "The assignment to create. Set its `principal_id` and `entitlements`.", "required": true, "is_request_body_field": true, "entity": { @@ -159952,7 +161884,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -159963,7 +161895,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -159975,7 +161907,7 @@ }, { "name": "account_id", - "description": "The account ID parent of the workspace where the principal is assigned", + "description": "The ID of the account that contains the workspace.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -159984,7 +161916,7 @@ }, { "name": "effective_entitlements", - "description": "Every entitlement the principal holds in this workspace, whether granted directly or through\ngroup membership. Get responses populate this field. List responses leave it empty.", + "description": "Every entitlement the principal has in the workspace, granted directly or through a group. List\nresponses leave it empty.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -160016,7 +161948,7 @@ }, { "name": "entitlements", - "description": "Entitlements granted directly to the principal on this workspace. This is the only\nclient-settable field. Create and update manage exactly this set, including entitlements the\nprincipal also holds through a group.\nList responses leave this field empty. Get a single principal to read its entitlements.", + "description": "The entitlements granted directly by this assignment. Create and update set exactly this list,\neven if the principal also gets some of these entitlements through a group. List responses\nleave it empty.", "is_request_body_field": true, "entity": { "pascal_name": "EntitlementList", @@ -160047,7 +161979,7 @@ }, { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -160055,7 +161987,7 @@ }, { "name": "parent", - "description": "The resource name of the workspace that contains the assignment,\n`accounts/{account_id}/workspaces/{workspace_id}`. Both the account-scoped and workspace-scoped\nAPIs return it.", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -160064,7 +161996,7 @@ }, { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -160073,7 +162005,7 @@ }, { "name": "principal_type", - "description": "The type of the principal (user/service principal/group) that is assigned.", + "description": "Whether the assigned principal is a user, service principal, or group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -160093,7 +162025,7 @@ }, { "name": "workspace_id", - "description": "The workspace ID where the principal is assigned.", + "description": "The ID of the workspace.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -160104,7 +162036,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the workspace to assign the principal to.\nFormat: accounts/{account_id}/workspaces/{workspace_id}", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`.", "required": true, "is_path": true, "entity": { @@ -160113,7 +162045,7 @@ }, { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -160417,7 +162349,7 @@ }, { "name": "DeleteDirectGroupMember", - "description": "Deletes a group membership (unassigns a principal from a group).\n\nAuthorization: the caller must be an account admin or a manager of the group (holds the\n`roles/group.manager` role on it).", + "description": "Removes a direct member from a group.\n\nIf automatic identity management is on and the group has an `external_id`, its members come\nfrom your identity provider and can't be changed in Databricks.", "summary": "Delete a direct group membership.", "path": "/api/2.0/identity/{name=accounts/*/groups/*/direct-members/*}", "has_required_positional_arguments": true, @@ -160429,7 +162361,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160440,7 +162372,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160455,7 +162387,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160466,7 +162398,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160477,7 +162409,7 @@ }, { "name": "DeleteGroup", - "description": "Deletes a group from the Databricks account by its internal ID.\n\nAuthorization: the caller must be an account admin or a manager of the group (holds the\n`roles/group.manager` role on it).", + "description": "Deletes a group from your account and removes it from the workspaces it's assigned to.", "summary": "Delete a group in the account.", "path": "/api/2.0/identity/{name=accounts/*/groups/*}", "has_required_positional_arguments": true, @@ -160489,7 +162421,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -160500,7 +162432,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -160515,7 +162447,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -160526,7 +162458,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the group.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -160537,7 +162469,7 @@ }, { "name": "DeleteIdentityVisibilityFilter", - "description": "Deletes a group visibility filter by its resource name. Requires account admin privileges.\nDeleting a filter does not delete groups or revoke access. Groups covered only by this rule\nstop being discoverable unless they or a transitive parent are already provisioned in the\naccount. If no group filters remain, all groups become visible again.\nDeleting a filter that does not exist succeeds without making any changes.", + "description": "Deletes a group visibility filter. Deleting a filter doesn't delete groups or remove access.\nGroups that only this filter matched stop being visible, unless they or a parent group are\nalready in your account. If no group filters remain, all groups become visible again. Deleting\na filter that doesn't exist succeeds.", "summary": "Delete an identity-visibility filter.", "path": "/api/2.0/identity/{name=accounts/*/identity-visibility-filters/*}", "has_required_positional_arguments": true, @@ -160549,7 +162481,7 @@ "required_fields": [ { "name": "name", - "description": "Required. The resource name of the filter.\nFormat: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}", + "description": "The resource name of the filter, in the format\n`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "required": true, "is_path": true, "entity": { @@ -160560,7 +162492,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Required. The resource name of the filter.\nFormat: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}", + "description": "The resource name of the filter, in the format\n`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "required": true, "is_path": true, "entity": { @@ -160575,7 +162507,7 @@ "all_fields": [ { "name": "name", - "description": "Required. The resource name of the filter.\nFormat: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}", + "description": "The resource name of the filter, in the format\n`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "required": true, "is_path": true, "entity": { @@ -160586,7 +162518,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Required. The resource name of the filter.\nFormat: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}", + "description": "The resource name of the filter, in the format\n`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "required": true, "is_path": true, "entity": { @@ -160597,7 +162529,7 @@ }, { "name": "DeleteServicePrincipal", - "description": "Deletes a service principal from the Databricks account by its internal ID.", + "description": "Deletes a service principal from your account and removes it from the workspaces it's\nassigned to. You can't delete service principals that Databricks manages.", "summary": "Delete a service principal in the account.", "path": "/api/2.0/identity/{name=accounts/*/service-principals/*}", "has_required_positional_arguments": true, @@ -160609,7 +162541,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: accounts/{account_id}/service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`accounts/{account_id}/service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160620,7 +162552,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: accounts/{account_id}/service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`accounts/{account_id}/service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160635,7 +162567,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: accounts/{account_id}/service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`accounts/{account_id}/service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160646,7 +162578,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: accounts/{account_id}/service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`accounts/{account_id}/service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160657,7 +162589,7 @@ }, { "name": "DeleteUser", - "description": "Deletes a user from the Databricks account by its internal ID.", + "description": "Deletes a user from your account and removes them from the workspaces they're assigned to.", "summary": "Delete a user in the account.", "path": "/api/2.0/identity/{name=accounts/*/users/*}", "has_required_positional_arguments": true, @@ -160669,7 +162601,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: accounts/{account_id}/users/{user_id}", + "description": "The resource name of the user, in the format `accounts/{account_id}/users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -160680,7 +162612,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: accounts/{account_id}/users/{user_id}", + "description": "The resource name of the user, in the format `accounts/{account_id}/users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -160695,7 +162627,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: accounts/{account_id}/users/{user_id}", + "description": "The resource name of the user, in the format `accounts/{account_id}/users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -160706,7 +162638,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the user.\nFormat: accounts/{account_id}/users/{user_id}", + "description": "The resource name of the user, in the format `accounts/{account_id}/users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -160717,7 +162649,7 @@ }, { "name": "DeleteWorkspaceAssignment", - "description": "Deletes a workspace assignment for a principal, revoking all of its entitlements.\nEntitlements are revoked one at a time rather than atomically. If the request fails partway\nthrough, the principal stays assigned with some of its original entitlements. Retrying is safe.", + "description": "Removes a principal's direct assignment to a workspace and revokes the entitlements it granted.\nThe principal keeps any access it gets through groups.\n\nEntitlements are revoked one at a time. If the request fails partway through, the principal\nstays assigned with some of its entitlements. You can retry the request.", "summary": "Delete a workspace assignment.", "path": "/api/2.0/identity/{name=accounts/*/workspaces/*/workspace-assignments/*}", "has_required_positional_arguments": true, @@ -160729,7 +162661,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160740,7 +162672,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160755,7 +162687,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160766,7 +162698,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160874,7 +162806,7 @@ }, { "name": "GetDirectGroupMember", - "description": "Gets a provisioned direct member of a group.", + "description": "Gets a direct member of a group, including where the membership comes from. Returns an error if\nthe principal isn't a direct member.", "summary": "Get a direct group member.", "path": "/api/2.0/identity/{name=accounts/*/groups/*/direct-members/*}", "has_required_positional_arguments": true, @@ -160886,7 +162818,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160897,7 +162829,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160913,7 +162845,7 @@ "required_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -160924,7 +162856,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -160936,7 +162868,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160947,7 +162879,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -160958,7 +162890,7 @@ }, { "name": "GetExternalGroup", - "description": "Retrieves an external group with the given external ID from the customer's\nIdP. If the group does not exist, it will be created in the account. If the\ncustomer is not onboarded onto Automatic Identity Management (AIM), this will\nreturn an error.", + "description": "Gets a group by its ID in your identity provider (IdP) and syncs its name and parent groups\nfrom your IdP. If the group isn't in your account yet, it's added. Requires automatic identity\nmanagement. If your account has group visibility filters, the group must match them.", "summary": "Get an external group in the account.", "path": "/api/2.0/identity/{name=accounts/*/external-groups/*}", "has_required_positional_arguments": true, @@ -160970,7 +162902,7 @@ "required_fields": [ { "name": "name", - "description": "Required. The resource name of the external group.\nFormat: accounts/{account_id}/external-groups/{external_group_id}", + "description": "The resource name of the external group, in the format\n`accounts/{account_id}/external-groups/{external_group_id}`.", "required": true, "is_path": true, "entity": { @@ -160981,7 +162913,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Required. The resource name of the external group.\nFormat: accounts/{account_id}/external-groups/{external_group_id}", + "description": "The resource name of the external group, in the format\n`accounts/{account_id}/external-groups/{external_group_id}`.", "required": true, "is_path": true, "entity": { @@ -160997,7 +162929,7 @@ "all_fields": [ { "name": "name", - "description": "Required. The resource name of the external group.\nFormat: accounts/{account_id}/external-groups/{external_group_id}", + "description": "The resource name of the external group, in the format\n`accounts/{account_id}/external-groups/{external_group_id}`.", "required": true, "is_path": true, "entity": { @@ -161008,7 +162940,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Required. The resource name of the external group.\nFormat: accounts/{account_id}/external-groups/{external_group_id}", + "description": "The resource name of the external group, in the format\n`accounts/{account_id}/external-groups/{external_group_id}`.", "required": true, "is_path": true, "entity": { @@ -161019,7 +162951,7 @@ }, { "name": "GetExternalServicePrincipal", - "description": "Retrieves an external service principal with the given external ID from the\ncustomer's IdP. If the service principal does not exist, it will be created.\nIf the customer is not onboarded onto Automatic Identity Management (AIM),\nthis will return an error.", + "description": "Gets a service principal by its ID in your identity provider (IdP) and syncs its details and\ngroup memberships from your IdP. If the service principal isn't in your account yet, it's\nadded. Requires automatic identity management with Microsoft Entra ID as your IdP.", "summary": "Get an external service principal in the account.", "path": "/api/2.0/identity/{name=accounts/*/external-service-principals/*}", "has_required_positional_arguments": true, @@ -161031,7 +162963,7 @@ "required_fields": [ { "name": "name", - "description": "Required. The resource name of the external service principal.\nFormat: accounts/{account_id}/external-service-principals/{external_service_principal_id}", + "description": "The resource name of the external service principal, in the format\n`accounts/{account_id}/external-service-principals/{external_service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161042,7 +162974,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Required. The resource name of the external service principal.\nFormat: accounts/{account_id}/external-service-principals/{external_service_principal_id}", + "description": "The resource name of the external service principal, in the format\n`accounts/{account_id}/external-service-principals/{external_service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161058,7 +162990,7 @@ "all_fields": [ { "name": "name", - "description": "Required. The resource name of the external service principal.\nFormat: accounts/{account_id}/external-service-principals/{external_service_principal_id}", + "description": "The resource name of the external service principal, in the format\n`accounts/{account_id}/external-service-principals/{external_service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161069,7 +163001,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Required. The resource name of the external service principal.\nFormat: accounts/{account_id}/external-service-principals/{external_service_principal_id}", + "description": "The resource name of the external service principal, in the format\n`accounts/{account_id}/external-service-principals/{external_service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161080,7 +163012,7 @@ }, { "name": "GetExternalUser", - "description": "Retrieves an external user with the given external ID from the customer's\nIdP. If the user does not exist, it will be created. If the customer is not\nonboarded onto Automatic Identity Management (AIM), this will return an error.", + "description": "Gets a user by their ID in your identity provider (IdP) and syncs their details and group\nmemberships from your IdP. If the user isn't in your account yet, they're added. Requires\nautomatic identity management.", "summary": "Get an external user in the account.", "path": "/api/2.0/identity/{name=accounts/*/external-users/*}", "has_required_positional_arguments": true, @@ -161092,7 +163024,7 @@ "required_fields": [ { "name": "name", - "description": "Required. The resource name of the external user.\nFormat: accounts/{account_id}/external-users/{external_user_id}", + "description": "The resource name of the external user, in the format\n`accounts/{account_id}/external-users/{external_user_id}`.", "required": true, "is_path": true, "entity": { @@ -161103,7 +163035,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Required. The resource name of the external user.\nFormat: accounts/{account_id}/external-users/{external_user_id}", + "description": "The resource name of the external user, in the format\n`accounts/{account_id}/external-users/{external_user_id}`.", "required": true, "is_path": true, "entity": { @@ -161119,7 +163051,7 @@ "all_fields": [ { "name": "name", - "description": "Required. The resource name of the external user.\nFormat: accounts/{account_id}/external-users/{external_user_id}", + "description": "The resource name of the external user, in the format\n`accounts/{account_id}/external-users/{external_user_id}`.", "required": true, "is_path": true, "entity": { @@ -161130,7 +163062,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Required. The resource name of the external user.\nFormat: accounts/{account_id}/external-users/{external_user_id}", + "description": "The resource name of the external user, in the format\n`accounts/{account_id}/external-users/{external_user_id}`.", "required": true, "is_path": true, "entity": { @@ -161141,7 +163073,7 @@ }, { "name": "GetGroup", - "description": "Fetches a group from the Databricks account by its internal ID.", + "description": "Gets a group by its Databricks ID.", "summary": "Get a group in the account.", "path": "/api/2.0/identity/{name=accounts/*/groups/*}", "has_required_positional_arguments": true, @@ -161153,7 +163085,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -161164,7 +163096,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -161180,7 +163112,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -161191,7 +163123,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the group.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -161202,7 +163134,7 @@ }, { "name": "GetIdentityVisibilityFilter", - "description": "Gets a group visibility filter by its resource name. Requires account admin privileges.\nReturns the filter rule, not the groups matched by the rule.", + "description": "Gets a group visibility filter. It returns the rule, not the groups it matches.", "summary": "Get an identity-visibility filter.", "path": "/api/2.0/identity/{name=accounts/*/identity-visibility-filters/*}", "has_required_positional_arguments": true, @@ -161214,7 +163146,7 @@ "required_fields": [ { "name": "name", - "description": "Required. The resource name of the filter.\nFormat: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}", + "description": "The resource name of the filter, in the format\n`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "required": true, "is_path": true, "entity": { @@ -161225,7 +163157,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Required. The resource name of the filter.\nFormat: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}", + "description": "The resource name of the filter, in the format\n`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "required": true, "is_path": true, "entity": { @@ -161241,7 +163173,7 @@ "required_fields": [ { "name": "principal_type", - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "required": true, "is_request_body_field": true, "entity": { @@ -161263,7 +163195,7 @@ "required_request_body_fields": [ { "name": "principal_type", - "description": "The type of principal this rule applies to. Set to `GROUP` when creating a filter.\nOther principal types are not supported for creation.", + "description": "The type of principal the filter applies to. Set it to `GROUP`. Other types aren't supported.", "required": true, "is_request_body_field": true, "entity": { @@ -161286,7 +163218,7 @@ "all_fields": [ { "name": "name", - "description": "Required. The resource name of the filter.\nFormat: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}", + "description": "The resource name of the filter, in the format\n`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "required": true, "is_path": true, "entity": { @@ -161297,7 +163229,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Required. The resource name of the filter.\nFormat: accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}", + "description": "The resource name of the filter, in the format\n`accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}`.", "required": true, "is_path": true, "entity": { @@ -161308,7 +163240,7 @@ }, { "name": "GetServicePrincipal", - "description": "Fetches a service principal from the Databricks account by its internal ID.", + "description": "Gets a service principal by its Databricks ID.", "summary": "Get a service principal in the account.", "path": "/api/2.0/identity/{name=accounts/*/service-principals/*}", "has_required_positional_arguments": true, @@ -161320,7 +163252,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: accounts/{account_id}/service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`accounts/{account_id}/service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161331,7 +163263,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: accounts/{account_id}/service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`accounts/{account_id}/service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161347,7 +163279,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -161356,7 +163288,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -161375,7 +163307,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -161384,7 +163316,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -161404,7 +163336,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: accounts/{account_id}/service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`accounts/{account_id}/service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161415,7 +163347,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: accounts/{account_id}/service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`accounts/{account_id}/service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161426,7 +163358,7 @@ }, { "name": "GetUser", - "description": "Fetches a user from the Databricks account by its internal ID.", + "description": "Gets a user by their Databricks ID.", "summary": "Get a user in the account.", "path": "/api/2.0/identity/{name=accounts/*/users/*}", "has_required_positional_arguments": true, @@ -161438,7 +163370,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: accounts/{account_id}/users/{user_id}", + "description": "The resource name of the user, in the format `accounts/{account_id}/users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -161449,7 +163381,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: accounts/{account_id}/users/{user_id}", + "description": "The resource name of the user, in the format `accounts/{account_id}/users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -161465,7 +163397,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -161474,6 +163406,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -161483,7 +163416,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -161502,7 +163435,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -161511,6 +163444,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -161520,7 +163454,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -161540,7 +163474,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: accounts/{account_id}/users/{user_id}", + "description": "The resource name of the user, in the format `accounts/{account_id}/users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -161551,7 +163485,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the user.\nFormat: accounts/{account_id}/users/{user_id}", + "description": "The resource name of the user, in the format `accounts/{account_id}/users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -161641,7 +163575,7 @@ }, { "name": "GetWorkspaceAssignment", - "description": "Returns the assignment for a principal in a workspace.", + "description": "Gets a principal's direct assignment to a workspace, including its effective entitlements.\nReturns an error if the principal isn't assigned directly.", "summary": "Get a workspace assignment for a principal.", "path": "/api/2.0/identity/{name=accounts/*/workspaces/*/workspace-assignments/*}", "has_required_positional_arguments": true, @@ -161653,7 +163587,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161664,7 +163598,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161680,7 +163614,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -161691,7 +163625,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -161703,7 +163637,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161714,7 +163648,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -161846,7 +163780,7 @@ }, { "name": "ListDirectGroupMembers", - "description": "Lists provisioned direct members of a group with their membership source (internal or from identity provider).", + "description": "Lists the direct members of a group, sorted by display name, with where each membership comes\nfrom. Members in your identity provider who haven't been added to Databricks aren't included.", "summary": "List direct group members.", "path": "/api/2.0/identity/{parent=accounts/*/groups/*}/direct-members", "has_required_positional_arguments": true, @@ -161858,7 +163792,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the group whose direct members to list.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -161869,7 +163803,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the group whose direct members to list.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -161885,7 +163819,7 @@ "all_fields": [ { "name": "page_size", - "description": "The maximum number of members to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of members to return, up to 1000. The default is 1000. A page can contain\nfewer members.", "is_query": true, "entity": { "is_int": true @@ -161893,7 +163827,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListDirectGroupMembers call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -161901,7 +163835,7 @@ }, { "name": "parent", - "description": "The parent resource name of the group whose direct members to list.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -161912,7 +163846,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the group whose direct members to list.\nFormat: accounts/{account_id}/groups/{group_id}", + "description": "The resource name of the group, in the format `accounts/{account_id}/groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -161924,7 +163858,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token, received from a previous ListDirectGroupMembers call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -161935,7 +163869,7 @@ }, { "name": "ListGroups", - "description": "Lists the groups in the Databricks account, returning one page per call. Supports filtering by\ngroup name or external ID.", + "description": "Lists the groups in your account, sorted by Databricks ID. Groups in your identity provider\nthat haven't been added to Databricks aren't included.", "summary": "List groups in the account.", "path": "/api/2.0/identity/{parent=accounts/*}/groups", "has_required_positional_arguments": true, @@ -161947,7 +163881,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the account whose groups to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list groups in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -161958,7 +163892,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the account whose groups to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list groups in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -161974,7 +163908,7 @@ "all_fields": [ { "name": "filter", - "description": "Optional. Allows filtering groups by group name or external id.", + "description": "Filters groups by `group_name` or `external_id`, for example `group_name eq \"Data engineers\"`.\nPut the value in quotes.", "is_query": true, "entity": { "is_string": true @@ -161982,7 +163916,7 @@ }, { "name": "page_size", - "description": "The maximum number of groups to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of groups to return, up to 1000. The default is 1000. A page can contain\nfewer groups.", "is_query": true, "entity": { "is_int": true @@ -161990,7 +163924,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -161998,7 +163932,7 @@ }, { "name": "parent", - "description": "The parent resource name of the account whose groups to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list groups in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162009,7 +163943,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the account whose groups to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list groups in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162021,7 +163955,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -162032,7 +163966,7 @@ }, { "name": "ListIdentityVisibilityFilters", - "description": "Lists group visibility filters in the account, returning one page per call. Requires account\nadmin privileges. Returns filter rules, not the groups matched by those rules.\nTo retrieve the next page, pass the response's `next_page_token` as `page_token` in the next\nrequest. If `next_page_token` is omitted, there are no more pages.", + "description": "Lists the group visibility filters in an account. It returns the rules, not the groups they\nmatch.", "summary": "List the identity-visibility filters in the account.", "path": "/api/2.0/identity/{parent=accounts/*}/identity-visibility-filters", "has_required_positional_arguments": true, @@ -162044,7 +163978,7 @@ "required_fields": [ { "name": "parent", - "description": "Required. The parent account. Format: accounts/{account_id}", + "description": "The resource name of the account, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162055,7 +163989,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "Required. The parent account. Format: accounts/{account_id}", + "description": "The resource name of the account, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162071,7 +164005,7 @@ "all_fields": [ { "name": "page_size", - "description": "The maximum number of filters to return. The service may return fewer than this value.\nIf omitted or non-positive, defaults to 100. Values above 1000 are reduced to 1000.", + "description": "The maximum number of filters to return, up to 1000. The default is 100. A page can contain\nfewer filters.", "is_query": true, "entity": { "is_int": true @@ -162079,7 +164013,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListIdentityVisibilityFilters call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -162087,7 +164021,7 @@ }, { "name": "parent", - "description": "Required. The parent account. Format: accounts/{account_id}", + "description": "The resource name of the account, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162098,7 +164032,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "Required. The parent account. Format: accounts/{account_id}", + "description": "The resource name of the account, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162110,7 +164044,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token, received from a previous ListIdentityVisibilityFilters call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -162121,7 +164055,7 @@ }, { "name": "ListServicePrincipals", - "description": "Lists the service principals in the Databricks account, returning one page per call. Supports\nfiltering by application ID or external ID.", + "description": "Lists the service principals in your account, sorted by Databricks ID. Service principals in\nyour identity provider that haven't been added to Databricks aren't included.", "summary": "List service principals in the account.", "path": "/api/2.0/identity/{parent=accounts/*}/service-principals", "has_required_positional_arguments": true, @@ -162133,7 +164067,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the account whose service principals to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list service principals in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162144,7 +164078,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the account whose service principals to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list service principals in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162160,7 +164094,7 @@ "all_fields": [ { "name": "filter", - "description": "Optional. Allows filtering service principals by application id or external id.", + "description": "Filters service principals by `application_id` or `external_id`, for example\n`application_id eq \"\u003capplication-id\u003e\"`. Put the value in quotes.", "is_query": true, "entity": { "is_string": true @@ -162168,7 +164102,7 @@ }, { "name": "page_size", - "description": "The maximum number of service principals to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of service principals to return, up to 1000. The default is 1000. A page\ncan contain fewer service principals.", "is_query": true, "entity": { "is_int": true @@ -162176,7 +164110,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListServicePrincipals call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -162184,7 +164118,7 @@ }, { "name": "parent", - "description": "The parent resource name of the account whose service principals to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list service principals in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162195,7 +164129,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the account whose service principals to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list service principals in, in the format\n`accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162207,7 +164141,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token, received from a previous ListServicePrincipals call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -162218,7 +164152,7 @@ }, { "name": "ListTransitiveParentGroups", - "description": "Lists all transitive parent groups of a principal.", + "description": "Lists every group that a user, service principal, or group belongs to, directly or through\nother groups, sorted by Databricks ID. If automatic identity management is on, the principal's\ngroup memberships are synced from your identity provider first.", "summary": "List all transitive parent groups of a principal.", "path": "/api/2.0/identity/{parent=accounts/*/principals/*}/transitive-parent-groups", "has_required_positional_arguments": true, @@ -162230,7 +164164,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the principal whose transitive parent groups to list.\nFormat: accounts/{account_id}/principals/{principal_id}", + "description": "The user, service principal, or group whose parent groups to list, in the format\n`accounts/{account_id}/principals/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -162241,7 +164175,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the principal whose transitive parent groups to list.\nFormat: accounts/{account_id}/principals/{principal_id}", + "description": "The user, service principal, or group whose parent groups to list, in the format\n`accounts/{account_id}/principals/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -162257,7 +164191,7 @@ "all_fields": [ { "name": "page_size", - "description": "The maximum number of parent groups to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of groups to return, up to 1000. The default is 1000. A page can contain\nfewer groups.", "is_query": true, "entity": { "is_int": true @@ -162265,7 +164199,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListTransitiveParentGroups call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -162273,7 +164207,7 @@ }, { "name": "parent", - "description": "The parent resource name of the principal whose transitive parent groups to list.\nFormat: accounts/{account_id}/principals/{principal_id}", + "description": "The user, service principal, or group whose parent groups to list, in the format\n`accounts/{account_id}/principals/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -162284,7 +164218,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the principal whose transitive parent groups to list.\nFormat: accounts/{account_id}/principals/{principal_id}", + "description": "The user, service principal, or group whose parent groups to list, in the format\n`accounts/{account_id}/principals/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -162295,7 +164229,7 @@ }, { "name": "ListUsers", - "description": "Lists the users in the Databricks account, returning one page per call. Supports filtering by\nusername or external ID.", + "description": "Lists the users in your account, sorted by Databricks ID. Users in your identity provider who\nhaven't been added to Databricks aren't included.", "summary": "List users in the account.", "path": "/api/2.0/identity/{parent=accounts/*}/users", "has_required_positional_arguments": true, @@ -162307,7 +164241,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the account whose users to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list users in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162318,7 +164252,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the account whose users to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list users in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162334,7 +164268,7 @@ "all_fields": [ { "name": "filter", - "description": "Optional. Allows filtering users by username or external id.", + "description": "Filters users by `username` or `external_id`, for example\n`username eq \"someone@example.com\"`. Put the value in quotes.", "is_query": true, "entity": { "is_string": true @@ -162342,7 +164276,7 @@ }, { "name": "page_size", - "description": "The maximum number of users to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of users to return, up to 1000. The default is 1000. A page can contain\nfewer users.", "is_query": true, "entity": { "is_int": true @@ -162350,7 +164284,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -162358,7 +164292,7 @@ }, { "name": "parent", - "description": "The parent resource name of the account whose users to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list users in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162369,7 +164303,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the account whose users to list.\nFormat: accounts/{account_id}", + "description": "The resource name of the account to list users in, in the format `accounts/{account_id}`.", "required": true, "is_path": true, "entity": { @@ -162381,7 +164315,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -162482,7 +164416,7 @@ }, { "name": "ListWorkspaceAssignments", - "description": "Lists workspace assignments for a workspace. The response omits the per-principal\nentitlement fields (`entitlements` and `effective_entitlements`). To read the entitlements for\na single principal, get that principal's assignment.", + "description": "Lists the principals assigned directly to a workspace. The response leaves `entitlements` and\n`effective_entitlements` empty. To read a principal's entitlements, get its assignment.", "summary": "List workspace assignments for a workspace.", "path": "/api/2.0/identity/{parent=accounts/*/workspaces/*}/workspace-assignments", "has_required_positional_arguments": true, @@ -162494,7 +164428,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the workspace whose assignments to list.\nFormat: accounts/{account_id}/workspaces/{workspace_id}", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`.", "required": true, "is_path": true, "entity": { @@ -162505,7 +164439,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the workspace whose assignments to list.\nFormat: accounts/{account_id}/workspaces/{workspace_id}", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`.", "required": true, "is_path": true, "entity": { @@ -162521,7 +164455,7 @@ "all_fields": [ { "name": "page_size", - "description": "The maximum number of workspace assignments to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of assignments to return, up to 1000. The default is 1000. A page can\ncontain fewer assignments.", "is_query": true, "entity": { "is_int": true @@ -162529,7 +164463,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListWorkspaceAssignments call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -162537,7 +164471,7 @@ }, { "name": "parent", - "description": "The parent resource name of the workspace whose assignments to list.\nFormat: accounts/{account_id}/workspaces/{workspace_id}", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`.", "required": true, "is_path": true, "entity": { @@ -162548,7 +164482,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the workspace whose assignments to list.\nFormat: accounts/{account_id}/workspaces/{workspace_id}", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`.", "required": true, "is_path": true, "entity": { @@ -162560,7 +164494,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token, received from a previous ListWorkspaceAssignments call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -162571,7 +164505,7 @@ }, { "name": "ResolveGroup", - "description": "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.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "description": "Gets a group by its ID in your identity provider (IdP) and syncs its name and parent groups\nfrom your IdP. If the group isn't in your account yet, it's added. Requires automatic identity\nmanagement. If your account has group visibility filters, the group must match them.", "summary": "Resolve an external group in the Databricks account.", "path": "/api/2.0/identity/accounts/{account_id}/groups/resolve-by-external-id", "can_use_json": true, @@ -162587,7 +164521,7 @@ "required_fields": [ { "name": "external_id", - "description": "Required. The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162598,7 +164532,7 @@ "required_request_body_fields": [ { "name": "external_id", - "description": "Required. The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162614,7 +164548,7 @@ "all_fields": [ { "name": "external_id", - "description": "Required. The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162625,7 +164559,7 @@ "required_positional_arguments": [ { "name": "external_id", - "description": "Required. The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162636,7 +164570,7 @@ }, { "name": "ResolveServicePrincipal", - "description": "Resolves a service principal with the given external ID from the customer's IdP. If the service\nprincipal does not exist, it will be created.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "description": "Gets a service principal by its ID in your identity provider (IdP) and syncs its details and\ngroup memberships from your IdP. If the service principal isn't in your account yet, it's\nadded. Requires automatic identity management with Microsoft Entra ID as your IdP.", "summary": "Resolve an external service principal in the Databricks account.", "path": "/api/2.0/identity/accounts/{account_id}/service-principals/resolve-by-external-id", "can_use_json": true, @@ -162652,7 +164586,7 @@ "required_fields": [ { "name": "external_id", - "description": "Required. The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162663,7 +164597,7 @@ "required_request_body_fields": [ { "name": "external_id", - "description": "Required. The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162679,7 +164613,7 @@ "all_fields": [ { "name": "external_id", - "description": "Required. The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162690,7 +164624,7 @@ "required_positional_arguments": [ { "name": "external_id", - "description": "Required. The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162701,7 +164635,7 @@ }, { "name": "ResolveUser", - "description": "Resolves a user with the given external ID from the customer's IdP. If the user does not exist, it will be created.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "description": "Gets a user by their ID in your identity provider (IdP) and syncs their details and group\nmemberships from your IdP. If the user isn't in your account yet, they're added. Requires\nautomatic identity management.", "summary": "Resolve an external user in the Databricks account.", "path": "/api/2.0/identity/accounts/{account_id}/users/resolve-by-external-id", "can_use_json": true, @@ -162717,7 +164651,7 @@ "required_fields": [ { "name": "external_id", - "description": "Required. The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162728,7 +164662,7 @@ "required_request_body_fields": [ { "name": "external_id", - "description": "Required. The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162744,7 +164678,7 @@ "all_fields": [ { "name": "external_id", - "description": "Required. The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162755,7 +164689,7 @@ "required_positional_arguments": [ { "name": "external_id", - "description": "Required. The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -162766,7 +164700,7 @@ }, { "name": "UpdateGroup", - "description": "Updates an existing group in the Databricks account. Only the fields named in the update mask\nare modified. Returns the updated Group resource.\n\nWhen AIM is enabled and the group is an external identity (its external_id is set), only\nexternal_id can be updated; its other fields are sourced from your identity provider.\nWith AIM and group visibility filters, a new nonempty external_id must identify a visible group.\nClearing external_id is allowed.\n\nAuthorization: the caller must be an account admin or a manager of the group (holds the\n`roles/group.manager` role on it).", + "description": "Updates a group. Only the fields in `update_mask` change.\n\nIf automatic identity management is on and the group has an `external_id`, you can only update\n`external_id`. The group's other fields come from your identity provider. If your account also\nhas group visibility filters, a new `external_id` must match them. You can always clear\n`external_id`.", "summary": "Update a group in the account.", "path": "/api/2.0/identity/{name=accounts/*/groups/*}", "can_use_json": true, @@ -162780,7 +164714,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "required": true, "is_path": true, "entity": { @@ -162789,7 +164723,7 @@ }, { "name": "group", - "description": "Required. Group to be updated in Databricks", + "description": "The group to update. Its `name` identifies the group.", "required": true, "is_request_body_field": true, "entity": { @@ -162799,7 +164733,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `group_name` and `external_id`.", "required": true, "is_query": true, "entity": { @@ -162810,7 +164744,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "required": true, "is_path": true, "entity": { @@ -162819,7 +164753,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `group_name` and `external_id`.", "required": true, "is_query": true, "entity": { @@ -162830,7 +164764,7 @@ "required_request_body_fields": [ { "name": "group", - "description": "Required. Group to be updated in Databricks", + "description": "The group to update. Its `name` identifies the group.", "required": true, "is_request_body_field": true, "entity": { @@ -162842,7 +164776,7 @@ }, "request_body_field": { "name": "group", - "description": "Required. Group to be updated in Databricks", + "description": "The group to update. Its `name` identifies the group.", "required": true, "is_request_body_field": true, "entity": { @@ -162857,7 +164791,7 @@ "all_fields": [ { "name": "group", - "description": "Required. Group to be updated in Databricks", + "description": "The group to update. Its `name` identifies the group.", "required": true, "is_request_body_field": true, "entity": { @@ -162867,7 +164801,7 @@ }, { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "required": true, "is_path": true, "entity": { @@ -162876,7 +164810,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `group_name` and `external_id`.", "required": true, "is_query": true, "entity": { @@ -162885,7 +164819,7 @@ }, { "name": "account_id", - "description": "The parent account ID for group in Databricks.", + "description": "The ID of the account that contains the group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -162894,7 +164828,7 @@ }, { "name": "external_id", - "description": "ExternalId of the group in the customer's IdP.", + "description": "The ID of the group in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -162902,7 +164836,7 @@ }, { "name": "group_id", - "description": "Internal group ID of the group in Databricks.", + "description": "The Databricks ID of the group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -162911,7 +164845,7 @@ }, { "name": "group_name", - "description": "Display name of the group.", + "description": "The name of the group.", "is_request_body_field": true, "entity": { "is_string": true @@ -162919,7 +164853,7 @@ }, { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -162927,7 +164861,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the group, `accounts/{account_id}`. Both the\naccount-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the group, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -162938,7 +164872,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "required": true, "is_path": true, "entity": { @@ -162947,7 +164881,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `group_name` and `external_id`.", "required": true, "is_query": true, "entity": { @@ -162958,7 +164892,7 @@ }, { "name": "UpdateServicePrincipal", - "description": "Updates an existing service principal in the Databricks account. Only the fields named in the\nupdate mask are modified. Returns the updated ServicePrincipal resource.\n\nTo change is_agent on a locally managed service principal, set it to true or false. Naming\nis_agent in the update mask without a value leaves it unchanged.\n\nWhen AIM is enabled and the service principal is an external identity (its external_id is set),\nonly external_id can be updated; its other fields are sourced from your identity provider.", + "description": "Updates a service principal. Only the fields in `update_mask` change.\n\nIf automatic identity management is on and the service principal has an `external_id`, you can\nonly update `external_id`. Its other fields come from your identity provider. A service\nprincipal can't deactivate itself, and you can't update service principals that Databricks\nmanages.", "summary": "Update a service principal in the account.", "path": "/api/2.0/identity/{name=accounts/*/service-principals/*}", "can_use_json": true, @@ -162972,7 +164906,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "required": true, "is_path": true, "entity": { @@ -162981,7 +164915,7 @@ }, { "name": "service_principal", - "description": "Required. Service Principal to be updated in Databricks", + "description": "The service principal to update. Its `name` identifies the service principal.", "required": true, "is_request_body_field": true, "entity": { @@ -162991,7 +164925,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `display_name`,\n`account_sp_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -163002,7 +164936,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "required": true, "is_path": true, "entity": { @@ -163011,7 +164945,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `display_name`,\n`account_sp_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -163022,7 +164956,7 @@ "required_request_body_fields": [ { "name": "service_principal", - "description": "Required. Service Principal to be updated in Databricks", + "description": "The service principal to update. Its `name` identifies the service principal.", "required": true, "is_request_body_field": true, "entity": { @@ -163034,7 +164968,7 @@ }, "request_body_field": { "name": "service_principal", - "description": "Required. Service Principal to be updated in Databricks", + "description": "The service principal to update. Its `name` identifies the service principal.", "required": true, "is_request_body_field": true, "entity": { @@ -163044,7 +164978,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -163053,7 +164987,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -163072,7 +165006,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -163081,7 +165015,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -163106,7 +165040,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -163115,7 +165049,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -163134,7 +165068,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -163143,7 +165077,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -163163,7 +165097,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "required": true, "is_path": true, "entity": { @@ -163172,7 +165106,7 @@ }, { "name": "service_principal", - "description": "Required. Service Principal to be updated in Databricks", + "description": "The service principal to update. Its `name` identifies the service principal.", "required": true, "is_request_body_field": true, "entity": { @@ -163182,7 +165116,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -163191,7 +165125,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -163210,7 +165144,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -163219,7 +165153,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -163239,7 +165173,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `display_name`,\n`account_sp_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -163248,7 +165182,7 @@ }, { "name": "account_id", - "description": "The parent account ID for the service principal in Databricks.", + "description": "The ID of the account that contains the service principal.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -163257,7 +165191,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -163274,7 +165208,7 @@ }, { "name": "application_id", - "description": "Application ID of the service principal. Set at creation time and cannot be changed\nafterwards; when omitted, the server generates one.", + "description": "The service principal's application ID, a UUID. If you don't set it when you create the\nservice principal, Databricks generates one. It must be unique in the account and can't be\nchanged.", "is_computed": true, "is_request_body_field": true, "entity": { @@ -163283,7 +165217,7 @@ }, { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -163292,7 +165226,7 @@ }, { "name": "external_id", - "description": "ExternalId of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -163300,7 +165234,7 @@ }, { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -163308,7 +165242,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the service principal,\n`accounts/{account_id}`. Both the account-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the service principal, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -163317,7 +165251,7 @@ }, { "name": "service_principal_id", - "description": "Internal service principal ID of the service principal in Databricks.", + "description": "The Databricks ID of the service principal.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -163328,7 +165262,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "required": true, "is_path": true, "entity": { @@ -163337,7 +165271,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `display_name`,\n`account_sp_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -163346,7 +165280,7 @@ }, { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -163355,7 +165289,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -163374,7 +165308,7 @@ }, { "name": "UpdateUser", - "description": "Updates an existing user in the Databricks account and returns the updated user. Only the\nfields named in the update mask are modified. The updatable fields are fullName.givenName,\nfullName.familyName, status, and externalId.\n\nWhen AIM is enabled and the user is an external identity (its external_id is set), only\nexternal_id can be updated; its other fields are sourced from your identity provider.", + "description": "Updates a user. Only the fields in `update_mask` change.\n\nIf automatic identity management is on and the user has an `external_id`, you can only update\n`external_id`. The user's other fields come from your identity provider. You can't deactivate\nyourself or change the status of the account owner.", "summary": "Update a user in the account.", "path": "/api/2.0/identity/{name=accounts/*/users/*}", "can_use_json": true, @@ -163388,7 +165322,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "required": true, "is_path": true, "entity": { @@ -163397,7 +165331,7 @@ }, { "name": "user", - "description": "Required. User to be updated in Databricks", + "description": "The user to update. Its `name` identifies the user.", "required": true, "is_request_body_field": true, "entity": { @@ -163407,7 +165341,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `full_name.given_name`,\n`full_name.family_name`, `account_user_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -163418,7 +165352,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "required": true, "is_path": true, "entity": { @@ -163427,7 +165361,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `full_name.given_name`,\n`full_name.family_name`, `account_user_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -163438,7 +165372,7 @@ "required_request_body_fields": [ { "name": "user", - "description": "Required. User to be updated in Databricks", + "description": "The user to update. Its `name` identifies the user.", "required": true, "is_request_body_field": true, "entity": { @@ -163450,7 +165384,7 @@ }, "request_body_field": { "name": "user", - "description": "Required. User to be updated in Databricks", + "description": "The user to update. Its `name` identifies the user.", "required": true, "is_request_body_field": true, "entity": { @@ -163460,7 +165394,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -163469,6 +165403,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -163478,7 +165413,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -163497,7 +165432,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -163506,6 +165441,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -163515,7 +165451,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -163540,7 +165476,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -163549,6 +165485,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -163558,7 +165495,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -163577,7 +165514,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -163586,6 +165523,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -163595,7 +165533,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -163615,7 +165553,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "required": true, "is_path": true, "entity": { @@ -163624,7 +165562,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `full_name.given_name`,\n`full_name.family_name`, `account_user_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -163633,7 +165571,7 @@ }, { "name": "user", - "description": "Required. User to be updated in Databricks", + "description": "The user to update. Its `name` identifies the user.", "required": true, "is_request_body_field": true, "entity": { @@ -163643,7 +165581,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -163652,6 +165590,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -163661,7 +165600,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -163680,7 +165619,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -163689,6 +165628,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -163698,7 +165638,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -163718,7 +165658,7 @@ }, { "name": "account_id", - "description": "The accountId parent of the user in Databricks.", + "description": "The ID of the account that contains the user.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -163727,7 +165667,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -163744,7 +165684,7 @@ }, { "name": "external_id", - "description": "ExternalId of the user in the customer's IdP.", + "description": "The ID of the user in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -163752,6 +165692,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -163761,7 +165702,7 @@ }, { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -163769,7 +165710,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the user, `accounts/{account_id}`. Both the\naccount-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the user, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -163778,7 +165719,7 @@ }, { "name": "user_id", - "description": "Internal userId of the user in Databricks.", + "description": "The Databricks ID of the user.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -163787,7 +165728,7 @@ }, { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -163798,7 +165739,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "required": true, "is_path": true, "entity": { @@ -163807,7 +165748,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `full_name.given_name`,\n`full_name.family_name`, `account_user_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -163816,7 +165757,7 @@ }, { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -163825,6 +165766,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -163834,7 +165776,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -163853,7 +165795,7 @@ }, { "name": "UpdateWorkspaceAssignment", - "description": "Updates the entitlements of a directly assigned principal in a workspace. Changes are applied\none at a time rather than atomically. If the request fails partway through, only some of the\nrequested changes take effect. Get the assignment afterwards to confirm the final state.", + "description": "Replaces the entitlements of a principal's direct assignment to a workspace. The new list can't\nbe empty.\n\nEntitlements are changed one at a time. If the request fails partway through, only some of the\nchanges take effect. Get the assignment afterwards to check the result.", "summary": "Update a workspace assignment.", "path": "/api/2.0/identity/{name=accounts/*/workspaces/*/workspace-assignments/*}", "can_use_json": true, @@ -163868,7 +165810,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "required": true, "is_path": true, "entity": { @@ -163877,7 +165819,7 @@ }, { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be updated in Databricks.", + "description": "The assignment to update. Its `name` identifies the assignment.", "required": true, "is_request_body_field": true, "entity": { @@ -163887,7 +165829,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `entitlements`.", "required": true, "is_query": true, "entity": { @@ -163898,7 +165840,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "required": true, "is_path": true, "entity": { @@ -163907,7 +165849,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `entitlements`.", "required": true, "is_query": true, "entity": { @@ -163918,7 +165860,7 @@ "required_request_body_fields": [ { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be updated in Databricks.", + "description": "The assignment to update. Its `name` identifies the assignment.", "required": true, "is_request_body_field": true, "entity": { @@ -163930,7 +165872,7 @@ }, "request_body_field": { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be updated in Databricks.", + "description": "The assignment to update. Its `name` identifies the assignment.", "required": true, "is_request_body_field": true, "entity": { @@ -163940,7 +165882,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -163951,7 +165893,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -163968,7 +165910,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -163979,7 +165921,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -163991,7 +165933,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "required": true, "is_path": true, "entity": { @@ -164000,7 +165942,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `entitlements`.", "required": true, "is_query": true, "entity": { @@ -164009,7 +165951,7 @@ }, { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be updated in Databricks.", + "description": "The assignment to update. Its `name` identifies the assignment.", "required": true, "is_request_body_field": true, "entity": { @@ -164019,7 +165961,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -164030,7 +165972,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -164042,7 +165984,7 @@ }, { "name": "account_id", - "description": "The account ID parent of the workspace where the principal is assigned", + "description": "The ID of the account that contains the workspace.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -164051,7 +165993,7 @@ }, { "name": "effective_entitlements", - "description": "Every entitlement the principal holds in this workspace, whether granted directly or through\ngroup membership. Get responses populate this field. List responses leave it empty.", + "description": "Every entitlement the principal has in the workspace, granted directly or through a group. List\nresponses leave it empty.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -164083,7 +166025,7 @@ }, { "name": "entitlements", - "description": "Entitlements granted directly to the principal on this workspace. This is the only\nclient-settable field. Create and update manage exactly this set, including entitlements the\nprincipal also holds through a group.\nList responses leave this field empty. Get a single principal to read its entitlements.", + "description": "The entitlements granted directly by this assignment. Create and update set exactly this list,\neven if the principal also gets some of these entitlements through a group. List responses\nleave it empty.", "is_request_body_field": true, "entity": { "pascal_name": "EntitlementList", @@ -164114,7 +166056,7 @@ }, { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -164122,7 +166064,7 @@ }, { "name": "parent", - "description": "The resource name of the workspace that contains the assignment,\n`accounts/{account_id}/workspaces/{workspace_id}`. Both the account-scoped and workspace-scoped\nAPIs return it.", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -164131,7 +166073,7 @@ }, { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -164140,7 +166082,7 @@ }, { "name": "principal_type", - "description": "The type of the principal (user/service principal/group) that is assigned.", + "description": "Whether the assigned principal is a user, service principal, or group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -164160,7 +166102,7 @@ }, { "name": "workspace_id", - "description": "The workspace ID where the principal is assigned.", + "description": "The ID of the workspace.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -164171,7 +166113,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "required": true, "is_path": true, "entity": { @@ -164180,7 +166122,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `entitlements`.", "required": true, "is_query": true, "entity": { @@ -164189,7 +166131,7 @@ }, { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -175228,7 +177170,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -175244,15 +177186,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ], "required_request_body_fields": [ @@ -175276,7 +177209,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -175292,15 +177225,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ] } @@ -175330,7 +177254,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -175346,15 +177270,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ], "required_request_body_fields": [ @@ -175378,7 +177293,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -175394,15 +177309,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ] }, @@ -175436,7 +177342,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -175452,15 +177358,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ], "required_request_body_fields": [ @@ -175484,7 +177381,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -175500,15 +177397,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ] } @@ -175596,7 +177484,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -175773,8 +177661,7 @@ }, { "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, + "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request except a rename-only PATCH; there is no default warehouse. The requester\nmust be able to use the warehouse. It is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", "is_request_body_field": true, "entity": { "is_string": true @@ -175802,7 +177689,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -175818,15 +177705,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ] }, @@ -175901,7 +177779,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -175982,7 +177860,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -176069,7 +177947,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -176150,7 +178028,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -176242,7 +178120,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -176323,7 +178201,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -176645,7 +178523,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -176778,7 +178656,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -177139,7 +179017,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -177155,15 +179033,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ], "required_request_body_fields": [ @@ -177187,7 +179056,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -177203,15 +179072,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ] }, @@ -177358,7 +179218,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -177439,7 +179299,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -178387,7 +180247,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -178403,15 +180263,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ], "required_request_body_fields": [ @@ -178435,7 +180286,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -178451,15 +180302,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ] } @@ -178489,7 +180331,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -178505,15 +180347,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ], "required_request_body_fields": [ @@ -178537,7 +180370,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -178553,15 +180386,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ] }, @@ -178595,7 +180419,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -178611,15 +180435,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ], "required_request_body_fields": [ @@ -178643,7 +180458,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -178659,15 +180474,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ] } @@ -178781,7 +180587,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -178958,8 +180764,7 @@ }, { "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, + "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request except a rename-only PATCH; there is no default warehouse. The requester\nmust be able to use the warehouse. It is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", "is_request_body_field": true, "entity": { "is_string": true @@ -179005,7 +180810,7 @@ }, { "name": "datasource_name", - "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncannot be changed afterward. Reads return the value as supplied; the datasource's current\nUnity Catalog name, which reflects renames, is reported in `effective_datasource_name`.", + "description": "Name of the datasource in Unity Catalog, unique within its schema. Required on create and\ncan be updated within the same catalog and schema. Get synchronizes this field with the\ncurrent Unity Catalog name, also reported in `effective_datasource_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -179021,15 +180826,6 @@ "pascal_name": "Schedule", "is_object": true } - }, - { - "name": "warehouse_id", - "description": "ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update\nrequest, such as source and destination access checks. Required and non-blank on every create\nand update request; there is no default warehouse. The requester must be able to use the\nwarehouse. Used only for those checks: it is not stored, is not returned on reads, and does\nnot affect the compute that runs the ingestion job.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } } ] }, @@ -179363,7 +181159,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -179444,7 +181240,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -179531,7 +181327,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -179612,7 +181408,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -179721,7 +181517,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -179802,7 +181598,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -180133,7 +181929,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -180284,7 +182080,7 @@ }, { "name": "rule_name", - "description": "Name of the rule within its Unity Catalog schema. Required. Cannot be changed after\ncreation. Reads return the value as supplied; the current UC name is reported in\n`effective_rule_name`.", + "description": "Name of the rule within its Unity Catalog schema. Required on create; can be updated\nwithin the same catalog and schema. Get synchronizes this field with the current Unity Catalog\nname, also reported in `effective_rule_name`.", "required": true, "is_request_body_field": true, "entity": { @@ -198563,10 +200359,154 @@ "cli_launch_stage_display": "GA", "list": { "request": { - "pascal_name": "ListBranchesRequest" + "pascal_name": "ListAssessmentsRequest" } }, "methods": [ + { + "name": "AcknowledgeAssessmentWarnings", + "description": "Acknowledges non-blocking warnings on a specific assessment.", + "summary": "Acknowledge assessment warnings.", + "path": "/api/2.0/postgres/{name=migrations/*/assessments/*}/acknowledgeWarnings", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "AcknowledgeAssessmentWarningsRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The assessment resource name, in the format `migrations/{migration}/assessments/{assessment}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The assessment resource name, in the format `migrations/{migration}/assessments/{assessment}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The assessment resource name, in the format `migrations/{migration}/assessments/{assessment}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The assessment resource name, in the format `migrations/{migration}/assessments/{assessment}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, + { + "name": "AssessMigration", + "description": "Creates an immutable assessment run for the migration's current source configuration.", + "summary": "Assess a migration.", + "path": "/api/2.0/postgres/{name=migrations/*}/assess", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "AssessMigrationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, { "name": "CreateBranch", "description": "Creates a new database branch in the project.", @@ -199917,6 +201857,469 @@ "response_type": {} } }, + { + "name": "CreateMigration", + "description": "Creates a migration.", + "summary": "Create a migration.", + "path": "/api/2.0/postgres/migrations", + "can_use_json": true, + "is_crud_create": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "CreateMigrationRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "migration", + "description": "Required. The migration to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Migration", + "is_object": true + } + }, + { + "name": "migration_id", + "description": "Required. The ID to use for the migration. It becomes the final component of the resource name\n(`migrations/{migration_id}`). It must be 1-63 characters long, start with a lowercase letter,\nand contain only lowercase letters, numbers, and hyphens.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "migration_id", + "description": "Required. The ID to use for the migration. It becomes the final component of the resource name\n(`migrations/{migration_id}`). It must be 1-63 characters long, start with a lowercase letter,\nand contain only lowercase letters, numbers, and hyphens.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "migration", + "description": "Required. The migration to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Migration", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "migration", + "description": "Required. The migration to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Migration", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ] + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "migration", + "description": "Required. The migration to create.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Migration", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ] + } + }, + { + "name": "migration_id", + "description": "Required. The ID to use for the migration. It becomes the final component of the resource name\n(`migrations/{migration_id}`). It must be 1-63 characters long, start with a lowercase letter,\nand contain only lowercase letters, numbers, and hyphens.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "create_time", + "description": "Output-only. The time when the migration was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "delete_time", + "description": "Output-only. The time when the migration was soft-deleted. Empty if the migration is active.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "error", + "description": "Output-only. The current error preventing migration progress, if any.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MigrationError", + "is_object": true + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + }, + { + "name": "name", + "description": "The migration resource name, in the format `migrations/{migration}`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "purge_time", + "description": "Output-only. The time when the soft-deleted migration is scheduled for permanent deletion.\nEmpty if the migration is active or permanent deletion is not scheduled.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "state", + "description": "Output-only. The authoritative migration lifecycle state.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationState", + "enum": [ + { + "content": "MIGRATION_STATE_ASSESSING" + }, + { + "content": "MIGRATION_STATE_ASSESSMENT_NEEDS_ACTION" + }, + { + "content": "MIGRATION_STATE_COMPLETED" + }, + { + "content": "MIGRATION_STATE_DRAFT" + }, + { + "content": "MIGRATION_STATE_FAILED" + }, + { + "content": "MIGRATION_STATE_INITIAL_DATA_LOAD" + }, + { + "content": "MIGRATION_STATE_READY_TO_START" + }, + { + "content": "MIGRATION_STATE_SCHEMA_LOAD" + } + ] + } + }, + { + "name": "target_branch", + "description": "The Lakebase branch receiving the migrated databases, in the format\n`projects/{project_id}/branches/{branch_id}`. May be omitted during assessment, but must be\nset before the migration starts, and may be changed until then.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Output-only. The time when the migration was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "migration_id", + "description": "Required. The ID to use for the migration. It becomes the final component of the resource name\n(`migrations/{migration_id}`). It must be 1-63 characters long, start with a lowercase letter,\nand contain only lowercase letters, numbers, and hyphens.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, { "name": "CreateProject", "description": "Creates a new Lakebase Autoscaling Postgres database project, which contains branches and compute endpoints.", @@ -200225,7 +202628,7 @@ }, { "name": "replace_existing", - "description": "If true, update the role if it already exists instead of returning an\nerror. This requires `role_id` to be set. Without `role_id`, the request\nfollows the normal create path and fails if the role name already exists.\n\nWhen the role already exists, only mutable fields are updated.\nAttributes omitted from the request retain their current values.\nSet an attribute explicitly to false to disable it.\n`identity_type`, `auth_method`, and `postgres_role` retain their\nexisting values; supplied values for these fields are ignored.\n`membership_roles` is overwritten, not merged. Leaving\n`membership_roles` empty clears all of the role's existing memberships,\nincluding `DATABRICKS_SUPERUSER`. Always send the complete desired list\nof memberships when using this field.", + "description": "If true, update the role if it already exists instead of returning an\nerror. This requires `role_id` to be set. Without `role_id`, the request\nfollows the normal create path and fails if the role name already exists.\n\nWhen the role already exists, only mutable fields are updated.\nAttributes omitted from the request retain their current values.\nSet an attribute explicitly to false to disable it.\n`identity_type`, `auth_method`, and `postgres_role` retain their\nexisting values. Omit these fields or supply their current values.\nA differing supplied value returns INVALID_PARAMETER_VALUE and rejects\nthe entire request, including changes to mutable fields.\n`membership_roles` is overwritten, not merged. Leaving\n`membership_roles` empty clears all of the role's existing memberships,\nincluding `DATABRICKS_SUPERUSER`. Always send the complete desired list\nof memberships when using this field.", "is_query": true, "entity": { "is_bool": true @@ -201171,6 +203574,78 @@ } } }, + { + "name": "DeleteMigration", + "description": "Soft-deletes a migration.", + "summary": "Delete a migration.", + "path": "/api/2.0/postgres/{name=migrations/*}", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "DeleteMigrationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, { "name": "DeleteProject", "description": "Deletes the specified database project.", @@ -201573,6 +204048,69 @@ } ] }, + { + "name": "GetAssessment", + "description": "Gets a migration assessment run.", + "summary": "Get a migration assessment.", + "path": "/api/2.0/postgres/{name=migrations/*/assessments/*}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetAssessmentRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The assessment resource name, in the format `migrations/{migration}/assessments/{assessment}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The assessment resource name, in the format `migrations/{migration}/assessments/{assessment}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Assessment", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The assessment resource name, in the format `migrations/{migration}/assessments/{assessment}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The assessment resource name, in the format `migrations/{migration}/assessments/{assessment}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, { "name": "GetBranch", "description": "Retrieves information about the specified database branch.", @@ -202071,6 +204609,152 @@ } ] }, + { + "name": "GetMigration", + "description": "Gets a migration.", + "summary": "Get a migration.", + "path": "/api/2.0/postgres/{name=migrations/*}", + "is_crud_read": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "GetMigrationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Migration", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ] + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, { "name": "GetOperation", "description": "Retrieves the status of a long-running operation.", @@ -202443,6 +205127,96 @@ } ] }, + { + "name": "ListAssessments", + "description": "Lists assessment runs for a migration.", + "summary": "List migration assessments.", + "path": "/api/2.0/postgres/{parent=migrations/*}/assessments", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListAssessmentsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "Required. The parent migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Required. The parent migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListAssessmentsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of assessments to return. The server default is 100; values above 1000 are\ncapped to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token from a previous call.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Required. The parent migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Required. The parent migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token from a previous call.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, { "name": "ListBranches", "description": "Returns a paginated list of database branches in the project.", @@ -202900,6 +205674,62 @@ } } }, + { + "name": "ListMigrations", + "description": "Lists migrations in the workspace.", + "summary": "List migrations.", + "path": "/api/2.0/postgres/migrations", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListMigrationsRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListMigrationsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "The maximum number of migrations to return. The server default is 100; values above 1000 are\ncapped to 1000.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "A page token from a previous call.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "show_deleted", + "description": "Whether to include soft-deleted migrations in the response. Hard-deleted and already-purged\nmigrations are never returned.", + "is_query": true, + "entity": { + "is_bool": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "A page token from a previous call.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, { "name": "ListProjects", "description": "Returns a paginated list of database projects in the workspace that the user has permission to access.", @@ -203195,6 +206025,78 @@ } ] }, + { + "name": "StartMigration", + "description": "Starts the assessed migration named in the request, moving it from READY_TO_START into\nexecution. Its first phase, SCHEMA_LOAD, creates the target databases, roles, and schema on the\nmigration's target Lakebase branch without copying any table data, ahead of INITIAL_DATA_LOAD.", + "summary": "Start a migration.", + "path": "/api/2.0/postgres/{name=migrations/*}/start", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "StartMigrationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, { "name": "UndeleteBranch", "description": "Undeletes the specified database branch.", @@ -203269,6 +206171,78 @@ } } }, + { + "name": "UndeleteMigration", + "description": "Restores a soft-deleted migration before it is permanently purged.", + "summary": "Undelete a migration.", + "path": "/api/2.0/postgres/{name=migrations/*}/undelete", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UndeleteMigrationRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Required. The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, { "name": "UndeleteProject", "description": "Undeletes a soft-deleted project.", @@ -204230,6 +207204,505 @@ "response_type": {} } }, + { + "name": "UpdateMigration", + "description": "Updates user-owned migration configuration.", + "summary": "Update a migration.", + "path": "/api/2.0/postgres/{name=migrations/*}", + "can_use_json": true, + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "UpdateMigrationRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "migration", + "description": "Required. The migration containing the user-owned fields to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Migration", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Required. The fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Required. The fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "migration", + "description": "Required. The migration containing the user-owned fields to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Migration", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "migration", + "description": "Required. The migration containing the user-owned fields to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Migration", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ] + } + }, + "response": { + "pascal_name": "Operation", + "is_object": true + }, + "all_fields": [ + { + "name": "migration", + "description": "Required. The migration containing the user-owned fields to update.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "Migration", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ], + "required_request_body_fields": [ + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ] + } + }, + { + "name": "name", + "description": "The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Required. The fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "Output-only. The time when the migration was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "delete_time", + "description": "Output-only. The time when the migration was soft-deleted. Empty if the migration is active.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "error", + "description": "Output-only. The current error preventing migration progress, if any.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "MigrationError", + "is_object": true + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + }, + { + "name": "name", + "description": "The migration resource name, in the format `migrations/{migration}`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "purge_time", + "description": "Output-only. The time when the soft-deleted migration is scheduled for permanent deletion.\nEmpty if the migration is active or permanent deletion is not scheduled.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "state", + "description": "Output-only. The authoritative migration lifecycle state.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationState", + "enum": [ + { + "content": "MIGRATION_STATE_ASSESSING" + }, + { + "content": "MIGRATION_STATE_ASSESSMENT_NEEDS_ACTION" + }, + { + "content": "MIGRATION_STATE_COMPLETED" + }, + { + "content": "MIGRATION_STATE_DRAFT" + }, + { + "content": "MIGRATION_STATE_FAILED" + }, + { + "content": "MIGRATION_STATE_INITIAL_DATA_LOAD" + }, + { + "content": "MIGRATION_STATE_READY_TO_START" + }, + { + "content": "MIGRATION_STATE_SCHEMA_LOAD" + } + ] + } + }, + { + "name": "target_branch", + "description": "The Lakebase branch receiving the migrated databases, in the format\n`projects/{project_id}/branches/{branch_id}`. May be omitted during assessment, but must be\nset before the migration starts, and may be changed until then.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Output-only. The time when the migration was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "The migration resource name, in the format `migrations/{migration}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Required. The fields to update.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "source_connection", + "description": "Required. The name of the Unity Catalog connection (a UC securable name, such as\n`my_postgres_connection`) used to connect to the source PostgreSQL server.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "database_mappings", + "description": "Required. Mappings from source databases to target databases.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "DatabaseMappingList", + "array_value": { + "pascal_name": "DatabaseMapping", + "is_object": true + } + } + }, + { + "name": "migration_type", + "description": "Required. Immutable. The intended migration mode, selected when the migration is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "MigrationType", + "enum": [ + { + "content": "MIGRATION_TYPE_ONE_TIME_COPY" + }, + { + "content": "MIGRATION_TYPE_ONLINE" + } + ] + } + } + ], + "long_running_operation": { + "get_operation": { + "kebab_name": "get-operation", + "pascal_name": "GetOperation", + "request": { + "pascal_name": "GetOperationRequest" + } + }, + "response_type": {} + } + }, { "name": "UpdateProject", "description": "Updates the specified database project.", @@ -204525,7 +207998,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update. Supported fields are\n`spec.membership_roles`, `spec.attributes.createdb`,\n`spec.attributes.createrole`, and `spec.attributes.bypassrls`.\n\n`spec.identity_type`, `spec.auth_method`, and `spec.postgres_role`\ncannot be changed. Values supplied for these fields in the request\nbody are ignored. Including one of these fields as an explicit path\nin update_mask returns an INVALID_PARAMETER_VALUE error.\nWhen `spec` is the only path in the mask, only the supplied mutable\nattributes are updated.\n`*` by itself, or `spec` combined with other supported paths, selects all\nsupported mutable fields. For these masks, all three attributes\n(`createdb`, `createrole`, and `bypassrls`) must be supplied; omitting any\nreturns an INVALID_PARAMETER_VALUE error.\nEach of these mask forms replaces `membership_roles`.\nOmitting it or supplying an empty list clears all memberships, including\n`DATABRICKS_SUPERUSER`.", + "description": "The list of fields to update. Supported fields are\n`spec.membership_roles`, `spec.attributes.createdb`,\n`spec.attributes.createrole`, and `spec.attributes.bypassrls`.\n\n`spec.identity_type`, `spec.auth_method`, and `spec.postgres_role`\ncannot be changed. Including an immutable field as an explicit path in\nupdate_mask returns INVALID_PARAMETER_VALUE. With `*` or masks containing\nonly mutable fields, supplied values for these immutable fields are ignored.\n`*` by itself selects all supported mutable fields. For this mask,\nall three attributes (`createdb`, `createrole`, and `bypassrls`) must be\nsupplied; omitting any returns an INVALID_PARAMETER_VALUE error.\nThe `*` mask replaces `membership_roles`.\nOmitting it or supplying an empty list clears all memberships, including\n`DATABRICKS_SUPERUSER`.", "required": true, "is_query": true, "entity": { @@ -204545,7 +208018,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update. Supported fields are\n`spec.membership_roles`, `spec.attributes.createdb`,\n`spec.attributes.createrole`, and `spec.attributes.bypassrls`.\n\n`spec.identity_type`, `spec.auth_method`, and `spec.postgres_role`\ncannot be changed. Values supplied for these fields in the request\nbody are ignored. Including one of these fields as an explicit path\nin update_mask returns an INVALID_PARAMETER_VALUE error.\nWhen `spec` is the only path in the mask, only the supplied mutable\nattributes are updated.\n`*` by itself, or `spec` combined with other supported paths, selects all\nsupported mutable fields. For these masks, all three attributes\n(`createdb`, `createrole`, and `bypassrls`) must be supplied; omitting any\nreturns an INVALID_PARAMETER_VALUE error.\nEach of these mask forms replaces `membership_roles`.\nOmitting it or supplying an empty list clears all memberships, including\n`DATABRICKS_SUPERUSER`.", + "description": "The list of fields to update. Supported fields are\n`spec.membership_roles`, `spec.attributes.createdb`,\n`spec.attributes.createrole`, and `spec.attributes.bypassrls`.\n\n`spec.identity_type`, `spec.auth_method`, and `spec.postgres_role`\ncannot be changed. Including an immutable field as an explicit path in\nupdate_mask returns INVALID_PARAMETER_VALUE. With `*` or masks containing\nonly mutable fields, supplied values for these immutable fields are ignored.\n`*` by itself selects all supported mutable fields. For this mask,\nall three attributes (`createdb`, `createrole`, and `bypassrls`) must be\nsupplied; omitting any returns an INVALID_PARAMETER_VALUE error.\nThe `*` mask replaces `membership_roles`.\nOmitting it or supplying an empty list clears all memberships, including\n`DATABRICKS_SUPERUSER`.", "required": true, "is_query": true, "entity": { @@ -204602,7 +208075,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update. Supported fields are\n`spec.membership_roles`, `spec.attributes.createdb`,\n`spec.attributes.createrole`, and `spec.attributes.bypassrls`.\n\n`spec.identity_type`, `spec.auth_method`, and `spec.postgres_role`\ncannot be changed. Values supplied for these fields in the request\nbody are ignored. Including one of these fields as an explicit path\nin update_mask returns an INVALID_PARAMETER_VALUE error.\nWhen `spec` is the only path in the mask, only the supplied mutable\nattributes are updated.\n`*` by itself, or `spec` combined with other supported paths, selects all\nsupported mutable fields. For these masks, all three attributes\n(`createdb`, `createrole`, and `bypassrls`) must be supplied; omitting any\nreturns an INVALID_PARAMETER_VALUE error.\nEach of these mask forms replaces `membership_roles`.\nOmitting it or supplying an empty list clears all memberships, including\n`DATABRICKS_SUPERUSER`.", + "description": "The list of fields to update. Supported fields are\n`spec.membership_roles`, `spec.attributes.createdb`,\n`spec.attributes.createrole`, and `spec.attributes.bypassrls`.\n\n`spec.identity_type`, `spec.auth_method`, and `spec.postgres_role`\ncannot be changed. Including an immutable field as an explicit path in\nupdate_mask returns INVALID_PARAMETER_VALUE. With `*` or masks containing\nonly mutable fields, supplied values for these immutable fields are ignored.\n`*` by itself selects all supported mutable fields. For this mask,\nall three attributes (`createdb`, `createrole`, and `bypassrls`) must be\nsupplied; omitting any returns an INVALID_PARAMETER_VALUE error.\nThe `*` mask replaces `membership_roles`.\nOmitting it or supplying an empty list clears all memberships, including\n`DATABRICKS_SUPERUSER`.", "required": true, "is_query": true, "entity": { @@ -204687,7 +208160,7 @@ }, { "name": "update_mask", - "description": "The list of fields to update. Supported fields are\n`spec.membership_roles`, `spec.attributes.createdb`,\n`spec.attributes.createrole`, and `spec.attributes.bypassrls`.\n\n`spec.identity_type`, `spec.auth_method`, and `spec.postgres_role`\ncannot be changed. Values supplied for these fields in the request\nbody are ignored. Including one of these fields as an explicit path\nin update_mask returns an INVALID_PARAMETER_VALUE error.\nWhen `spec` is the only path in the mask, only the supplied mutable\nattributes are updated.\n`*` by itself, or `spec` combined with other supported paths, selects all\nsupported mutable fields. For these masks, all three attributes\n(`createdb`, `createrole`, and `bypassrls`) must be supplied; omitting any\nreturns an INVALID_PARAMETER_VALUE error.\nEach of these mask forms replaces `membership_roles`.\nOmitting it or supplying an empty list clears all memberships, including\n`DATABRICKS_SUPERUSER`.", + "description": "The list of fields to update. Supported fields are\n`spec.membership_roles`, `spec.attributes.createdb`,\n`spec.attributes.createrole`, and `spec.attributes.bypassrls`.\n\n`spec.identity_type`, `spec.auth_method`, and `spec.postgres_role`\ncannot be changed. Including an immutable field as an explicit path in\nupdate_mask returns INVALID_PARAMETER_VALUE. With `*` or masks containing\nonly mutable fields, supplied values for these immutable fields are ignored.\n`*` by itself selects all supported mutable fields. For this mask,\nall three attributes (`createdb`, `createrole`, and `bypassrls`) must be\nsupplied; omitting any returns an INVALID_PARAMETER_VALUE error.\nThe `*` mask replaces `membership_roles`.\nOmitting it or supplying an empty list clears all memberships, including\n`DATABRICKS_SUPERUSER`.", "required": true, "is_query": true, "entity": { @@ -219207,7 +222680,7 @@ }, { "name": "UploadFile", - "description": "Uploads an application/octet-stream body to a sandbox. The sandbox starts\nautomatically if it is stopped. Filesystem access uses the sandbox user's\npermissions and follows symbolic links.\n\nCreates the file or replaces its entire contents, creating parent directories if\nmissing. The completed upload becomes visible atomically. A failure before\ncommit leaves an existing destination unchanged; a lost response after commit\ndoes not undo the upload. Completion does not guarantee crash durability.\n\nReturns 201 Created for a new file or 204 No Content for a replacement.\nPartial and conditional uploads are unsupported:\nContent-Range, If-Match, If-None-Match, and If-Unmodified-Since return 400.", + "description": "Uploads an application/octet-stream body to a sandbox. The sandbox starts\nautomatically if it is stopped. Filesystem access uses the sandbox user's\npermissions. Replacements follow symbolic links.\n\nCreates the file or replaces its entire contents, creating parent directories if\nmissing. The completed upload becomes visible atomically. A failure before\ncommit leaves an existing destination unchanged; a lost response after commit\ndoes not undo the upload. Completion does not guarantee crash durability.\n\nReturns 201 Created for a new file or 204 No Content for a replacement.\nSet overwrite=false or supply If-None-Match: * to create a file only if the\ndestination does not exist. An existing entry, including a symbolic link,\nreturns 412 Precondition Failed. Conflicting options or repeated overwrite\nparameters return 400. Other If-None-Match values, Content-Range, If-Match,\nand If-Unmodified-Since are unsupported and return 400.", "summary": "Upload a sandbox file.", "path": "/api/2.0/sandbox-files/{parent=sandboxes/*}/content", "is_hidden_cli": true, @@ -222200,6 +225673,121 @@ } ] }, + { + "id": "compute.ServerlessComputeService", + "name": "ServerlessComputeService", + "description": "ServerlessCompute Service API.", + "package": { + "name": "compute" + }, + "is_hidden_cli": true, + "docs_group": "compute", + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "list": { + "request": { + "pascal_name": "ListServerlessComputesRequest" + } + }, + "methods": [ + { + "name": "List", + "description": "Lists Interactive serverless computes that the caller can use or manage.\nResults are returned in an unspecified order.", + "summary": "List serverless computes.", + "path": "/api/2.0/serverless-compute", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListServerlessComputesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListServerlessComputesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of computes to return per response. Unset or zero defaults\nto 100. The server caps requests above 150 to bound per-request RBAC fan-out.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Token for cursor-based pagination.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Token for cursor-based pagination.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListComputePolicies", + "description": "Lists compute policies in the workspace. Results are returned in an unspecified order; callers\nshould sort client-side if a specific order is needed.", + "summary": "List compute policies.", + "path": "/api/2.0/policies/compute", + "is_hidden_cli": true, + "has_required_positional_arguments": true, + "launch_stage": "PRIVATE_PREVIEW", + "cli_launch_stage_display": "Private Preview", + "request": { + "pascal_name": "ListComputePoliciesRequest", + "is_object": true + }, + "response": { + "pascal_name": "ListComputePoliciesResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of policies to return per response. Unset or zero defaults to 100. The server\ncaps requests above 150.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Token for cursor-based pagination.", + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Token for cursor-based pagination.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + } + ] + }, { "id": "oauth2.ServicePrincipalFederationPolicy", "name": "ServicePrincipalFederationPolicy", @@ -227635,6 +231223,17 @@ "is_object": true } }, + { + "name": "effective_workspace_dashboard_theme", + "description": "Effective setting value for the workspace_dashboard_theme setting. This is the final effective value of the setting. To set a value, use workspace_dashboard_theme.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DashboardTheme", + "is_object": true + } + }, { "name": "effective_workspace_label", "description": "Effective setting value for workspace_label setting. This is the final effective value of setting. To set a value use workspace_label.", @@ -227703,6 +231302,16 @@ "is_object": true } }, + { + "name": "workspace_dashboard_theme", + "description": "Setting value for the workspace_dashboard_theme setting. This is the setting value set by consumers. Check effective_workspace_dashboard_theme for the final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DashboardTheme", + "is_object": true + } + }, { "name": "workspace_label", "description": "Setting value for workspace_label setting. This is the setting value set by consumers, check effective_workspace_label for final setting value.", @@ -228465,6 +232074,638 @@ } ] }, + { + "id": "softwareartifacts.SoftwareArtifacts", + "name": "SoftwareArtifacts", + "description": "Manage software artifacts and their versions in Unity Catalog.", + "package": { + "name": "softwareartifacts" + }, + "docs_group": "catalog", + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "list": { + "request": { + "pascal_name": "ListSoftwareArtifactVersionsRequest" + } + }, + "methods": [ + { + "name": "GetSoftwareArtifact", + "description": "Gets a software artifact.", + "summary": ".", + "path": "/api/2.1/unity-catalog/{name=software-artifacts/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetSoftwareArtifactRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SoftwareArtifact", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "GetSoftwareArtifactVersion", + "description": "Gets a software artifact version.", + "summary": ".", + "path": "/api/2.1/unity-catalog/{name=software-artifacts/*/versions/*}", + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "GetSoftwareArtifactVersionRequest", + "is_object": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "SoftwareArtifactVersion", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the version, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "ListSoftwareArtifactVersions", + "description": "Lists the versions of a software artifact.", + "summary": ".", + "path": "/api/2.1/unity-catalog/{parent=software-artifacts/*}/versions", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListSoftwareArtifactVersionsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "Resource name of the parent artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Resource name of the parent artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListSoftwareArtifactVersionsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of versions to return. If omitted or set to 0, the page size defaults to 50.\nThe maximum value is 50; values above 50 or below 0 are rejected.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque continuation token from a previous response's next_page_token. Omit for the first page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Resource name of the parent artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Resource name of the parent artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque continuation token from a previous response's next_page_token. Omit for the first page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ListSoftwareArtifacts", + "description": "Lists software artifacts in a schema.", + "summary": ".", + "path": "/api/2.1/unity-catalog/software-artifacts", + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ListSoftwareArtifactsRequest", + "is_object": true, + "required_fields": [ + { + "name": "parent", + "description": "Resource name of the parent schema, of the form `schemas/{catalog}.{schema}`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Resource name of the parent schema, of the form `schemas/{catalog}.{schema}`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ListSoftwareArtifactsResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "page_size", + "description": "Maximum number of software artifacts to return. If omitted or set to 0, the page size defaults\nto 50. The maximum value is 50; values above 50 or below 0 are rejected.", + "is_query": true, + "entity": { + "is_int": true + } + }, + { + "name": "page_token", + "description": "Opaque continuation token from a previous response's next_page_token. Omit for the first page.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Resource name of the parent schema, of the form `schemas/{catalog}.{schema}`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Resource name of the parent schema, of the form `schemas/{catalog}.{schema}`.", + "required": true, + "is_query": true, + "entity": { + "is_string": true + } + } + ], + "pagination": { + "token": { + "poll_field": { + "name": "page_token", + "description": "Opaque continuation token from a previous response's next_page_token. Omit for the first page.", + "is_query": true, + "entity": { + "is_string": true + } + } + } + } + }, + { + "name": "ResolveSoftwareArtifactVersion", + "description": "Resolves a software artifact version from its tag alias.", + "summary": ".", + "path": "/api/2.1/unity-catalog/{parent=software-artifacts/*}/versions:resolve", + "can_use_json": true, + "is_crud_read": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "ResolveSoftwareArtifactVersionRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "parent", + "description": "Resource name of the software artifact containing the alias.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "Image tag alias selecting the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_in_url_fields": [ + { + "name": "parent", + "description": "Resource name of the software artifact containing the alias.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_request_body_fields": [ + { + "name": "alias", + "description": "Image tag alias selecting the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + "response": { + "pascal_name": "ResolveSoftwareArtifactVersionResponse", + "is_object": true + }, + "all_fields": [ + { + "name": "alias", + "description": "Image tag alias selecting the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "parent", + "description": "Resource name of the software artifact containing the alias.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "parent", + "description": "Resource name of the software artifact containing the alias.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "alias", + "description": "Image tag alias selecting the version.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ] + }, + { + "name": "UpdateSoftwareArtifact", + "description": "Updates a software artifact. The name is immutable; only the owner may be changed.\nThe destination owner must exist in the account. The caller needs MANAGE_ACCESS_CONTROL\non the artifact. The response contains its name and the requested owner; audit fields are omitted.", + "summary": ".", + "path": "/api/2.1/unity-catalog/{name=software-artifacts/*}", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "PUBLIC_BETA", + "cli_launch_stage_label": "*Beta*", + "cli_launch_stage_banner": "This command is in Beta and may change without notice.", + "cli_launch_stage_display": "Beta", + "request": { + "pascal_name": "UpdateSoftwareArtifactRequest", + "is_object": true, + "has_field_mask": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "name", + "description": "Resource name of the artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "software_artifact", + "description": "The software artifact to update. Its name identifies the existing artifact; only owner may be\nchanged.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SoftwareArtifact", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Fields to update, relative to `software_artifact`. Accepts `owner` or `*`; owner is the only\nmutable field, so both select the same update. Output-only values in the resource are ignored.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_in_url_fields": [ + { + "name": "name", + "description": "Resource name of the artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Fields to update, relative to `software_artifact`. Accepts `owner` or `*`; owner is the only\nmutable field, so both select the same update. Output-only values in the resource are ignored.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ], + "required_request_body_fields": [ + { + "name": "software_artifact", + "description": "The software artifact to update. Its name identifies the existing artifact; only owner may be\nchanged.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SoftwareArtifact", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "software_artifact", + "description": "The software artifact to update. Its name identifies the existing artifact; only owner may be\nchanged.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SoftwareArtifact", + "is_object": true + } + }, + "response": { + "pascal_name": "SoftwareArtifact", + "is_object": true + }, + "all_fields": [ + { + "name": "name", + "description": "Resource name of the artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "software_artifact", + "description": "The software artifact to update. Its name identifies the existing artifact; only owner may be\nchanged.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "SoftwareArtifact", + "is_object": true + } + }, + { + "name": "update_mask", + "description": "Fields to update, relative to `software_artifact`. Accepts `owner` or `*`; owner is the only\nmutable field, so both select the same update. Output-only values in the resource are ignored.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + }, + { + "name": "create_time", + "description": "Time at which this software artifact was created.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "created_by", + "description": "Principal name of the software artifact creator.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "name", + "description": "Resource name of the artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "owner", + "description": "Principal name (a user, service principal, or group) that owns this artifact.", + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_time", + "description": "Time at which this software artifact was last updated.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "is_timestamp": true + } + }, + { + "name": "updated_by", + "description": "Principal name that last updated this software artifact.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + } + ], + "required_positional_arguments": [ + { + "name": "name", + "description": "Resource name of the artifact, of the form\n`software-artifacts/{catalog}.{schema}.{artifact}`.", + "required": true, + "is_path": true, + "entity": { + "is_string": true + } + }, + { + "name": "update_mask", + "description": "Fields to update, relative to `software_artifact`. Accepts `owner` or `*`; owner is the only\nmutable field, so both select the same update. Output-only values in the resource are ignored.", + "required": true, + "is_query": true, + "entity": { + "is_field_mask": true + } + } + ] + } + ] + }, { "id": "settings.SqlResultsDownload", "name": "SqlResultsDownload", @@ -246600,7 +250841,7 @@ "methods": [ { "name": "CreateDirectGroupMemberProxy", - "description": "Creates a group membership (assigns a principal to a group).", + "description": "Adds a user, service principal, or group as a direct member of a group in the account that\ncontains this workspace.\n\nIf automatic identity management is on and the group has an `external_id`, its members come\nfrom your identity provider and can't be changed in Databricks.", "summary": "Create a direct group membership.", "path": "/api/2.0/identity/{parent=groups/*}/direct-members", "can_use_json": true, @@ -246614,7 +250855,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the group to add the member to.\nFormat: groups/{group_id}", + "description": "The resource name of the group to add the member to, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -246623,7 +250864,7 @@ }, { "name": "direct_group_member", - "description": "Required. The group membership to create.", + "description": "The member to add. Set its `principal_id`.", "required": true, "is_request_body_field": true, "entity": { @@ -246635,7 +250876,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the group to add the member to.\nFormat: groups/{group_id}", + "description": "The resource name of the group to add the member to, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -246646,7 +250887,7 @@ "required_request_body_fields": [ { "name": "direct_group_member", - "description": "Required. The group membership to create.", + "description": "The member to add. Set its `principal_id`.", "required": true, "is_request_body_field": true, "entity": { @@ -246658,7 +250899,7 @@ }, "request_body_field": { "name": "direct_group_member", - "description": "Required. The group membership to create.", + "description": "The member to add. Set its `principal_id`.", "required": true, "is_request_body_field": true, "entity": { @@ -246668,7 +250909,7 @@ "required_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -246679,7 +250920,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -246696,7 +250937,7 @@ "required_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -246707,7 +250948,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -246719,7 +250960,7 @@ "all_fields": [ { "name": "direct_group_member", - "description": "Required. The group membership to create.", + "description": "The member to add. Set its `principal_id`.", "required": true, "is_request_body_field": true, "entity": { @@ -246729,7 +250970,7 @@ "required_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -246740,7 +250981,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -246752,7 +250993,7 @@ }, { "name": "parent", - "description": "The parent resource name of the group to add the member to.\nFormat: groups/{group_id}", + "description": "The resource name of the group to add the member to, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -246761,7 +251002,7 @@ }, { "name": "display_name", - "description": "Display name of the principal.", + "description": "The member's display name.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -246770,7 +251011,7 @@ }, { "name": "external_id", - "description": "The external ID of the principal in the customer's IdP.", + "description": "The ID of the member in your identity provider (IdP).", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -246779,7 +251020,7 @@ }, { "name": "group_id", - "description": "The internal ID of the group this member belongs to.", + "description": "The Databricks ID of the group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -246788,7 +251029,7 @@ }, { "name": "membership_source", - "description": "The source of group membership (internal or from identity provider).", + "description": "Where the membership comes from.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -246805,7 +251046,7 @@ }, { "name": "name", - "description": "The resource name of the group membership. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}\n- Workspace-scoped: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}`\n- Workspace APIs: `groups/{group_id}/direct-members/{principal_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -246813,7 +251054,7 @@ }, { "name": "parent", - "description": "The resource name of the group that contains the membership. The format depends on the API\nthat returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -246822,7 +251063,7 @@ }, { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -246831,7 +251072,7 @@ }, { "name": "principal_type", - "description": "The type of the principal (user/service principal/group).", + "description": "Whether the member is a user, service principal, or group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -246853,7 +251094,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the group to add the member to.\nFormat: groups/{group_id}", + "description": "The resource name of the group to add the member to, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -246862,7 +251103,7 @@ }, { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -246873,7 +251114,7 @@ }, { "name": "CreateGroupProxy", - "description": "Creates a local group in the Databricks account that parents the calling workspace and returns\nthe created group. A local group is one that is not synced from the customer's identity\nprovider, and can be created whether or not Account Identity Management (AIM) is enabled.\n\nWhen AIM is enabled, supplying an external ID returns an error. To provision the identity from\nyour identity provider, resolve it by its external ID with ResolveGroup; to read an existing\nexternal identity, use the ExternalGroup resource.", + "description": "Creates a local group in the account that contains this workspace. A local group is a group\nthat isn't synced from your identity provider (IdP). You become a manager of the new group.\n\nIf automatic identity management is on, you can't set `external_id`. To add a group from your\nIdP, get it as an external group instead.", "summary": "Create a group in the account.", "path": "/api/2.0/identity/groups", "can_use_json": true, @@ -246887,7 +251128,7 @@ "required_fields": [ { "name": "group", - "description": "Required. Group to be created in Databricks", + "description": "The group to create.", "required": true, "is_request_body_field": true, "entity": { @@ -246899,7 +251140,7 @@ "required_request_body_fields": [ { "name": "group", - "description": "Required. Group to be created in Databricks", + "description": "The group to create.", "required": true, "is_request_body_field": true, "entity": { @@ -246911,7 +251152,7 @@ }, "request_body_field": { "name": "group", - "description": "Required. Group to be created in Databricks", + "description": "The group to create.", "required": true, "is_request_body_field": true, "entity": { @@ -246926,7 +251167,7 @@ "all_fields": [ { "name": "group", - "description": "Required. Group to be created in Databricks", + "description": "The group to create.", "required": true, "is_request_body_field": true, "entity": { @@ -246936,7 +251177,7 @@ }, { "name": "parent", - "description": "The resource name of the account to create the group in, `accounts/{account_id}`.\nOptional: defaults to the account of the calling workspace, and any other account is\nrejected.", + "description": "The resource name of the account to create the group in, in the format `accounts/{account_id}`.\nDefaults to the account that contains this workspace. Any other account is rejected.", "is_query": true, "entity": { "is_string": true @@ -246944,7 +251185,7 @@ }, { "name": "account_id", - "description": "The parent account ID for group in Databricks.", + "description": "The ID of the account that contains the group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -246953,7 +251194,7 @@ }, { "name": "external_id", - "description": "ExternalId of the group in the customer's IdP.", + "description": "The ID of the group in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -246961,7 +251202,7 @@ }, { "name": "group_id", - "description": "Internal group ID of the group in Databricks.", + "description": "The Databricks ID of the group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -246970,7 +251211,7 @@ }, { "name": "group_name", - "description": "Display name of the group.", + "description": "The name of the group.", "is_request_body_field": true, "entity": { "is_string": true @@ -246978,7 +251219,7 @@ }, { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -246986,7 +251227,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the group, `accounts/{account_id}`. Both the\naccount-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the group, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -246997,7 +251238,7 @@ }, { "name": "CreateServicePrincipalProxy", - "description": "Creates a local service principal in the Databricks account that parents the calling workspace\nand returns the created service principal. A local service principal is one that is not synced\nfrom the customer's identity provider, and can be created whether or not Account Identity\nManagement (AIM) is enabled.\n\nWhen AIM is enabled, supplying an external ID returns an error. To provision the identity from\nyour identity provider, resolve it by its external ID with ResolveServicePrincipal; to read an\nexisting external identity, use the ExternalServicePrincipal resource.", + "description": "Creates a local service principal in the account that contains this workspace. A local service\nprincipal is one that isn't synced from your identity provider (IdP).\n\nIf automatic identity management is on, you can't set `external_id`. To add a service\nprincipal from your IdP, get it as an external service principal instead.", "summary": "Create a service principal in the account.", "path": "/api/2.0/identity/service-principals", "can_use_json": true, @@ -247011,7 +251252,7 @@ "required_fields": [ { "name": "service_principal", - "description": "Required. Service principal to be created in Databricks", + "description": "The service principal to create.", "required": true, "is_request_body_field": true, "entity": { @@ -247023,7 +251264,7 @@ "required_request_body_fields": [ { "name": "service_principal", - "description": "Required. Service principal to be created in Databricks", + "description": "The service principal to create.", "required": true, "is_request_body_field": true, "entity": { @@ -247035,7 +251276,7 @@ }, "request_body_field": { "name": "service_principal", - "description": "Required. Service principal to be created in Databricks", + "description": "The service principal to create.", "required": true, "is_request_body_field": true, "entity": { @@ -247045,7 +251286,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -247054,7 +251295,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -247073,7 +251314,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -247082,7 +251323,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -247107,7 +251348,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -247116,7 +251357,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -247135,7 +251376,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -247144,7 +251385,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -247164,7 +251405,7 @@ "all_fields": [ { "name": "parent", - "description": "The resource name of the account to create the service principal in, `accounts/{account_id}`.\nOptional: defaults to the account of the calling workspace, and any other account is\nrejected.", + "description": "The resource name of the account to create the service principal in, in the format\n`accounts/{account_id}`. Defaults to the account that contains this workspace. Any other\naccount is rejected.", "is_query": true, "entity": { "is_string": true @@ -247172,7 +251413,7 @@ }, { "name": "service_principal", - "description": "Required. Service principal to be created in Databricks", + "description": "The service principal to create.", "required": true, "is_request_body_field": true, "entity": { @@ -247182,7 +251423,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -247191,7 +251432,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -247210,7 +251451,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -247219,7 +251460,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -247239,7 +251480,7 @@ }, { "name": "account_id", - "description": "The parent account ID for the service principal in Databricks.", + "description": "The ID of the account that contains the service principal.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -247248,7 +251489,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -247265,7 +251506,7 @@ }, { "name": "application_id", - "description": "Application ID of the service principal. Set at creation time and cannot be changed\nafterwards; when omitted, the server generates one.", + "description": "The service principal's application ID, a UUID. If you don't set it when you create the\nservice principal, Databricks generates one. It must be unique in the account and can't be\nchanged.", "is_computed": true, "is_request_body_field": true, "entity": { @@ -247274,7 +251515,7 @@ }, { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -247283,7 +251524,7 @@ }, { "name": "external_id", - "description": "ExternalId of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -247291,7 +251532,7 @@ }, { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -247299,7 +251540,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the service principal,\n`accounts/{account_id}`. Both the account-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the service principal, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -247308,7 +251549,7 @@ }, { "name": "service_principal_id", - "description": "Internal service principal ID of the service principal in Databricks.", + "description": "The Databricks ID of the service principal.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -247319,7 +251560,7 @@ "required_positional_arguments": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -247328,7 +251569,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -247347,7 +251588,7 @@ }, { "name": "CreateUserProxy", - "description": "Creates a local user in the Databricks account that parents the calling workspace and returns\nthe created user. A local user is one that is not synced from the customer's identity provider,\nand can be created whether or not Account Identity Management (AIM) is enabled.\n\nWhen AIM is enabled, supplying an external ID returns an error. To provision the identity from\nyour identity provider, resolve it by its external ID with ResolveUser; to read an existing\nexternal identity, use the ExternalUser resource.", + "description": "Creates a local user in the account that contains this workspace. A local user is a user that\nisn't synced from your identity provider (IdP).\n\nIf automatic identity management is on, you can't set `external_id`. To add a user from your\nIdP, get them as an external user instead.", "summary": "Create a user in the account.", "path": "/api/2.0/identity/users", "can_use_json": true, @@ -247361,7 +251602,7 @@ "required_fields": [ { "name": "user", - "description": "Required. User to be created in Databricks", + "description": "The user to create.", "required": true, "is_request_body_field": true, "entity": { @@ -247373,7 +251614,7 @@ "required_request_body_fields": [ { "name": "user", - "description": "Required. User to be created in Databricks", + "description": "The user to create.", "required": true, "is_request_body_field": true, "entity": { @@ -247385,7 +251626,7 @@ }, "request_body_field": { "name": "user", - "description": "Required. User to be created in Databricks", + "description": "The user to create.", "required": true, "is_request_body_field": true, "entity": { @@ -247395,7 +251636,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -247404,6 +251645,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -247413,7 +251655,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -247432,7 +251674,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -247441,6 +251683,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -247450,7 +251693,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -247475,7 +251718,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -247484,6 +251727,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -247493,7 +251737,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -247512,7 +251756,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -247521,6 +251765,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -247530,7 +251775,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -247550,7 +251795,7 @@ "all_fields": [ { "name": "parent", - "description": "The resource name of the account to create the user in, `accounts/{account_id}`.\nOptional: defaults to the account of the calling workspace, and any other account is\nrejected.", + "description": "The resource name of the account to create the user in, in the format\n`accounts/{account_id}`. Defaults to the account that contains this workspace. Any other\naccount is rejected.", "is_query": true, "entity": { "is_string": true @@ -247558,7 +251803,7 @@ }, { "name": "user", - "description": "Required. User to be created in Databricks", + "description": "The user to create.", "required": true, "is_request_body_field": true, "entity": { @@ -247568,7 +251813,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -247577,6 +251822,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -247586,7 +251832,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -247605,7 +251851,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -247614,6 +251860,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -247623,7 +251870,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -247643,7 +251890,7 @@ }, { "name": "account_id", - "description": "The accountId parent of the user in Databricks.", + "description": "The ID of the account that contains the user.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -247652,7 +251899,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -247669,7 +251916,7 @@ }, { "name": "external_id", - "description": "ExternalId of the user in the customer's IdP.", + "description": "The ID of the user in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -247677,6 +251924,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -247686,7 +251934,7 @@ }, { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -247694,7 +251942,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the user, `accounts/{account_id}`. Both the\naccount-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the user, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -247703,7 +251951,7 @@ }, { "name": "user_id", - "description": "Internal userId of the user in Databricks.", + "description": "The Databricks ID of the user.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -247712,7 +251960,7 @@ }, { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -247723,7 +251971,7 @@ "required_positional_arguments": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -247732,6 +251980,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -247741,7 +251990,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -247964,270 +252213,270 @@ } }, { - "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_int64": true - } - }, - { - "name": "principal_type", - "is_output_only": true, - "is_request_body_field": true, - "entity": { - "pascal_name": "PrincipalType", - "enum": [ - { - "content": "GROUP" - }, - { - "content": "SERVICE_PRINCIPAL" - }, - { - "content": "USER" - } - ] - } - }, - { - "name": "workspace_id", - "description": "The workspace ID where the principal is assigned.", - "is_output_only": true, - "is_request_body_field": true, - "entity": { - "is_int64": true - } - } - ], - "required_positional_arguments": [ - { - "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_int64": true - } - } - ] - }, - { - "name": "CreateWorkspaceAssignmentProxy", - "description": "Creates a workspace assignment for a principal in the calling workspace. Entitlements\nare granted one at a time rather than atomically. If the request fails partway through, the\nprincipal stays assigned to the workspace with only some of the requested entitlements. Get the\nassignment afterwards to confirm which entitlements were granted.", - "summary": "Create a workspace assignment for a workspace.", - "path": "/api/2.0/identity/workspace-assignments", - "can_use_json": true, - "has_required_positional_arguments": true, - "launch_stage": "GA", - "cli_launch_stage_display": "GA", - "request": { - "pascal_name": "CreateWorkspaceAssignmentProxyRequest", - "is_object": true, - "has_required_request_body_fields": true, - "required_fields": [ - { - "name": "workspace_assignment", - "description": "Required. Workspace assignment to be created in Databricks.", - "required": true, - "is_request_body_field": true, - "entity": { - "pascal_name": "WorkspaceAssignment", - "is_object": true - } - } - ], - "required_request_body_fields": [ - { - "name": "workspace_assignment", - "description": "Required. Workspace assignment to be created in Databricks.", - "required": true, - "is_request_body_field": true, - "entity": { - "pascal_name": "WorkspaceAssignment", - "is_object": true - } - } - ] - }, - "request_body_field": { - "name": "workspace_assignment", - "description": "Required. Workspace assignment to be created in Databricks.", - "required": true, - "is_request_body_field": true, - "entity": { - "pascal_name": "WorkspaceAssignment", - "is_object": true, - "has_required_request_body_fields": true, - "required_fields": [ - { - "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_int64": true - } - } - ], - "required_request_body_fields": [ - { - "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_int64": true - } - } - ] - } - }, - "response": { - "pascal_name": "WorkspaceAssignment", - "is_object": true, - "has_required_request_body_fields": true, - "required_fields": [ - { - "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_int64": true - } - } - ], - "required_request_body_fields": [ - { - "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_int64": true - } - } - ] - }, - "all_fields": [ - { - "name": "parent", - "description": "The resource name of the workspace to assign the principal to,\n`accounts/{account_id}/workspaces/{workspace_id}`. Optional: defaults to the calling workspace,\nand any other workspace is rejected.", - "is_query": true, - "entity": { - "is_string": true - } - }, - { - "name": "workspace_assignment", - "description": "Required. Workspace assignment to be created in Databricks.", - "required": true, - "is_request_body_field": true, - "entity": { - "pascal_name": "WorkspaceAssignment", - "is_object": true, - "has_required_request_body_fields": true, - "required_fields": [ - { - "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_int64": true - } - } - ], - "required_request_body_fields": [ - { - "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", - "required": true, - "is_request_body_field": true, - "entity": { - "is_int64": true - } - } - ] - } - }, - { - "name": "account_id", - "description": "The account ID parent of the workspace where the principal is assigned", - "is_output_only": true, - "is_request_body_field": true, - "entity": { - "is_string": true - } - }, - { - "name": "effective_entitlements", - "description": "Every entitlement the principal holds in this workspace, whether granted directly or through\ngroup membership. Get responses populate this field. List responses leave it empty.", - "is_output_only": true, - "is_request_body_field": true, - "entity": { - "pascal_name": "EntitlementList", - "array_value": { - "pascal_name": "Entitlement", - "enum": [ - { - "content": "ALLOW_CLUSTER_CREATE" - }, - { - "content": "ALLOW_INSTANCE_POOL_CREATE" - }, - { - "content": "DATABRICKS_SQL_ACCESS" - }, - { - "content": "WORKSPACE_ACCESS" - }, - { - "content": "WORKSPACE_ADMIN" - }, - { - "content": "WORKSPACE_CONSUME" - } - ] - } - } - }, - { - "name": "entitlements", - "description": "Entitlements granted directly to the principal on this workspace. This is the only\nclient-settable field. Create and update manage exactly this set, including entitlements the\nprincipal also holds through a group.\nList responses leave this field empty. Get a single principal to read its entitlements.", - "is_request_body_field": true, - "entity": { - "pascal_name": "EntitlementList", - "array_value": { - "pascal_name": "Entitlement", - "enum": [ - { - "content": "ALLOW_CLUSTER_CREATE" - }, - { - "content": "ALLOW_INSTANCE_POOL_CREATE" - }, - { - "content": "DATABRICKS_SQL_ACCESS" - }, - { - "content": "WORKSPACE_ACCESS" - }, - { - "content": "WORKSPACE_ADMIN" - }, - { - "content": "WORKSPACE_CONSUME" - } - ] - } - } - }, - { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + }, + { + "name": "principal_type", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "PrincipalType", + "enum": [ + { + "content": "GROUP" + }, + { + "content": "SERVICE_PRINCIPAL" + }, + { + "content": "USER" + } + ] + } + }, + { + "name": "workspace_id", + "description": "The workspace ID where the principal is assigned.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_positional_arguments": [ + { + "name": "principal_id", + "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + { + "name": "CreateWorkspaceAssignmentProxy", + "description": "Assigns a user, service principal, or group directly to this workspace with the given\nentitlements. Returns an error if the principal is already assigned directly.\n\nEntitlements are granted one at a time. If the request fails partway through, the principal\nstays assigned with only some of the entitlements. Get the assignment afterwards to check which\nwere granted.", + "summary": "Create a workspace assignment for a workspace.", + "path": "/api/2.0/identity/workspace-assignments", + "can_use_json": true, + "has_required_positional_arguments": true, + "launch_stage": "GA", + "cli_launch_stage_display": "GA", + "request": { + "pascal_name": "CreateWorkspaceAssignmentProxyRequest", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "workspace_assignment", + "description": "The assignment to create. Set its `principal_id` and `entitlements`.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignment", + "is_object": true + } + } + ], + "required_request_body_fields": [ + { + "name": "workspace_assignment", + "description": "The assignment to create. Set its `principal_id` and `entitlements`.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignment", + "is_object": true + } + } + ] + }, + "request_body_field": { + "name": "workspace_assignment", + "description": "The assignment to create. Set its `principal_id` and `entitlements`.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + }, + "response": { + "pascal_name": "WorkspaceAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + }, + "all_fields": [ + { + "name": "parent", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`. Defaults to this workspace. Any other\nworkspace is rejected.", + "is_query": true, + "entity": { + "is_string": true + } + }, + { + "name": "workspace_assignment", + "description": "The assignment to create. Set its `principal_id` and `entitlements`.", + "required": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "WorkspaceAssignment", + "is_object": true, + "has_required_request_body_fields": true, + "required_fields": [ + { + "name": "principal_id", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ], + "required_request_body_fields": [ + { + "name": "principal_id", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", + "required": true, + "is_request_body_field": true, + "entity": { + "is_int64": true + } + } + ] + } + }, + { + "name": "account_id", + "description": "The ID of the account that contains the workspace.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "is_string": true + } + }, + { + "name": "effective_entitlements", + "description": "Every entitlement the principal has in the workspace, granted directly or through a group. List\nresponses leave it empty.", + "is_output_only": true, + "is_request_body_field": true, + "entity": { + "pascal_name": "EntitlementList", + "array_value": { + "pascal_name": "Entitlement", + "enum": [ + { + "content": "ALLOW_CLUSTER_CREATE" + }, + { + "content": "ALLOW_INSTANCE_POOL_CREATE" + }, + { + "content": "DATABRICKS_SQL_ACCESS" + }, + { + "content": "WORKSPACE_ACCESS" + }, + { + "content": "WORKSPACE_ADMIN" + }, + { + "content": "WORKSPACE_CONSUME" + } + ] + } + } + }, + { + "name": "entitlements", + "description": "The entitlements granted directly by this assignment. Create and update set exactly this list,\neven if the principal also gets some of these entitlements through a group. List responses\nleave it empty.", + "is_request_body_field": true, + "entity": { + "pascal_name": "EntitlementList", + "array_value": { + "pascal_name": "Entitlement", + "enum": [ + { + "content": "ALLOW_CLUSTER_CREATE" + }, + { + "content": "ALLOW_INSTANCE_POOL_CREATE" + }, + { + "content": "DATABRICKS_SQL_ACCESS" + }, + { + "content": "WORKSPACE_ACCESS" + }, + { + "content": "WORKSPACE_ADMIN" + }, + { + "content": "WORKSPACE_CONSUME" + } + ] + } + } + }, + { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -248235,7 +252484,7 @@ }, { "name": "parent", - "description": "The resource name of the workspace that contains the assignment,\n`accounts/{account_id}/workspaces/{workspace_id}`. Both the account-scoped and workspace-scoped\nAPIs return it.", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -248244,7 +252493,7 @@ }, { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -248253,7 +252502,7 @@ }, { "name": "principal_type", - "description": "The type of the principal (user/service principal/group) that is assigned.", + "description": "Whether the assigned principal is a user, service principal, or group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -248273,7 +252522,7 @@ }, { "name": "workspace_id", - "description": "The workspace ID where the principal is assigned.", + "description": "The ID of the workspace.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -248284,7 +252533,7 @@ "required_positional_arguments": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -248295,7 +252544,7 @@ }, { "name": "DeleteDirectGroupMemberProxy", - "description": "Deletes a group membership (unassigns a principal from a group).", + "description": "Removes a direct member from a group in the account that contains this workspace.\n\nIf automatic identity management is on and the group has an `external_id`, its members come\nfrom your identity provider and can't be changed in Databricks.", "summary": "Delete a direct group membership.", "path": "/api/2.0/identity/{name=groups/*/direct-members/*}", "has_required_positional_arguments": true, @@ -248307,7 +252556,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248318,7 +252567,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248333,7 +252582,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248344,7 +252593,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248355,7 +252604,7 @@ }, { "name": "DeleteGroupProxy", - "description": "Deletes a group by its internal ID from the Databricks\naccount that parents the calling workspace.", + "description": "Deletes a group from the account that contains this workspace and removes it from the\nworkspaces it's assigned to.", "summary": "Delete a group in the account.", "path": "/api/2.0/identity/{name=groups/*}", "has_required_positional_arguments": true, @@ -248367,7 +252616,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -248378,7 +252627,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -248393,7 +252642,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -248404,7 +252653,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the group.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -248415,7 +252664,7 @@ }, { "name": "DeleteServicePrincipalProxy", - "description": "Deletes a service principal by its internal ID\nfrom the Databricks account that parents the calling workspace.", + "description": "Deletes a service principal from the account that contains this workspace and removes it from\nthe workspaces it's assigned to. You can't delete service principals that Databricks manages.", "summary": "Delete a service principal in the account.", "path": "/api/2.0/identity/{name=service-principals/*}", "has_required_positional_arguments": true, @@ -248427,7 +252676,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248438,7 +252687,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248453,7 +252702,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248464,7 +252713,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248475,7 +252724,7 @@ }, { "name": "DeleteUserProxy", - "description": "Deletes a user by its internal ID from the Databricks\naccount that parents the calling workspace.", + "description": "Deletes a user from the account that contains this workspace and removes them from the\nworkspaces they're assigned to.", "summary": "Delete a user in the account.", "path": "/api/2.0/identity/{name=users/*}", "has_required_positional_arguments": true, @@ -248487,7 +252736,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: users/{user_id}", + "description": "The resource name of the user, in the format `users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -248498,7 +252747,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: users/{user_id}", + "description": "The resource name of the user, in the format `users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -248513,7 +252762,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: users/{user_id}", + "description": "The resource name of the user, in the format `users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -248524,7 +252773,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the user.\nFormat: users/{user_id}", + "description": "The resource name of the user, in the format `users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -248596,7 +252845,7 @@ }, { "name": "DeleteWorkspaceAssignmentProxy", - "description": "Deletes a workspace assignment for a principal in the calling workspace, revoking all of\nits entitlements. Entitlements are revoked one at a time rather than atomically. If the request\nfails partway through, the principal stays assigned with some of its original entitlements.\nRetrying is safe.", + "description": "Removes a principal's direct assignment to this workspace and revokes the entitlements it\ngranted. The principal keeps any access it gets through groups.\n\nEntitlements are revoked one at a time. If the request fails partway through, the principal\nstays assigned with some of its entitlements. You can retry the request.", "summary": "Delete a workspace assignment for a workspace.", "path": "/api/2.0/identity/{name=workspace-assignments/*}", "has_required_positional_arguments": true, @@ -248608,7 +252857,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format `workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248619,7 +252868,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format `workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248634,7 +252883,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format `workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248645,7 +252894,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format `workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248656,7 +252905,7 @@ }, { "name": "GetDirectGroupMemberProxy", - "description": "Gets a provisioned direct member of a group.", + "description": "Gets a direct member of a group in the account that contains this workspace, including where\nthe membership comes from. Returns an error if the principal isn't a direct member.", "summary": "Get a direct group member.", "path": "/api/2.0/identity/{name=groups/*/direct-members/*}", "has_required_positional_arguments": true, @@ -248668,7 +252917,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248679,7 +252928,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248695,7 +252944,7 @@ "required_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -248706,7 +252955,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "Internal ID of the principal in Databricks.", + "description": "The Databricks ID of the member.", "required": true, "is_request_body_field": true, "entity": { @@ -248718,7 +252967,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248729,7 +252978,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the group membership.\nFormat: groups/{group_id}/direct-members/{principal_id}", + "description": "The resource name of the membership, in the format\n`groups/{group_id}/direct-members/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248740,7 +252989,7 @@ }, { "name": "GetExternalGroupProxy", - "description": "Retrieves an external group with the given external ID from the customer's\nIdP. If the group does not exist, it will be created in the account. If the\ncustomer is not onboarded onto Automatic Identity Management (AIM), this will\nreturn an error. Workspace-scoped variant for workspace-authenticated callers.", + "description": "Gets a group by its ID in your identity provider (IdP) and syncs its name and parent groups\nfrom your IdP. If the group isn't in the account that contains this workspace yet, it's added.\nRequires automatic identity management. If your account has group visibility filters, the\ngroup must match them.", "summary": "Get an external group in the account.", "path": "/api/2.0/identity/{name=external-groups/*}", "has_required_positional_arguments": true, @@ -248752,7 +253001,7 @@ "required_fields": [ { "name": "name", - "description": "Required. The resource name of the external group.\nFormat: external-groups/{external_group_id}", + "description": "The resource name of the external group, in the format `external-groups/{external_group_id}`.", "required": true, "is_path": true, "entity": { @@ -248763,7 +253012,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Required. The resource name of the external group.\nFormat: external-groups/{external_group_id}", + "description": "The resource name of the external group, in the format `external-groups/{external_group_id}`.", "required": true, "is_path": true, "entity": { @@ -248779,7 +253028,7 @@ "all_fields": [ { "name": "name", - "description": "Required. The resource name of the external group.\nFormat: external-groups/{external_group_id}", + "description": "The resource name of the external group, in the format `external-groups/{external_group_id}`.", "required": true, "is_path": true, "entity": { @@ -248790,7 +253039,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Required. The resource name of the external group.\nFormat: external-groups/{external_group_id}", + "description": "The resource name of the external group, in the format `external-groups/{external_group_id}`.", "required": true, "is_path": true, "entity": { @@ -248801,7 +253050,7 @@ }, { "name": "GetExternalServicePrincipalProxy", - "description": "Retrieves an external service principal with the given external ID from the\ncustomer's IdP. If the service principal does not exist, it will be created.\nIf the customer is not onboarded onto Automatic Identity Management (AIM),\nthis will return an error. Workspace-scoped variant for workspace-authenticated\ncallers.", + "description": "Gets a service principal by its ID in your identity provider (IdP) and syncs its details and\ngroup memberships from your IdP. If the service principal isn't in the account that contains\nthis workspace yet, it's added. Requires automatic identity management with Microsoft Entra ID\nas your IdP.", "summary": "Get an external service principal in the account.", "path": "/api/2.0/identity/{name=external-service-principals/*}", "has_required_positional_arguments": true, @@ -248813,7 +253062,7 @@ "required_fields": [ { "name": "name", - "description": "Required. The resource name of the external service principal.\nFormat: external-service-principals/{external_service_principal_id}", + "description": "The resource name of the external service principal, in the format\n`external-service-principals/{external_service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248824,7 +253073,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Required. The resource name of the external service principal.\nFormat: external-service-principals/{external_service_principal_id}", + "description": "The resource name of the external service principal, in the format\n`external-service-principals/{external_service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248840,7 +253089,7 @@ "all_fields": [ { "name": "name", - "description": "Required. The resource name of the external service principal.\nFormat: external-service-principals/{external_service_principal_id}", + "description": "The resource name of the external service principal, in the format\n`external-service-principals/{external_service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248851,7 +253100,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Required. The resource name of the external service principal.\nFormat: external-service-principals/{external_service_principal_id}", + "description": "The resource name of the external service principal, in the format\n`external-service-principals/{external_service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -248862,7 +253111,7 @@ }, { "name": "GetExternalUserProxy", - "description": "Retrieves an external user with the given external ID from the customer's\nIdP. If the user does not exist, it will be created. If the customer is not\nonboarded onto Automatic Identity Management (AIM), this will return an error.\nWorkspace-scoped variant for workspace-authenticated callers.", + "description": "Gets a user by their ID in your identity provider (IdP) and syncs their details and group\nmemberships from your IdP. If the user isn't in the account that contains this workspace yet,\nthey're added. Requires automatic identity management.", "summary": "Get an external user in the account.", "path": "/api/2.0/identity/{name=external-users/*}", "has_required_positional_arguments": true, @@ -248874,7 +253123,7 @@ "required_fields": [ { "name": "name", - "description": "Required. The resource name of the external user.\nFormat: external-users/{external_user_id}", + "description": "The resource name of the external user, in the format `external-users/{external_user_id}`.", "required": true, "is_path": true, "entity": { @@ -248885,7 +253134,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "Required. The resource name of the external user.\nFormat: external-users/{external_user_id}", + "description": "The resource name of the external user, in the format `external-users/{external_user_id}`.", "required": true, "is_path": true, "entity": { @@ -248901,7 +253150,7 @@ "all_fields": [ { "name": "name", - "description": "Required. The resource name of the external user.\nFormat: external-users/{external_user_id}", + "description": "The resource name of the external user, in the format `external-users/{external_user_id}`.", "required": true, "is_path": true, "entity": { @@ -248912,7 +253161,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "Required. The resource name of the external user.\nFormat: external-users/{external_user_id}", + "description": "The resource name of the external user, in the format `external-users/{external_user_id}`.", "required": true, "is_path": true, "entity": { @@ -248923,7 +253172,7 @@ }, { "name": "GetGroupProxy", - "description": "Fetches a group by its internal ID from the Databricks\naccount that parents the calling workspace.", + "description": "Gets a group in the account that contains this workspace by its Databricks ID.", "summary": "Get a group in the account.", "path": "/api/2.0/identity/{name=groups/*}", "has_required_positional_arguments": true, @@ -248935,7 +253184,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -248946,7 +253195,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -248962,7 +253211,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the group.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -248973,7 +253222,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the group.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -248984,7 +253233,7 @@ }, { "name": "GetServicePrincipalProxy", - "description": "Fetches a service principal by its internal ID\nfrom the Databricks account that parents the calling workspace.", + "description": "Gets a service principal in the account that contains this workspace by its Databricks ID.", "summary": "Get a service principal in the account.", "path": "/api/2.0/identity/{name=service-principals/*}", "has_required_positional_arguments": true, @@ -248996,7 +253245,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249007,7 +253256,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249023,7 +253272,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -249032,7 +253281,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -249051,7 +253300,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -249060,7 +253309,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -249080,7 +253329,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249091,7 +253340,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the service principal.\nFormat: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in the format\n`service-principals/{service_principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249102,7 +253351,7 @@ }, { "name": "GetUserProxy", - "description": "Fetches a user by its internal ID from the Databricks account\nthat parents the calling workspace.", + "description": "Gets a user in the account that contains this workspace by their Databricks ID.", "summary": "Get a user in the account.", "path": "/api/2.0/identity/{name=users/*}", "has_required_positional_arguments": true, @@ -249114,7 +253363,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: users/{user_id}", + "description": "The resource name of the user, in the format `users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -249125,7 +253374,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: users/{user_id}", + "description": "The resource name of the user, in the format `users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -249141,7 +253390,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -249150,6 +253399,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -249159,7 +253409,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -249178,7 +253428,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -249187,6 +253437,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -249196,7 +253447,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -249216,7 +253467,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the user.\nFormat: users/{user_id}", + "description": "The resource name of the user, in the format `users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -249227,7 +253478,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the user.\nFormat: users/{user_id}", + "description": "The resource name of the user, in the format `users/{user_id}`.", "required": true, "is_path": true, "entity": { @@ -249402,7 +253653,7 @@ }, { "name": "GetWorkspaceAssignmentProxy", - "description": "Returns the assignment for a principal in the calling workspace.", + "description": "Gets a principal's direct assignment to this workspace, including its effective entitlements.\nReturns an error if the principal isn't assigned directly.", "summary": "Get a workspace assignment for a principal.", "path": "/api/2.0/identity/{name=workspace-assignments/*}", "has_required_positional_arguments": true, @@ -249414,7 +253665,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format `workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249425,7 +253676,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format `workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249441,7 +253692,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -249452,7 +253703,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -249464,7 +253715,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format `workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249475,7 +253726,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the workspace assignment.\nFormat: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in the format `workspace-assignments/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249486,7 +253737,7 @@ }, { "name": "GetWorkspaceIdentityDetail", - "description": "Returns the identity details for a principal in a workspace.", + "description": "Gets a principal's status in this workspace and whether it has access directly or through a\ngroup. Returns an error if the principal doesn't have access to the workspace.", "summary": "Get workspace identity details for a principal.", "path": "/api/2.0/identity/{name=principals/*/workspace-identity-detail}", "has_required_positional_arguments": true, @@ -249498,7 +253749,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the workspace identity detail.\nFormat: principals/{principal_id}/workspace-identity-detail", + "description": "The resource name of the workspace identity detail, in the format\n`principals/{principal_id}/workspace-identity-detail`.", "required": true, "is_path": true, "entity": { @@ -249509,7 +253760,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the workspace identity detail.\nFormat: principals/{principal_id}/workspace-identity-detail", + "description": "The resource name of the workspace identity detail, in the format\n`principals/{principal_id}/workspace-identity-detail`.", "required": true, "is_path": true, "entity": { @@ -249525,7 +253776,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the workspace identity detail.\nFormat: principals/{principal_id}/workspace-identity-detail", + "description": "The resource name of the workspace identity detail, in the format\n`principals/{principal_id}/workspace-identity-detail`.", "required": true, "is_path": true, "entity": { @@ -249536,7 +253787,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the workspace identity detail.\nFormat: principals/{principal_id}/workspace-identity-detail", + "description": "The resource name of the workspace identity detail, in the format\n`principals/{principal_id}/workspace-identity-detail`.", "required": true, "is_path": true, "entity": { @@ -249547,7 +253798,7 @@ }, { "name": "ListDirectGroupMembersProxy", - "description": "Lists provisioned direct members of a group with their membership source (internal or from identity provider).", + "description": "Lists the direct members of a group in the account that contains this workspace, sorted by\ndisplay name, with where each membership comes from. Members in your identity provider who\nhaven't been added to Databricks aren't included.", "summary": "List direct group members.", "path": "/api/2.0/identity/{parent=groups/*}/direct-members", "has_required_positional_arguments": true, @@ -249559,7 +253810,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the group whose direct members to list.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -249570,7 +253821,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the group whose direct members to list.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -249586,7 +253837,7 @@ "all_fields": [ { "name": "page_size", - "description": "The maximum number of members to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of members to return, up to 1000. The default is 1000. A page can contain\nfewer members.", "is_query": true, "entity": { "is_int": true @@ -249594,7 +253845,7 @@ }, { "name": "page_token", - "description": "A page token from a previous list call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -249602,7 +253853,7 @@ }, { "name": "parent", - "description": "The parent resource name of the group whose direct members to list.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -249613,7 +253864,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the group whose direct members to list.\nFormat: groups/{group_id}", + "description": "The resource name of the group, in the format `groups/{group_id}`.", "required": true, "is_path": true, "entity": { @@ -249625,7 +253876,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token from a previous list call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -249636,7 +253887,7 @@ }, { "name": "ListGroupsProxy", - "description": "Lists the groups in the Databricks account that parents\nthe calling workspace, returning one page per call. Supports filtering by group name or external ID.", + "description": "Lists the groups in the account that contains this workspace, sorted by Databricks ID. Groups\nin your identity provider that haven't been added to Databricks aren't included.", "summary": "List groups in the account.", "path": "/api/2.0/identity/groups", "has_required_positional_arguments": true, @@ -249653,7 +253904,7 @@ "all_fields": [ { "name": "filter", - "description": "Optional. Allows filtering groups by group name or external id.", + "description": "Filters groups by `group_name` or `external_id`, for example `group_name eq \"Data engineers\"`.\nPut the value in quotes.", "is_query": true, "entity": { "is_string": true @@ -249661,7 +253912,7 @@ }, { "name": "page_size", - "description": "The maximum number of groups to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of groups to return, up to 1000. The default is 1000. A page can contain\nfewer groups.", "is_query": true, "entity": { "is_int": true @@ -249669,7 +253920,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -249677,7 +253928,7 @@ }, { "name": "parent", - "description": "The resource name of the account to list groups in, `accounts/{account_id}`. Optional:\ndefaults to the account of the calling workspace, and any other account is rejected.", + "description": "The resource name of the account to list groups in, in the format `accounts/{account_id}`.\nDefaults to the account that contains this workspace. Any other account is rejected.", "is_query": true, "entity": { "is_string": true @@ -249688,7 +253939,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token, received from a previous ListGroups call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -249699,7 +253950,7 @@ }, { "name": "ListServicePrincipalsProxy", - "description": "Lists the service principals in the Databricks\naccount that parents the calling workspace, returning one page per call. Supports filtering by\napplication ID or external ID.", + "description": "Lists the service principals in the account that contains this workspace, sorted by Databricks\nID. Service principals in your identity provider that haven't been added to Databricks aren't\nincluded.", "summary": "List service principals in the account.", "path": "/api/2.0/identity/service-principals", "has_required_positional_arguments": true, @@ -249716,7 +253967,7 @@ "all_fields": [ { "name": "filter", - "description": "Optional. Allows filtering service principals by application id or external id.", + "description": "Filters service principals by `application_id` or `external_id`, for example\n`application_id eq \"\u003capplication-id\u003e\"`. Put the value in quotes.", "is_query": true, "entity": { "is_string": true @@ -249724,7 +253975,7 @@ }, { "name": "page_size", - "description": "The maximum number of SPs to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of service principals to return, up to 1000. The default is 1000. A page\ncan contain fewer service principals.", "is_query": true, "entity": { "is_int": true @@ -249732,7 +253983,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListServicePrincipals call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -249740,7 +253991,7 @@ }, { "name": "parent", - "description": "The resource name of the account to list service principals in, `accounts/{account_id}`. Optional:\ndefaults to the account of the calling workspace, and any other account is rejected.", + "description": "The resource name of the account to list service principals in, in the format\n`accounts/{account_id}`. Defaults to the account that contains this workspace. Any other\naccount is rejected.", "is_query": true, "entity": { "is_string": true @@ -249751,7 +254002,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token, received from a previous ListServicePrincipals call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -249762,7 +254013,7 @@ }, { "name": "ListTransitiveParentGroupsProxy", - "description": "Lists all transitive parent groups of a principal.", + "description": "Lists every group that a user, service principal, or group belongs to, directly or through\nother groups, in the account that contains this workspace. Results are sorted by Databricks ID.\nIf automatic identity management is on, the principal's group memberships are synced from your\nidentity provider first.", "summary": "List all transitive parent groups of a principal.", "path": "/api/2.0/identity/{parent=principals/*}/transitive-parent-groups", "has_required_positional_arguments": true, @@ -249774,7 +254025,7 @@ "required_fields": [ { "name": "parent", - "description": "The parent resource name of the principal whose transitive parent groups to list.\nFormat: principals/{principal_id}", + "description": "The user, service principal, or group whose parent groups to list, in the format\n`principals/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249785,7 +254036,7 @@ "required_in_url_fields": [ { "name": "parent", - "description": "The parent resource name of the principal whose transitive parent groups to list.\nFormat: principals/{principal_id}", + "description": "The user, service principal, or group whose parent groups to list, in the format\n`principals/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249801,7 +254052,7 @@ "all_fields": [ { "name": "page_size", - "description": "The maximum number of parent groups to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of groups to return, up to 1000. The default is 1000. A page can contain\nfewer groups.", "is_query": true, "entity": { "is_int": true @@ -249809,7 +254060,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListTransitiveParentGroups call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -249817,7 +254068,7 @@ }, { "name": "parent", - "description": "The parent resource name of the principal whose transitive parent groups to list.\nFormat: principals/{principal_id}", + "description": "The user, service principal, or group whose parent groups to list, in the format\n`principals/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249828,7 +254079,7 @@ "required_positional_arguments": [ { "name": "parent", - "description": "The parent resource name of the principal whose transitive parent groups to list.\nFormat: principals/{principal_id}", + "description": "The user, service principal, or group whose parent groups to list, in the format\n`principals/{principal_id}`.", "required": true, "is_path": true, "entity": { @@ -249839,7 +254090,7 @@ }, { "name": "ListUsersProxy", - "description": "Lists the users in the Databricks account that parents the\ncalling workspace, returning one page per call. Supports filtering by username or external ID.", + "description": "Lists the users in the account that contains this workspace, sorted by Databricks ID. Users in\nyour identity provider who haven't been added to Databricks aren't included.", "summary": "List users in the account.", "path": "/api/2.0/identity/users", "has_required_positional_arguments": true, @@ -249856,7 +254107,7 @@ "all_fields": [ { "name": "filter", - "description": "Optional. Allows filtering users by username or external id.", + "description": "Filters users by `username` or `external_id`, for example\n`username eq \"someone@example.com\"`. Put the value in quotes.", "is_query": true, "entity": { "is_string": true @@ -249864,7 +254115,7 @@ }, { "name": "page_size", - "description": "The maximum number of users to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of users to return, up to 1000. The default is 1000. A page can contain\nfewer users.", "is_query": true, "entity": { "is_int": true @@ -249872,7 +254123,7 @@ }, { "name": "page_token", - "description": "A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -249880,7 +254131,7 @@ }, { "name": "parent", - "description": "The resource name of the account to list users in, `accounts/{account_id}`. Optional:\ndefaults to the account of the calling workspace, and any other account is rejected.", + "description": "The resource name of the account to list users in, in the format `accounts/{account_id}`.\nDefaults to the account that contains this workspace. Any other account is rejected.", "is_query": true, "entity": { "is_string": true @@ -249891,7 +254142,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token, received from a previous ListUsers call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -249950,7 +254201,7 @@ }, { "name": "ListWorkspaceAssignmentsProxy", - "description": "Lists workspace assignments for the calling workspace. The response omits the\nper-principal entitlement fields (`entitlements` and `effective_entitlements`). To read the\nentitlements for a single principal, get that principal's assignment.", + "description": "Lists the principals assigned directly to this workspace. The response leaves `entitlements`\nand `effective_entitlements` empty. To read a principal's entitlements, get its assignment.", "summary": "List workspace assignments for a workspace.", "path": "/api/2.0/identity/workspace-assignments", "has_required_positional_arguments": true, @@ -249967,7 +254218,7 @@ "all_fields": [ { "name": "page_size", - "description": "The maximum number of workspace assignments to return. The service may return fewer than this value.\nIf not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000.", + "description": "The maximum number of assignments to return, up to 1000. The default is 1000. A page can\ncontain fewer assignments.", "is_query": true, "entity": { "is_int": true @@ -249975,7 +254226,7 @@ }, { "name": "page_token", - "description": "A page token from a previous list call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -249983,7 +254234,7 @@ }, { "name": "parent", - "description": "The resource name of the workspace to list assignments of,\n`accounts/{account_id}/workspaces/{workspace_id}`. Optional: defaults to the calling workspace,\nand any other workspace is rejected.", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`. Defaults to this workspace. Any other\nworkspace is rejected.", "is_query": true, "entity": { "is_string": true @@ -249994,7 +254245,7 @@ "token": { "poll_field": { "name": "page_token", - "description": "A page token from a previous list call. Provide this to retrieve the subsequent page.", + "description": "The `next_page_token` from a previous response, to get the next page.", "is_query": true, "entity": { "is_string": true @@ -250005,7 +254256,7 @@ }, { "name": "ResolveGroupProxy", - "description": "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.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "description": "Gets a group by its ID in your identity provider (IdP) and syncs its name and parent groups\nfrom your IdP. If the group isn't in the account that contains this workspace yet, it's added.\nRequires automatic identity management. If your account has group visibility filters, the\ngroup must match them.", "summary": "Resolve an external group in the Databricks account.", "path": "/api/2.0/identity/groups/resolve-by-external-id", "can_use_json": true, @@ -250021,7 +254272,7 @@ "required_fields": [ { "name": "external_id", - "description": "Required. The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250032,7 +254283,7 @@ "required_request_body_fields": [ { "name": "external_id", - "description": "Required. The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250048,7 +254299,7 @@ "all_fields": [ { "name": "external_id", - "description": "Required. The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250059,7 +254310,7 @@ "required_positional_arguments": [ { "name": "external_id", - "description": "Required. The external ID of the group in the customer's IdP.", + "description": "The ID of the group in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250070,7 +254321,7 @@ }, { "name": "ResolveServicePrincipalProxy", - "description": "Resolves a service principal with the given external ID from the customer's IdP. If the service\nprincipal does not exist, it will be created.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "description": "Gets a service principal by its ID in your identity provider (IdP) and syncs its details and\ngroup memberships from your IdP. If the service principal isn't in the account that contains\nthis workspace yet, it's added. Requires automatic identity management with Microsoft Entra ID\nas your IdP.", "summary": "Resolve an external service principal in the Databricks account.", "path": "/api/2.0/identity/service-principals/resolve-by-external-id", "can_use_json": true, @@ -250086,7 +254337,7 @@ "required_fields": [ { "name": "external_id", - "description": "Required. The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250097,7 +254348,7 @@ "required_request_body_fields": [ { "name": "external_id", - "description": "Required. The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250113,7 +254364,7 @@ "all_fields": [ { "name": "external_id", - "description": "Required. The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250124,7 +254375,7 @@ "required_positional_arguments": [ { "name": "external_id", - "description": "Required. The external ID of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250135,7 +254386,7 @@ }, { "name": "ResolveUserProxy", - "description": "Resolves a user with the given external ID from the customer's IdP. If the user does not exist, it will be created.\nIf the customer is not onboarded onto Automatic Identity Management (AIM), this will return an error.", + "description": "Gets a user by their ID in your identity provider (IdP) and syncs their details and group\nmemberships from your IdP. If the user isn't in the account that contains this workspace yet,\nthey're added. Requires automatic identity management.", "summary": "Resolve an external user in the Databricks account.", "path": "/api/2.0/identity/users/resolve-by-external-id", "can_use_json": true, @@ -250151,7 +254402,7 @@ "required_fields": [ { "name": "external_id", - "description": "Required. The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250162,7 +254413,7 @@ "required_request_body_fields": [ { "name": "external_id", - "description": "Required. The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250178,7 +254429,7 @@ "all_fields": [ { "name": "external_id", - "description": "Required. The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250189,7 +254440,7 @@ "required_positional_arguments": [ { "name": "external_id", - "description": "Required. The external ID of the user in the customer's IdP.", + "description": "The ID of the user in your IdP.", "required": true, "is_request_body_field": true, "entity": { @@ -250200,7 +254451,7 @@ }, { "name": "UpdateGroupProxy", - "description": "Updates an existing group in the Databricks account that\nparents the calling workspace. Only the fields named in the update mask are modified. Returns\nthe updated Group resource.\n\nWhen AIM is enabled and the group is an external identity (its external_id is set), only\nexternal_id can be updated; its other fields are sourced from your identity provider.\nWith AIM and group visibility filters, a new nonempty external_id must identify a visible group.\nClearing external_id is allowed.", + "description": "Updates a group in the account that contains this workspace. Only the fields in `update_mask`\nchange.\n\nIf automatic identity management is on and the group has an `external_id`, you can only update\n`external_id`. The group's other fields come from your identity provider. If your account also\nhas group visibility filters, a new `external_id` must match them. You can always clear\n`external_id`.", "summary": "Update a group in the account.", "path": "/api/2.0/identity/{name=groups/*}", "can_use_json": true, @@ -250214,7 +254465,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "required": true, "is_path": true, "entity": { @@ -250223,7 +254474,7 @@ }, { "name": "group", - "description": "Required. Group to be updated in Databricks", + "description": "The group to update. Its `name` identifies the group.", "required": true, "is_request_body_field": true, "entity": { @@ -250233,7 +254484,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `group_name` and `external_id`.", "required": true, "is_query": true, "entity": { @@ -250244,7 +254495,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "required": true, "is_path": true, "entity": { @@ -250253,7 +254504,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `group_name` and `external_id`.", "required": true, "is_query": true, "entity": { @@ -250264,7 +254515,7 @@ "required_request_body_fields": [ { "name": "group", - "description": "Required. Group to be updated in Databricks", + "description": "The group to update. Its `name` identifies the group.", "required": true, "is_request_body_field": true, "entity": { @@ -250276,7 +254527,7 @@ }, "request_body_field": { "name": "group", - "description": "Required. Group to be updated in Databricks", + "description": "The group to update. Its `name` identifies the group.", "required": true, "is_request_body_field": true, "entity": { @@ -250291,7 +254542,7 @@ "all_fields": [ { "name": "group", - "description": "Required. Group to be updated in Databricks", + "description": "The group to update. Its `name` identifies the group.", "required": true, "is_request_body_field": true, "entity": { @@ -250301,7 +254552,7 @@ }, { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "required": true, "is_path": true, "entity": { @@ -250310,7 +254561,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `group_name` and `external_id`.", "required": true, "is_query": true, "entity": { @@ -250319,7 +254570,7 @@ }, { "name": "account_id", - "description": "The parent account ID for group in Databricks.", + "description": "The ID of the account that contains the group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -250328,7 +254579,7 @@ }, { "name": "external_id", - "description": "ExternalId of the group in the customer's IdP.", + "description": "The ID of the group in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -250336,7 +254587,7 @@ }, { "name": "group_id", - "description": "Internal group ID of the group in Databricks.", + "description": "The Databricks ID of the group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -250345,7 +254596,7 @@ }, { "name": "group_name", - "description": "Display name of the group.", + "description": "The name of the group.", "is_request_body_field": true, "entity": { "is_string": true @@ -250353,7 +254604,7 @@ }, { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -250361,7 +254612,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the group, `accounts/{account_id}`. Both the\naccount-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the group, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -250372,7 +254623,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the group. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/groups/{group_id}\n- Workspace-scoped: groups/{group_id}", + "description": "The resource name of the group, in one of these formats:\n- Account APIs: `accounts/{account_id}/groups/{group_id}`\n- Workspace APIs: `groups/{group_id}`", "required": true, "is_path": true, "entity": { @@ -250381,7 +254632,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `group_name` and `external_id`.", "required": true, "is_query": true, "entity": { @@ -250392,7 +254643,7 @@ }, { "name": "UpdateServicePrincipalProxy", - "description": "Updates an existing service principal in the\nDatabricks account that parents the calling workspace. Only the fields named in the update mask\nare modified. Returns the updated ServicePrincipal resource.\n\nTo change is_agent on a locally managed service principal, set it to true or false. Naming\nis_agent in the update mask without a value leaves it unchanged.\n\nWhen AIM is enabled and the service principal is an external identity (its external_id is set),\nonly external_id can be updated; its other fields are sourced from your identity provider.", + "description": "Updates a service principal in the account that contains this workspace. Only the fields in\n`update_mask` change.\n\nIf automatic identity management is on and the service principal has an `external_id`, you can\nonly update `external_id`. Its other fields come from your identity provider. A service\nprincipal can't deactivate itself, and you can't update service principals that Databricks\nmanages.", "summary": "Update a service principal in the account.", "path": "/api/2.0/identity/{name=service-principals/*}", "can_use_json": true, @@ -250406,7 +254657,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "required": true, "is_path": true, "entity": { @@ -250415,7 +254666,7 @@ }, { "name": "service_principal", - "description": "Required. Service principal to be updated in Databricks", + "description": "The service principal to update. Its `name` identifies the service principal.", "required": true, "is_request_body_field": true, "entity": { @@ -250425,7 +254676,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `display_name`,\n`account_sp_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -250436,7 +254687,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "required": true, "is_path": true, "entity": { @@ -250445,7 +254696,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `display_name`,\n`account_sp_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -250456,7 +254707,7 @@ "required_request_body_fields": [ { "name": "service_principal", - "description": "Required. Service principal to be updated in Databricks", + "description": "The service principal to update. Its `name` identifies the service principal.", "required": true, "is_request_body_field": true, "entity": { @@ -250468,7 +254719,7 @@ }, "request_body_field": { "name": "service_principal", - "description": "Required. Service principal to be updated in Databricks", + "description": "The service principal to update. Its `name` identifies the service principal.", "required": true, "is_request_body_field": true, "entity": { @@ -250478,7 +254729,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -250487,7 +254738,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -250506,7 +254757,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -250515,7 +254766,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -250540,7 +254791,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -250549,7 +254800,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -250568,7 +254819,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -250577,7 +254828,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -250597,7 +254848,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "required": true, "is_path": true, "entity": { @@ -250606,7 +254857,7 @@ }, { "name": "service_principal", - "description": "Required. Service principal to be updated in Databricks", + "description": "The service principal to update. Its `name` identifies the service principal.", "required": true, "is_request_body_field": true, "entity": { @@ -250616,7 +254867,7 @@ "required_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -250625,7 +254876,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -250644,7 +254895,7 @@ "required_request_body_fields": [ { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -250653,7 +254904,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -250673,7 +254924,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `display_name`,\n`account_sp_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -250682,7 +254933,7 @@ }, { "name": "account_id", - "description": "The parent account ID for the service principal in Databricks.", + "description": "The ID of the account that contains the service principal.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -250691,7 +254942,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -250708,7 +254959,7 @@ }, { "name": "application_id", - "description": "Application ID of the service principal. Set at creation time and cannot be changed\nafterwards; when omitted, the server generates one.", + "description": "The service principal's application ID, a UUID. If you don't set it when you create the\nservice principal, Databricks generates one. It must be unique in the account and can't be\nchanged.", "is_computed": true, "is_request_body_field": true, "entity": { @@ -250717,7 +254968,7 @@ }, { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -250726,7 +254977,7 @@ }, { "name": "external_id", - "description": "ExternalId of the service principal in the customer's IdP.", + "description": "The ID of the service principal in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -250734,7 +254985,7 @@ }, { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -250742,7 +254993,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the service principal,\n`accounts/{account_id}`. Both the account-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the service principal, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -250751,7 +255002,7 @@ }, { "name": "service_principal_id", - "description": "Internal service principal ID of the service principal in Databricks.", + "description": "The Databricks ID of the service principal.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -250762,7 +255013,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the service principal. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/service-principals/{service_principal_id}\n- Workspace-scoped: service-principals/{service_principal_id}", + "description": "The resource name of the service principal, in one of these formats:\n- Account APIs: `accounts/{account_id}/service-principals/{service_principal_id}`\n- Workspace APIs: `service-principals/{service_principal_id}`", "required": true, "is_path": true, "entity": { @@ -250771,7 +255022,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `display_name`,\n`account_sp_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -250780,7 +255031,7 @@ }, { "name": "display_name", - "description": "Display name of the service principal.", + "description": "The service principal's display name.", "required": true, "is_request_body_field": true, "entity": { @@ -250789,7 +255040,7 @@ }, { "name": "account_sp_status", - "description": "The activity status of a service principal in a Databricks account.", + "description": "Whether the service principal is active in the account.", "required": true, "is_request_body_field": true, "entity": { @@ -250808,7 +255059,7 @@ }, { "name": "UpdateUserProxy", - "description": "Updates an existing user in the Databricks account that parents the calling workspace and\nreturns the updated user. Only the fields named in the update mask are modified. The updatable\nfields are fullName.givenName, fullName.familyName, status, and externalId.\n\nWhen AIM is enabled and the user is an external identity (its external_id is set), only\nexternal_id can be updated; its other fields are sourced from your identity provider.", + "description": "Updates a user in the account that contains this workspace. Only the fields in `update_mask`\nchange.\n\nIf automatic identity management is on and the user has an `external_id`, you can only update\n`external_id`. The user's other fields come from your identity provider. You can't deactivate\nyourself or change the status of the account owner.", "summary": "Update a user in the account.", "path": "/api/2.0/identity/{name=users/*}", "can_use_json": true, @@ -250822,7 +255073,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "required": true, "is_path": true, "entity": { @@ -250831,7 +255082,7 @@ }, { "name": "user", - "description": "Required. User to be updated in Databricks", + "description": "The user to update. Its `name` identifies the user.", "required": true, "is_request_body_field": true, "entity": { @@ -250841,7 +255092,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `full_name.given_name`,\n`full_name.family_name`, `account_user_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -250852,7 +255103,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "required": true, "is_path": true, "entity": { @@ -250861,7 +255112,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `full_name.given_name`,\n`full_name.family_name`, `account_user_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -250872,7 +255123,7 @@ "required_request_body_fields": [ { "name": "user", - "description": "Required. User to be updated in Databricks", + "description": "The user to update. Its `name` identifies the user.", "required": true, "is_request_body_field": true, "entity": { @@ -250884,7 +255135,7 @@ }, "request_body_field": { "name": "user", - "description": "Required. User to be updated in Databricks", + "description": "The user to update. Its `name` identifies the user.", "required": true, "is_request_body_field": true, "entity": { @@ -250894,7 +255145,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -250903,6 +255154,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -250912,7 +255164,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -250931,7 +255183,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -250940,6 +255192,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -250949,7 +255202,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -250974,7 +255227,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -250983,6 +255236,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -250992,7 +255246,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -251011,7 +255265,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -251020,6 +255274,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -251029,7 +255284,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -251049,7 +255304,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "required": true, "is_path": true, "entity": { @@ -251058,7 +255313,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `full_name.given_name`,\n`full_name.family_name`, `account_user_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -251067,7 +255322,7 @@ }, { "name": "user", - "description": "Required. User to be updated in Databricks", + "description": "The user to update. Its `name` identifies the user.", "required": true, "is_request_body_field": true, "entity": { @@ -251077,7 +255332,7 @@ "required_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -251086,6 +255341,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -251095,7 +255351,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -251114,7 +255370,7 @@ "required_request_body_fields": [ { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -251123,6 +255379,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -251132,7 +255389,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -251152,7 +255409,7 @@ }, { "name": "account_id", - "description": "The accountId parent of the user in Databricks.", + "description": "The ID of the account that contains the user.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -251161,7 +255418,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -251178,7 +255435,7 @@ }, { "name": "external_id", - "description": "ExternalId of the user in the customer's IdP.", + "description": "The ID of the user in your identity provider (IdP).", "is_request_body_field": true, "entity": { "is_string": true @@ -251186,6 +255443,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -251195,7 +255453,7 @@ }, { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -251203,7 +255461,7 @@ }, { "name": "parent", - "description": "The resource name of the account that contains the user, `accounts/{account_id}`. Both the\naccount-scoped and workspace-scoped APIs return it.", + "description": "The resource name of the account that contains the user, in the format\n`accounts/{account_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -251212,7 +255470,7 @@ }, { "name": "user_id", - "description": "Internal userId of the user in Databricks.", + "description": "The Databricks ID of the user.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -251221,7 +255479,7 @@ }, { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -251232,7 +255490,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the user. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/users/{user_id}\n- Workspace-scoped: users/{user_id}", + "description": "The resource name of the user, in one of these formats:\n- Account APIs: `accounts/{account_id}/users/{user_id}`\n- Workspace APIs: `users/{user_id}`", "required": true, "is_path": true, "entity": { @@ -251241,7 +255499,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update, separated by commas. You can update `full_name.given_name`,\n`full_name.family_name`, `account_user_status`, and `external_id`.", "required": true, "is_query": true, "entity": { @@ -251250,7 +255508,7 @@ }, { "name": "username", - "description": "Username/email of the user.", + "description": "The user's username, which is their email address. It can't be changed after the user is\ncreated.", "required": true, "is_request_body_field": true, "entity": { @@ -251259,6 +255517,7 @@ }, { "name": "full_name", + "description": "The user's name.", "required": true, "is_request_body_field": true, "entity": { @@ -251268,7 +255527,7 @@ }, { "name": "account_user_status", - "description": "The activity status of a user in a Databricks account.", + "description": "Whether the user is active in the account. New users are active unless you set this to\n`INACTIVE`.", "required": true, "is_request_body_field": true, "entity": { @@ -251617,7 +255876,7 @@ }, { "name": "UpdateWorkspaceAssignmentProxy", - "description": "Updates the entitlements of a directly assigned principal in the calling workspace. Changes are\napplied one at a time rather than atomically. If the request fails partway through, only some of\nthe requested changes take effect. Get the assignment afterwards to confirm the final\nstate.", + "description": "Replaces the entitlements of a principal's direct assignment to this workspace. The new list\ncan't be empty.\n\nEntitlements are changed one at a time. If the request fails partway through, only some of the\nchanges take effect. Get the assignment afterwards to check the result.", "summary": "Update a workspace assignment for a workspace.", "path": "/api/2.0/identity/{name=workspace-assignments/*}", "can_use_json": true, @@ -251632,7 +255891,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "required": true, "is_path": true, "entity": { @@ -251641,7 +255900,7 @@ }, { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be updated in Databricks.", + "description": "The assignment to update. Its `name` identifies the assignment.", "required": true, "is_request_body_field": true, "entity": { @@ -251651,7 +255910,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `entitlements`.", "required": true, "is_query": true, "entity": { @@ -251662,7 +255921,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "required": true, "is_path": true, "entity": { @@ -251671,7 +255930,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `entitlements`.", "required": true, "is_query": true, "entity": { @@ -251682,7 +255941,7 @@ "required_request_body_fields": [ { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be updated in Databricks.", + "description": "The assignment to update. Its `name` identifies the assignment.", "required": true, "is_request_body_field": true, "entity": { @@ -251694,7 +255953,7 @@ }, "request_body_field": { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be updated in Databricks.", + "description": "The assignment to update. Its `name` identifies the assignment.", "required": true, "is_request_body_field": true, "entity": { @@ -251704,7 +255963,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -251715,7 +255974,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -251732,7 +255991,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -251743,7 +256002,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -251755,7 +256014,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "required": true, "is_path": true, "entity": { @@ -251764,7 +256023,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `entitlements`.", "required": true, "is_query": true, "entity": { @@ -251773,7 +256032,7 @@ }, { "name": "workspace_assignment", - "description": "Required. Workspace assignment to be updated in Databricks.", + "description": "The assignment to update. Its `name` identifies the assignment.", "required": true, "is_request_body_field": true, "entity": { @@ -251783,7 +256042,7 @@ "required_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -251794,7 +256053,7 @@ "required_request_body_fields": [ { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -251806,7 +256065,7 @@ }, { "name": "account_id", - "description": "The account ID parent of the workspace where the principal is assigned", + "description": "The ID of the account that contains the workspace.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -251815,7 +256074,7 @@ }, { "name": "effective_entitlements", - "description": "Every entitlement the principal holds in this workspace, whether granted directly or through\ngroup membership. Get responses populate this field. List responses leave it empty.", + "description": "Every entitlement the principal has in the workspace, granted directly or through a group. List\nresponses leave it empty.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -251847,7 +256106,7 @@ }, { "name": "entitlements", - "description": "Entitlements granted directly to the principal on this workspace. This is the only\nclient-settable field. Create and update manage exactly this set, including entitlements the\nprincipal also holds through a group.\nList responses leave this field empty. Get a single principal to read its entitlements.", + "description": "The entitlements granted directly by this assignment. Create and update set exactly this list,\neven if the principal also gets some of these entitlements through a group. List responses\nleave it empty.", "is_request_body_field": true, "entity": { "pascal_name": "EntitlementList", @@ -251878,7 +256137,7 @@ }, { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "is_request_body_field": true, "entity": { "is_string": true @@ -251886,7 +256145,7 @@ }, { "name": "parent", - "description": "The resource name of the workspace that contains the assignment,\n`accounts/{account_id}/workspaces/{workspace_id}`. Both the account-scoped and workspace-scoped\nAPIs return it.", + "description": "The resource name of the workspace, in the format\n`accounts/{account_id}/workspaces/{workspace_id}`. Workspace APIs return the same format.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -251895,7 +256154,7 @@ }, { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -251904,7 +256163,7 @@ }, { "name": "principal_type", - "description": "The type of the principal (user/service principal/group) that is assigned.", + "description": "Whether the assigned principal is a user, service principal, or group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -251924,7 +256183,7 @@ }, { "name": "workspace_id", - "description": "The workspace ID where the principal is assigned.", + "description": "The ID of the workspace.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -251935,7 +256194,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the workspace assignment. The format depends on the API that returned it:\n- Account-scoped: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}\n- Workspace-scoped: workspace-assignments/{principal_id}", + "description": "The resource name of the assignment, in one of these formats:\n- Account APIs:\n`accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}`\n- Workspace APIs: `workspace-assignments/{principal_id}`", "required": true, "is_path": true, "entity": { @@ -251944,7 +256203,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `entitlements`.", "required": true, "is_query": true, "entity": { @@ -251953,7 +256212,7 @@ }, { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks. Set when the assignment is\ncreated and cannot be changed afterwards; to assign a different principal, create a new\nassignment.", + "description": "The Databricks ID of the assigned user, service principal, or group. It can't be changed after\nthe assignment is created.", "required": true, "is_request_body_field": true, "entity": { @@ -251964,7 +256223,7 @@ }, { "name": "UpdateWorkspaceIdentityDetail", - "description": "Updates a workspace identity detail for a principal.", + "description": "Activates or deactivates a user or service principal in this workspace. You can only update\n`workspace_identity_status`. You can't change your own status or the status of a group.", "summary": "Update workspace identity details for a principal.", "path": "/api/2.0/identity/{name=principals/*/workspace-identity-detail}", "can_use_json": true, @@ -251979,7 +256238,7 @@ "required_fields": [ { "name": "name", - "description": "The resource name of the workspace identity detail.\nFormat: principals/{principal_id}/workspace-identity-detail", + "description": "The resource name of the workspace identity detail, in the format\n`principals/{principal_id}/workspace-identity-detail`.", "required": true, "is_path": true, "entity": { @@ -251988,7 +256247,7 @@ }, { "name": "workspace_identity_detail", - "description": "Required. Workspace identity detail to be updated in Databricks.", + "description": "The workspace identity detail to update. Its `name` identifies the principal.", "required": true, "is_request_body_field": true, "entity": { @@ -251998,7 +256257,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `workspace_identity_status`.", "required": true, "is_query": true, "entity": { @@ -252009,7 +256268,7 @@ "required_in_url_fields": [ { "name": "name", - "description": "The resource name of the workspace identity detail.\nFormat: principals/{principal_id}/workspace-identity-detail", + "description": "The resource name of the workspace identity detail, in the format\n`principals/{principal_id}/workspace-identity-detail`.", "required": true, "is_path": true, "entity": { @@ -252018,7 +256277,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `workspace_identity_status`.", "required": true, "is_query": true, "entity": { @@ -252029,7 +256288,7 @@ "required_request_body_fields": [ { "name": "workspace_identity_detail", - "description": "Required. Workspace identity detail to be updated in Databricks.", + "description": "The workspace identity detail to update. Its `name` identifies the principal.", "required": true, "is_request_body_field": true, "entity": { @@ -252041,7 +256300,7 @@ }, "request_body_field": { "name": "workspace_identity_detail", - "description": "Required. Workspace identity detail to be updated in Databricks.", + "description": "The workspace identity detail to update. Its `name` identifies the principal.", "required": true, "is_request_body_field": true, "entity": { @@ -252056,7 +256315,7 @@ "all_fields": [ { "name": "name", - "description": "The resource name of the workspace identity detail.\nFormat: principals/{principal_id}/workspace-identity-detail", + "description": "The resource name of the workspace identity detail, in the format\n`principals/{principal_id}/workspace-identity-detail`.", "required": true, "is_path": true, "entity": { @@ -252065,7 +256324,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `workspace_identity_status`.", "required": true, "is_query": true, "entity": { @@ -252074,7 +256333,7 @@ }, { "name": "workspace_identity_detail", - "description": "Required. Workspace identity detail to be updated in Databricks.", + "description": "The workspace identity detail to update. Its `name` identifies the principal.", "required": true, "is_request_body_field": true, "entity": { @@ -252084,7 +256343,7 @@ }, { "name": "assignment_type", - "description": "The type of assignment the principal has to the workspace (direct or indirect).", + "description": "Whether the principal is assigned to the workspace directly or has access through a group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -252101,7 +256360,7 @@ }, { "name": "name", - "description": "The resource name of the workspace identity detail.\nFormat: principals/{principal_id}/workspace-identity-detail", + "description": "The resource name of the workspace identity detail, in the format\n`principals/{principal_id}/workspace-identity-detail`.", "is_request_body_field": true, "entity": { "is_string": true @@ -252109,7 +256368,7 @@ }, { "name": "principal_id", - "description": "The internal ID of the principal (user/sp/group) in Databricks.", + "description": "The Databricks ID of the user, service principal, or group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -252118,7 +256377,7 @@ }, { "name": "principal_type", - "description": "The type of the principal (user/service principal/group).", + "description": "Whether the principal is a user, service principal, or group.", "is_output_only": true, "is_request_body_field": true, "entity": { @@ -252138,7 +256397,7 @@ }, { "name": "workspace_identity_status", - "description": "The activity status of an identity in a Databricks workspace.", + "description": "Whether the principal is active in the workspace. Groups are always `ACTIVE`.", "is_request_body_field": true, "entity": { "pascal_name": "State", @@ -252156,7 +256415,7 @@ "required_positional_arguments": [ { "name": "name", - "description": "The resource name of the workspace identity detail.\nFormat: principals/{principal_id}/workspace-identity-detail", + "description": "The resource name of the workspace identity detail, in the format\n`principals/{principal_id}/workspace-identity-detail`.", "required": true, "is_path": true, "entity": { @@ -252165,7 +256424,7 @@ }, { "name": "update_mask", - "description": "Required. The list of fields to update.", + "description": "The fields to update. The only supported field is `workspace_identity_status`.", "required": true, "is_query": true, "entity": { @@ -252761,6 +257020,17 @@ "is_object": true } }, + { + "name": "effective_workspace_dashboard_theme", + "description": "Effective setting value for the workspace_dashboard_theme setting. This is the final effective value of the setting. To set a value, use workspace_dashboard_theme.", + "is_output_only": true, + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DashboardTheme", + "is_object": true + } + }, { "name": "effective_workspace_label", "description": "Effective setting value for workspace_label setting. This is the final effective value of setting. To set a value use workspace_label.", @@ -252829,6 +257099,16 @@ "is_object": true } }, + { + "name": "workspace_dashboard_theme", + "description": "Setting value for the workspace_dashboard_theme setting. This is the setting value set by consumers. Check effective_workspace_dashboard_theme for the final setting value.", + "is_request_body_field": true, + "is_optional_object": true, + "entity": { + "pascal_name": "DashboardTheme", + "is_object": true + } + }, { "name": "workspace_label", "description": "Setting value for workspace_label setting. This is the setting value set by consumers, check effective_workspace_label for final setting value.", diff --git a/.gitattributes b/.gitattributes index 21eb823a61d..0c7524ce9b5 100644 --- a/.gitattributes +++ b/.gitattributes @@ -165,11 +165,13 @@ cmd/workspace/sandbox/sandbox.go linguist-generated=true cmd/workspace/schemas/schemas.go linguist-generated=true cmd/workspace/secrets-uc/secrets-uc.go linguist-generated=true cmd/workspace/secrets/secrets.go linguist-generated=true +cmd/workspace/serverless-compute-service/serverless-compute-service.go linguist-generated=true cmd/workspace/service-principal-secrets-proxy/service-principal-secrets-proxy.go linguist-generated=true cmd/workspace/service-principals-v2/service-principals-v2.go linguist-generated=true cmd/workspace/serving-endpoints/serving-endpoints.go linguist-generated=true cmd/workspace/settings/settings.go linguist-generated=true cmd/workspace/shares/shares.go linguist-generated=true +cmd/workspace/software-artifacts/software-artifacts.go linguist-generated=true cmd/workspace/sql-results-download/sql-results-download.go linguist-generated=true cmd/workspace/storage-credentials/storage-credentials.go linguist-generated=true cmd/workspace/supervisor-agents/supervisor-agents.go linguist-generated=true diff --git a/.nextchanges/dependency-updates/go-sdk-v0.196.0.md b/.nextchanges/dependency-updates/go-sdk-v0.196.0.md new file mode 100644 index 00000000000..b370f88a07a --- /dev/null +++ b/.nextchanges/dependency-updates/go-sdk-v0.196.0.md @@ -0,0 +1 @@ +* Update the Go SDK to [v0.196.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.196.0). diff --git a/acceptance/bundle/refschema/output/materialization_sets.txt b/acceptance/bundle/refschema/output/materialization_sets.txt index 14b53dcb382..3d1682d1766 100644 --- a/acceptance/bundle/refschema/output/materialization_sets.txt +++ b/acceptance/bundle/refschema/output/materialization_sets.txt @@ -12,7 +12,9 @@ resources.materialization_sets.*.materialized_features[*].cron_schedule string A resources.materialization_sets.*.materialized_features[*].cron_schedule_trigger *ml.CronSchedule ALL resources.materialization_sets.*.materialized_features[*].cron_schedule_trigger.cron_expression string ALL resources.materialization_sets.*.materialized_features[*].cron_schedule_trigger.mode ml.CronScheduleMode ALL +resources.materialization_sets.*.materialized_features[*].cron_schedule_trigger.paused bool ALL resources.materialization_sets.*.materialized_features[*].cron_schedule_trigger.timezone_id string ALL +resources.materialization_sets.*.materialized_features[*].external_trigger *ml.ExternalTrigger ALL resources.materialization_sets.*.materialized_features[*].feature_name string ALL resources.materialization_sets.*.materialized_features[*].is_online bool ALL resources.materialization_sets.*.materialized_features[*].job_id int64 ALL @@ -51,6 +53,7 @@ resources.materialization_sets.*.materialized_features[*].table_name string ALL resources.materialization_sets.*.materialized_features[*].table_trigger *ml.TableTrigger ALL resources.materialization_sets.*.materialized_features[*].table_trigger.condition ml.TableTriggerTableTriggerCondition ALL resources.materialization_sets.*.materialized_features[*].table_trigger.min_time_between_triggers *duration.Duration ALL +resources.materialization_sets.*.materialized_features[*].table_trigger.paused bool ALL resources.materialization_sets.*.materialized_features[*].table_trigger.wait_after_last_change *duration.Duration ALL resources.materialization_sets.*.materialized_features[*].tags map[string]string ALL resources.materialization_sets.*.materialized_features[*].tags.* string ALL diff --git a/acceptance/bundle/refschema/output/vector_search_endpoints.txt b/acceptance/bundle/refschema/output/vector_search_endpoints.txt index 7fddb5b8e05..cff145c4aa2 100644 --- a/acceptance/bundle/refschema/output/vector_search_endpoints.txt +++ b/acceptance/bundle/refschema/output/vector_search_endpoints.txt @@ -23,8 +23,13 @@ resources.vector_search_endpoints.*.modified_status string INPUT resources.vector_search_endpoints.*.name string ALL resources.vector_search_endpoints.*.num_indexes int REMOTE resources.vector_search_endpoints.*.scaling_info *vectorsearch.EndpointScalingInfo REMOTE +resources.vector_search_endpoints.*.scaling_info.delayed_reason vectorsearch.EndpointScalingInfoScalingDelayReason REMOTE +resources.vector_search_endpoints.*.scaling_info.estimated_completion_timestamp int64 REMOTE +resources.vector_search_endpoints.*.scaling_info.index_initialization_percentage int REMOTE +resources.vector_search_endpoints.*.scaling_info.phase vectorsearch.EndpointScalingInfoScalingPhase REMOTE resources.vector_search_endpoints.*.scaling_info.requested_target_qps int64 REMOTE resources.vector_search_endpoints.*.scaling_info.state vectorsearch.ScalingChangeState REMOTE +resources.vector_search_endpoints.*.scaling_info.target_qps_change_allowed_after_timestamp int64 REMOTE resources.vector_search_endpoints.*.target_qps int64 ALL resources.vector_search_endpoints.*.url string INPUT resources.vector_search_endpoints.*.usage_policy_id string INPUT STATE diff --git a/bundle/direct/dresources/apitypes.generated.yml b/bundle/direct/dresources/apitypes.generated.yml index d3a230b347d..e5ee771955e 100644 --- a/bundle/direct/dresources/apitypes.generated.yml +++ b/bundle/direct/dresources/apitypes.generated.yml @@ -28,6 +28,8 @@ genie_spaces: dashboards.GenieUpdateSpaceRequest instance_pools: compute.CreateInstancePool +internal_immutable_snapshots: compute.ServerlessCompute + job_runs: jobs.RunNow jobs: jobs.JobSettings diff --git a/bundle/direct/dresources/configs/internal_immutable_snapshots.generated.yml b/bundle/direct/dresources/configs/internal_immutable_snapshots.generated.yml new file mode 100644 index 00000000000..beed94b0991 --- /dev/null +++ b/bundle/direct/dresources/configs/internal_immutable_snapshots.generated.yml @@ -0,0 +1,5 @@ +# Generated, do not edit. + +ignore_remote_changes: + - field: can_manage + reason: spec:output_only diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index a060ec2e8a1..ac7dc172b02 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -6751,7 +6751,7 @@ "description": "Configuration for an external-foundation-model destination. Provider auth\nand provider-specific cloud configuration are owned by a separate, governed\nModelProviderService entity referenced via `model_provider_service`; the\nplatform resolves the provider at invocation time.", "properties": { "model_provider_service": { - "description": "Resource name of the governed ModelProviderService that owns provider\nauth and provider-specific configuration. The referenced\nModelProviderService also carries the provider type, so this message\ndoes not surface it directly.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.", + "description": "Resource name of the governed ModelProviderService that owns provider\nauth and provider-specific configuration.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA" }, @@ -7954,8 +7954,8 @@ "SEV_SNP" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]" ] }, { @@ -8270,10 +8270,9 @@ "x-databricks-launch-stage": "GA" }, "confidential_compute_type": { - "description": "[Private Preview] The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", + "description": "[Beta] The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ConfidentialComputeType", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "x-databricks-launch-stage": "PUBLIC_BETA" }, "first_on_demand": { "description": "The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster.", @@ -10619,10 +10618,9 @@ "x-databricks-launch-stage": "GA" }, "sql_condition": { - "description": "[Private Preview] SQL condition that must be satisfied before a scheduled run is triggered. The condition is evaluated\nafter the cron expression fires and must return a truthy result for the run to proceed.", + "description": "[Beta] SQL condition that must be satisfied before a scheduled run is triggered. The condition is evaluated\nafter the cron expression fires and must return a truthy result for the run to proceed.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlConditionConfiguration", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "x-databricks-launch-stage": "PUBLIC_BETA" }, "timezone_id": { "description": "A Java timezone ID. The schedule for a job is resolved with respect to this timezone. See [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details. This field is required.", @@ -12536,22 +12534,19 @@ "type": "object", "properties": { "sql_query_id": { - "description": "[Private Preview] The ID of the SQL query to evaluate as the trigger condition.", + "description": "[Beta] The ID of the SQL query to evaluate as the trigger condition.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "x-databricks-launch-stage": "PUBLIC_BETA" }, "trigger_mode": { - "description": "[Private Preview] Determines how the SQL query result is interpreted to decide whether the condition fires.\nMust be set to a recognized value when provided.\nWhen unset on an existing serialized configuration, the server preserves the original\nsemantics by interpreting it as `QUERY_RETURNS_ROWS`. New configurations should set this\nexplicitly — explicit `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED` is rejected at validation.", + "description": "[Beta] Determines how the SQL query result is interpreted to decide whether the condition fires.\nMust be set to a recognized value when provided.\nWhen unset on an existing serialized configuration, the server preserves the original\nsemantics by interpreting it as `QUERY_RETURNS_ROWS`. New configurations should set this\nexplicitly — explicit `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED` is rejected at validation.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlConditionTriggerMode", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "x-databricks-launch-stage": "PUBLIC_BETA" }, "warehouse_id": { - "description": "[Private Preview] The canonical identifier of the SQL warehouse to run the condition query against.", + "description": "[Beta] The canonical identifier of the SQL warehouse to run the condition query against.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -12570,14 +12565,14 @@ "oneOf": [ { "type": "string", - "description": "The strategy used to evaluate a SQL condition trigger against a query result set.\n\n* `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`: Sentinel zero-value. Not a valid input — the\nvalidator rejects this when sent explicitly. Internally treated as `QUERY_RETURNS_ROWS`\nwhen reading legacy data that predates this field.\n* `QUERY_RETURNS_ROWS`: Fires whenever the result set has at least one row. Zero rows means\nthe condition is not met. This is the original SQL condition behavior.\n* `RESULT_VALUE_CHANGES`: Fires whenever the query's single result value differs from the\nprevious evaluation. The first evaluation always fires. Queries must return exactly one\ncell (one row, one column).", + "description": "The strategy used to evaluate a SQL condition trigger against a query result set.\n\n* `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`: Sentinel zero-value. Not a valid input — the\nvalidator rejects this when sent explicitly. Internally treated as `QUERY_RETURNS_ROWS`\nwhen reading legacy data that predates this field.\n* `QUERY_RETURNS_ROWS`: Fires whenever the result set has at least one row. Zero rows means\nthe condition is not met. This is the original SQL condition behavior.\n* `RESULT_VALUE_CHANGES`: Fires whenever the query's single result value differs from the\nprevious evaluation. The first evaluation stores the result as a baseline and does not\nfire. Queries must return exactly one cell (one row, one column).", "enum": [ "QUERY_RETURNS_ROWS", "RESULT_VALUE_CHANGES" ], "enumDescriptions": [ - "[Private Preview] Fires whenever the result set has at least one row. Zero rows means", - "[Private Preview] Fires whenever the query's single result value differs from the" + "[Beta] Fires whenever the result set has at least one row. Zero rows means", + "[Beta] Fires whenever the query's single result value differs from the" ] }, { @@ -12802,9 +12797,9 @@ "type": "object", "properties": { "attachment": { - "description": "[Public Preview] Optional: The configuration for the files attached to the dashboard snapshot notification. It\ncontrols the underlying data of dashboard widgets that is attached as data files and which\npages are included in the attached PDF. If not specified, the notification is sent with only\nthe default snapshot.", + "description": "Optional: The configuration for the files attached to the dashboard snapshot notification. It\ncontrols the underlying data of dashboard widgets that is attached as data files and which\npages are included in the attached PDF. If not specified, the notification is sent with only\nthe default snapshot.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachment", - "x-databricks-launch-stage": "PUBLIC_PREVIEW" + "x-databricks-launch-stage": "GA" }, "custom_subject": { "description": "Optional: Allows users to specify a custom subject line on the email sent\nto subscribers.", @@ -12837,14 +12832,14 @@ "description": "The configuration for the files attached to the dashboard snapshot notification sent to\nsubscribers. `data_attachment` describes the underlying data of dashboard widgets attached\nas data files, and `page_attachment` describes which dashboard pages are included in the\nattached PDF.", "properties": { "data_attachment": { - "description": "[Public Preview] Optional: The configuration for the underlying data of dashboard widgets attached as tabular\ndata files. If not specified, no tabular data is attached.", + "description": "Optional: The configuration for the underlying data of dashboard widgets attached as tabular\ndata files. If not specified, no tabular data is attached.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachment", - "x-databricks-launch-stage": "PUBLIC_PREVIEW" + "x-databricks-launch-stage": "GA" }, "page_attachment": { - "description": "[Public Preview] Optional: The selection of dashboard pages included in the attached PDF. If not specified,\nonly the first page is included.", + "description": "Optional: The selection of dashboard pages included in the attached PDF. If not specified,\nonly the first page is included.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentPageAttachment", - "x-databricks-launch-stage": "PUBLIC_PREVIEW" + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -12862,19 +12857,19 @@ "description": "The configuration for the tabular data files attached to the dashboard snapshot. `widgets`\nlists the widgets whose data is exported and `file_format` is the output format; each\nreferenced widget's data is exported as a separate file.", "properties": { "file_format": { - "description": "[Public Preview] The file format of the exported tabular data files.", + "description": "The file format of the exported tabular data files.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachmentFileFormat", - "x-databricks-launch-stage": "PUBLIC_PREVIEW" + "x-databricks-launch-stage": "GA" }, "include_applied_filters": { - "description": "[Public Preview] When true, the dashboard's applied filter values are included alongside the tabular data as\nan additional attached file.", + "description": "When true, the dashboard's applied filter values are included alongside the tabular data as\nan additional attached file.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PUBLIC_PREVIEW" + "x-databricks-launch-stage": "GA" }, "widgets": { - "description": "[Public Preview] The widgets whose underlying data is exported. At least one widget must be referenced.", + "description": "The widgets whose underlying data is exported. At least one widget must be referenced.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachmentWidget", - "x-databricks-launch-stage": "PUBLIC_PREVIEW" + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -12898,11 +12893,6 @@ "FILE_FORMAT_CSV", "FILE_FORMAT_TSV", "FILE_FORMAT_EXCEL" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" ] }, { @@ -12918,14 +12908,14 @@ "description": "Identifies a dashboard widget whose data to attach. `page_id` and `widget_id` are\nthe URL identifiers from the dashboard's serialized definition returned by the Get dashboard\nAPI (`serialized_dashboard`), and together they uniquely identify the widget.", "properties": { "page_id": { - "description": "[Public Preview] The URL identifier of the page containing the widget. This is the value of the `name`\nfield of the corresponding entry under `pages` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "description": "The URL identifier of the page containing the widget. This is the value of the `name`\nfield of the corresponding entry under `pages` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PUBLIC_PREVIEW" + "x-databricks-launch-stage": "GA" }, "widget_id": { - "description": "[Public Preview] The URL identifier of the widget. This is the value of the `name` field of the\ncorresponding widget under that page's `layout` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "description": "The URL identifier of the widget. This is the value of the `name` field of the\ncorresponding widget under that page's `layout` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PUBLIC_PREVIEW" + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -12947,14 +12937,14 @@ "description": "The selection of dashboard pages included in the attached PDF. `page_selection` chooses\nbetween all pages, the first page only, or an explicit subset listed in `page_ids`.", "properties": { "page_ids": { - "description": "[Public Preview] The identifiers of the pages to include in the PDF. Only specified when `page_selection` is\n`PAGE_SELECTION_SUBSET`. Each value is the identifier of a page in the dashboard's\nserialized definition returned by the Get dashboard API (`serialized_dashboard`): the value\nof the `name` field of an entry under `pages`.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "description": "The identifiers of the pages to include in the PDF. Only specified when `page_selection` is\n`PAGE_SELECTION_SUBSET`. Each value is the identifier of a page in the dashboard's\nserialized definition returned by the Get dashboard API (`serialized_dashboard`): the value\nof the `name` field of an entry under `pages`.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PUBLIC_PREVIEW" + "x-databricks-launch-stage": "GA" }, "page_selection": { - "description": "[Public Preview] How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to\ninclude are listed in `page_ids`.", + "description": "How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to\ninclude are listed in `page_ids`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentPageAttachmentPageSelection", - "x-databricks-launch-stage": "PUBLIC_PREVIEW" + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -12973,10 +12963,6 @@ "enum": [ "PAGE_SELECTION_ALL", "PAGE_SELECTION_SUBSET" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]" ] }, { @@ -13452,10 +13438,9 @@ "x-databricks-launch-stage": "PUBLIC_BETA" }, "sql_condition": { - "description": "[Private Preview] Optional SQL condition that gates whether this trigger fires.", + "description": "[Beta] Optional SQL condition that gates whether this trigger fires.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlConditionConfiguration", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "x-databricks-launch-stage": "PUBLIC_BETA" }, "table_update": { "description": "[Beta] Table update trigger configuration.", @@ -13503,10 +13488,9 @@ "x-databricks-launch-stage": "GA" }, "sql_condition": { - "description": "[Private Preview] SQL condition that must be satisfied for the trigger to fire. Can be used in combination with other trigger types and\nruns *after* other trigger types conditions are evaluated.", + "description": "[Beta] SQL condition that must be satisfied for the trigger to fire. Can be used in combination with other trigger types and\nruns *after* other trigger types conditions are evaluated.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlConditionConfiguration", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "x-databricks-launch-stage": "PUBLIC_BETA" }, "table_update": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration", @@ -13935,6 +13919,12 @@ "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, + "paused": { + "description": "[Private Preview] Whether automatic materialization is paused. Defaults to `false`.\nSupported only for materializations in a materialization set.\nUse the `UpdateMaterializationSet` API to pause or resume the set.\n\nPausing does not cancel running or queued runs. Runs can still be\ntriggered through the `TriggerMaterializationSet` API. Resuming does\nnot submit a run. Creating a paused materialization skips its initial run.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, "timezone_id": { "description": "[Private Preview] A Java timezone ID. The schedule is resolved with respect to this timezone. Defaults to UTC\nwhen omitted. Can only be configured for MANUAL schedules; DERIVED schedules are always aligned\nto UTC.", "$ref": "#/$defs/string", @@ -14191,6 +14181,19 @@ } ] }, + "ml.ExternalTrigger": { + "oneOf": [ + { + "type": "object", + "description": "A trigger that disables automatic materialization, including the initial run\nat creation. Runs are instead triggered through the `TriggerMaterializationSet`\nAPI. Supported only for batch materializations in a materialization set.", + "additionalProperties": false + }, + { + "type": "string", + "pattern": "\\$\\{(var(\\._*\\p{L}+([-_]*[\\p{L}\\p{N}]+)*(\\[[0-9]+\\])*)+)\\}" + } + ] + }, "ml.FeatureReference": { "oneOf": [ { @@ -14816,6 +14819,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.CronSchedule", "x-databricks-launch-stage": "GA" }, + "external_trigger": { + "description": "[Private Preview] A trigger that disables automatic materialization, including the initial run\nat creation. Runs are instead triggered through the `TriggerMaterializationSet`\nAPI. Supported only for batch materializations in a materialization set.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ExternalTrigger", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, "feature_name": { "description": "The full name of the feature in Unity Catalog.", "$ref": "#/$defs/string", @@ -15181,7 +15190,7 @@ "doNotSuggest": true }, "input_tables": { - "description": "[Private Preview] The full three-part names of the tables the pipeline reads from. Required to materialize this\nfeature with a TableTrigger, which starts a run when these tables update. Each table must exist\nwhen the feature is created. Feature Store doesn't confirm that the pipeline reads from these\ntables. At most 100 tables.", + "description": "[Private Preview] The full three-part names of the tables the pipeline reads from. Required to materialize this\nfeature with a TableTrigger, which starts a run when these tables update. Each table must exist\nwhen the feature is created. Feature Store doesn't confirm that the pipeline reads from these\ntables. At most 25 tables.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true @@ -15469,6 +15478,12 @@ "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, + "paused": { + "description": "[Private Preview] Whether automatic materialization is paused. Defaults to `false`.\nSupported only for materializations in a materialization set.\nUse the `UpdateMaterializationSet` API to pause or resume the set.\n\nPausing does not cancel running or queued runs. Runs can still be\ntriggered through the `TriggerMaterializationSet` API. Resuming does\nnot submit a run. Creating a paused materialization skips its initial run.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, "wait_after_last_change": { "description": "[Private Preview] How long the source table must go without updates before a run starts, so a series of\nupdates settles before the run. If not set, a run starts as soon as the source table updates.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", diff --git a/cmd/account/iam-v2/iam-v2.go b/cmd/account/iam-v2/iam-v2.go index e0950087f7c..4151a1ae44f 100644 --- a/cmd/account/iam-v2/iam-v2.go +++ b/cmd/account/iam-v2/iam-v2.go @@ -103,21 +103,21 @@ func newCreateDirectGroupMember() *cobra.Command { cmd.Flags().Var(&createDirectGroupMemberJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createDirectGroupMemberReq.DirectGroupMember.Name, "name", createDirectGroupMemberReq.DirectGroupMember.Name, `The resource name of the group membership.`) + cmd.Flags().StringVar(&createDirectGroupMemberReq.DirectGroupMember.Name, "name", createDirectGroupMemberReq.DirectGroupMember.Name, `The resource name of the membership, in one of these formats: - Account APIs: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id} - Workspace APIs: groups/{group_id}/direct-members/{principal_id}.`) cmd.Use = "create-direct-group-member PARENT PRINCIPAL_ID" cmd.Short = `Create a direct group membership.` cmd.Long = `Create a direct group membership. - Creates a group membership (assigns a principal to a group). + Adds a user, service principal, or group as a direct member of a group. - Authorization: the caller must be an account admin or a manager of the group - (holds the roles/group.manager role on it). + If automatic identity management is on and the group has an external_id, its + members come from your identity provider and can't be changed in Databricks. Arguments: - PARENT: The parent resource name of the group to add the member to. Format: - accounts/{account_id}/groups/{group_id} - PRINCIPAL_ID: Internal ID of the principal in Databricks.` + PARENT: The resource name of the group to add the member to, in the format + accounts/{account_id}/groups/{group_id}. + PRINCIPAL_ID: The Databricks ID of the member.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -199,27 +199,23 @@ func newCreateGroup() *cobra.Command { cmd.Flags().Var(&createGroupJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createGroupReq.Group.ExternalId, "external-id", createGroupReq.Group.ExternalId, `ExternalId of the group in the customer's IdP.`) - cmd.Flags().StringVar(&createGroupReq.Group.GroupName, "group-name", createGroupReq.Group.GroupName, `Display name of the group.`) - cmd.Flags().StringVar(&createGroupReq.Group.Name, "name", createGroupReq.Group.Name, `The resource name of the group.`) + cmd.Flags().StringVar(&createGroupReq.Group.ExternalId, "external-id", createGroupReq.Group.ExternalId, `The ID of the group in your identity provider (IdP).`) + cmd.Flags().StringVar(&createGroupReq.Group.GroupName, "group-name", createGroupReq.Group.GroupName, `The name of the group.`) + cmd.Flags().StringVar(&createGroupReq.Group.Name, "name", createGroupReq.Group.Name, `The resource name of the group, in one of these formats: - Account APIs: accounts/{account_id}/groups/{group_id} - Workspace APIs: groups/{group_id}.`) cmd.Use = "create-group PARENT" cmd.Short = `Create a group in the account.` cmd.Long = `Create a group in the account. - Creates a local group in the Databricks account and returns the created group. - A local group is one that is not synced from the customer's identity provider, - and can be created whether or not Account Identity Management (AIM) is - enabled. + Creates a local group, which is a group that isn't synced from your identity + provider (IdP). You become a manager of the new group. - When AIM is enabled, supplying an external ID returns an error. To provision - the identity from your identity provider, resolve it by its external ID with - ResolveGroup; to read an existing external identity, use the ExternalGroup - resource. + If automatic identity management is on, you can't set external_id. To add a + group from your IdP, get it as an external group instead. Arguments: - PARENT: The parent resource name of the account in which to create the group. - Format: accounts/{account_id}` + PARENT: The resource name of the account to create the group in, in the format + accounts/{account_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -287,7 +283,7 @@ func newCreateIdentityVisibilityFilter() *cobra.Command { cmd.Flags().Var(&createIdentityVisibilityFilterJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createIdentityVisibilityFilterReq.IdentityVisibilityFilterId, "identity-visibility-filter-id", createIdentityVisibilityFilterReq.IdentityVisibilityFilterId, `Optional.`) + cmd.Flags().StringVar(&createIdentityVisibilityFilterReq.IdentityVisibilityFilterId, "identity-visibility-filter-id", createIdentityVisibilityFilterReq.IdentityVisibilityFilterId, `The ID to give the filter, which becomes the last part of its resource name.`) // TODO: complex arg: exact // TODO: complex arg: prefix // TODO: complex arg: regex @@ -296,18 +292,18 @@ func newCreateIdentityVisibilityFilter() *cobra.Command { cmd.Short = `Create an identity-visibility filter in the account.` cmd.Long = `Create an identity-visibility filter in the account. - Creates a group visibility filter in the account. Requires account admin - privileges. Set principal_type to GROUP and specify exactly one of exact - (external ID), prefix (display-name starts with), or regex (full RE2 - display-name match). The filter applies across all workspaces in the account. - A duplicate filter ID or an existing rule with the same type and match value - returns ALREADY_EXISTS. Filters are immutable; to change a rule, delete it - and create a new one. + Creates a group visibility filter. It applies to every workspace in the + account. + + Returns ALREADY_EXISTS if a filter with the same ID, or the same type and + match value, already exists. Returns RESOURCE_EXHAUSTED if the account + already has the maximum number of filters of that type. You can't change a + filter: to change a rule, delete it and create a new one. Arguments: - PARENT: Required. The parent account. Format: accounts/{account_id} - PRINCIPAL_TYPE: The type of principal this rule applies to. Set to GROUP when creating a - filter. Other principal types are not supported for creation. + PARENT: The resource name of the account, in the format accounts/{account_id}. + PRINCIPAL_TYPE: The type of principal the filter applies to. Set it to GROUP. Other + types aren't supported. Supported values: [GROUP, SERVICE_PRINCIPAL, USER]` cmd.Annotations = make(map[string]string) @@ -390,28 +386,25 @@ func newCreateServicePrincipal() *cobra.Command { cmd.Flags().Var(&createServicePrincipalJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createServicePrincipalReq.ServicePrincipal.ExternalId, "external-id", createServicePrincipalReq.ServicePrincipal.ExternalId, `ExternalId of the service principal in the customer's IdP.`) - cmd.Flags().StringVar(&createServicePrincipalReq.ServicePrincipal.Name, "name", createServicePrincipalReq.ServicePrincipal.Name, `The resource name of the service principal.`) + cmd.Flags().StringVar(&createServicePrincipalReq.ServicePrincipal.ExternalId, "external-id", createServicePrincipalReq.ServicePrincipal.ExternalId, `The ID of the service principal in your identity provider (IdP).`) + cmd.Flags().StringVar(&createServicePrincipalReq.ServicePrincipal.Name, "name", createServicePrincipalReq.ServicePrincipal.Name, `The resource name of the service principal, in one of these formats: - Account APIs: accounts/{account_id}/service-principals/{service_principal_id} - Workspace APIs: service-principals/{service_principal_id}.`) cmd.Use = "create-service-principal PARENT DISPLAY_NAME ACCOUNT_SP_STATUS" cmd.Short = `Create a service principal in the account.` cmd.Long = `Create a service principal in the account. - Creates a local service principal in the Databricks account and returns the - created service principal. A local service principal is one that is not synced - from the customer's identity provider, and can be created whether or not - Account Identity Management (AIM) is enabled. + Creates a local service principal, which is a service principal that isn't + synced from your identity provider (IdP). - When AIM is enabled, supplying an external ID returns an error. To provision - the identity from your identity provider, resolve it by its external ID with - ResolveServicePrincipal; to read an existing external identity, use the - ExternalServicePrincipal resource. + If automatic identity management is on, you can't set external_id. To add a + service principal from your IdP, get it as an external service principal + instead. Arguments: - PARENT: The parent resource name of the account in which to create the service - principal. Format: accounts/{account_id} - DISPLAY_NAME: Display name of the service principal. - ACCOUNT_SP_STATUS: The activity status of a service principal in a Databricks account. + PARENT: The resource name of the account to create the service principal in, in + the format accounts/{account_id}. + DISPLAY_NAME: The service principal's display name. + ACCOUNT_SP_STATUS: Whether the service principal is active in the account. Supported values: [ACTIVE, INACTIVE]` cmd.Annotations = make(map[string]string) @@ -497,29 +490,27 @@ func newCreateUser() *cobra.Command { cmd.Flags().Var(&createUserJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createUserReq.User.ExternalId, "external-id", createUserReq.User.ExternalId, `ExternalId of the user in the customer's IdP.`) - cmd.Flags().StringVar(&createUserReq.User.Name, "name", createUserReq.User.Name, `The resource name of the user.`) + cmd.Flags().StringVar(&createUserReq.User.ExternalId, "external-id", createUserReq.User.ExternalId, `The ID of the user in your identity provider (IdP).`) + cmd.Flags().StringVar(&createUserReq.User.Name, "name", createUserReq.User.Name, `The resource name of the user, in one of these formats: - Account APIs: accounts/{account_id}/users/{user_id} - Workspace APIs: users/{user_id}.`) cmd.Use = "create-user PARENT USERNAME FULL_NAME ACCOUNT_USER_STATUS" cmd.Short = `Create a user in the account.` cmd.Long = `Create a user in the account. - Creates a local user in the Databricks account and returns the created user. A - local user is one that is not synced from the customer's identity provider, - and can be created whether or not Account Identity Management (AIM) is - enabled. + Creates a local user, which is a user that isn't synced from your identity + provider (IdP). - When AIM is enabled, supplying an external ID returns an error. To provision - the identity from your identity provider, resolve it by its external ID with - ResolveUser; to read an existing external identity, use the ExternalUser - resource. + If automatic identity management is on, you can't set external_id. To add a + user from your IdP, get them as an external user instead. Arguments: - PARENT: The parent resource name of the account in which to create the user. - Format: accounts/{account_id} - USERNAME: Username/email of the user. - FULL_NAME: - ACCOUNT_USER_STATUS: The activity status of a user in a Databricks account. + PARENT: The resource name of the account to create the user in, in the format + accounts/{account_id}. + USERNAME: The user's username, which is their email address. It can't be changed + after the user is created. + FULL_NAME: The user's name. + ACCOUNT_USER_STATUS: Whether the user is active in the account. New users are active unless you + set this to INACTIVE. Supported values: [ACTIVE, INACTIVE]` cmd.Annotations = make(map[string]string) @@ -614,24 +605,25 @@ func newCreateWorkspaceAssignment() *cobra.Command { // TODO: array: effective_entitlements // TODO: array: entitlements - cmd.Flags().StringVar(&createWorkspaceAssignmentReq.WorkspaceAssignment.Name, "name", createWorkspaceAssignmentReq.WorkspaceAssignment.Name, `The resource name of the workspace assignment.`) + cmd.Flags().StringVar(&createWorkspaceAssignmentReq.WorkspaceAssignment.Name, "name", createWorkspaceAssignmentReq.WorkspaceAssignment.Name, `The resource name of the assignment, in one of these formats: - Account APIs: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id} - Workspace APIs: workspace-assignments/{principal_id}.`) cmd.Use = "create-workspace-assignment PARENT PRINCIPAL_ID" cmd.Short = `Create a workspace assignment.` cmd.Long = `Create a workspace assignment. - Creates a workspace assignment for a principal. Entitlements are granted one - at a time rather than atomically. If the request fails partway through, the - principal stays assigned to the workspace with only some of the requested - entitlements. Get the assignment afterwards to confirm which entitlements were - granted. + Assigns a user, service principal, or group directly to a workspace with the + given entitlements. Returns an error if the principal is already assigned + directly. + + Entitlements are granted one at a time. If the request fails partway through, + the principal stays assigned with only some of the entitlements. Get the + assignment afterwards to check which were granted. Arguments: - PARENT: The parent resource name of the workspace to assign the principal to. - Format: accounts/{account_id}/workspaces/{workspace_id} - PRINCIPAL_ID: The internal ID of the principal (user/sp/group) in Databricks. Set when - the assignment is created and cannot be changed afterwards; to assign a - different principal, create a new assignment.` + PARENT: The resource name of the workspace, in the format + accounts/{account_id}/workspaces/{workspace_id}. + PRINCIPAL_ID: The Databricks ID of the assigned user, service principal, or group. It + can't be changed after the assignment is created.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -814,14 +806,14 @@ func newDeleteDirectGroupMember() *cobra.Command { cmd.Short = `Delete a direct group membership.` cmd.Long = `Delete a direct group membership. - Deletes a group membership (unassigns a principal from a group). + Removes a direct member from a group. - Authorization: the caller must be an account admin or a manager of the group - (holds the roles/group.manager role on it). + If automatic identity management is on and the group has an external_id, its + members come from your identity provider and can't be changed in Databricks. Arguments: - NAME: The resource name of the group membership. Format: - accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}` + NAME: The resource name of the membership, in the format + accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -876,14 +868,12 @@ func newDeleteGroup() *cobra.Command { cmd.Short = `Delete a group in the account.` cmd.Long = `Delete a group in the account. - Deletes a group from the Databricks account by its internal ID. - - Authorization: the caller must be an account admin or a manager of the group - (holds the roles/group.manager role on it). + Deletes a group from your account and removes it from the workspaces it's + assigned to. Arguments: - NAME: The resource name of the group. Format: - accounts/{account_id}/groups/{group_id}` + NAME: The resource name of the group, in the format + accounts/{account_id}/groups/{group_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -938,16 +928,15 @@ func newDeleteIdentityVisibilityFilter() *cobra.Command { cmd.Short = `Delete an identity-visibility filter.` cmd.Long = `Delete an identity-visibility filter. - Deletes a group visibility filter by its resource name. Requires account admin - privileges. Deleting a filter does not delete groups or revoke access. Groups - covered only by this rule stop being discoverable unless they or a transitive - parent are already provisioned in the account. If no group filters remain, all - groups become visible again. Deleting a filter that does not exist succeeds - without making any changes. + Deletes a group visibility filter. Deleting a filter doesn't delete groups or + remove access. Groups that only this filter matched stop being visible, unless + they or a parent group are already in your account. If no group filters + remain, all groups become visible again. Deleting a filter that doesn't exist + succeeds. Arguments: - NAME: Required. The resource name of the filter. Format: - accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}` + NAME: The resource name of the filter, in the format + accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1002,11 +991,13 @@ func newDeleteServicePrincipal() *cobra.Command { cmd.Short = `Delete a service principal in the account.` cmd.Long = `Delete a service principal in the account. - Deletes a service principal from the Databricks account by its internal ID. + Deletes a service principal from your account and removes it from the + workspaces it's assigned to. You can't delete service principals that + Databricks manages. Arguments: - NAME: The resource name of the service principal. Format: - accounts/{account_id}/service-principals/{service_principal_id}` + NAME: The resource name of the service principal, in the format + accounts/{account_id}/service-principals/{service_principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1061,11 +1052,12 @@ func newDeleteUser() *cobra.Command { cmd.Short = `Delete a user in the account.` cmd.Long = `Delete a user in the account. - Deletes a user from the Databricks account by its internal ID. + Deletes a user from your account and removes them from the workspaces they're + assigned to. Arguments: - NAME: The resource name of the user. Format: - accounts/{account_id}/users/{user_id}` + NAME: The resource name of the user, in the format + accounts/{account_id}/users/{user_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1120,14 +1112,17 @@ func newDeleteWorkspaceAssignment() *cobra.Command { cmd.Short = `Delete a workspace assignment.` cmd.Long = `Delete a workspace assignment. - Deletes a workspace assignment for a principal, revoking all of its - entitlements. Entitlements are revoked one at a time rather than atomically. - If the request fails partway through, the principal stays assigned with some - of its original entitlements. Retrying is safe. + Removes a principal's direct assignment to a workspace and revokes the + entitlements it granted. The principal keeps any access it gets through + groups. + + Entitlements are revoked one at a time. If the request fails partway through, + the principal stays assigned with some of its entitlements. You can retry the + request. Arguments: - NAME: The resource name of the workspace assignment. Format: - accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}` + NAME: The resource name of the assignment, in the format + accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1256,11 +1251,12 @@ func newGetDirectGroupMember() *cobra.Command { cmd.Short = `Get a direct group member.` cmd.Long = `Get a direct group member. - Gets a provisioned direct member of a group. + Gets a direct member of a group, including where the membership comes from. + Returns an error if the principal isn't a direct member. Arguments: - NAME: The resource name of the group membership. Format: - accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}` + NAME: The resource name of the membership, in the format + accounts/{account_id}/groups/{group_id}/direct-members/{principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1316,14 +1312,14 @@ func newGetExternalGroup() *cobra.Command { cmd.Short = `Get an external group in the account.` cmd.Long = `Get an external group in the account. - Retrieves an external 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 error. + Gets a group by its ID in your identity provider (IdP) and syncs its name and + parent groups from your IdP. If the group isn't in your account yet, it's + added. Requires automatic identity management. If your account has group + visibility filters, the group must match them. Arguments: - NAME: Required. The resource name of the external group. Format: - accounts/{account_id}/external-groups/{external_group_id}` + NAME: The resource name of the external group, in the format + accounts/{account_id}/external-groups/{external_group_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1379,14 +1375,14 @@ func newGetExternalServicePrincipal() *cobra.Command { cmd.Short = `Get an external service principal in the account.` cmd.Long = `Get an external service principal in the account. - Retrieves an external service principal with the given external ID from the - customer's IdP. If the service principal does not exist, it will be created. - If the customer is not onboarded onto Automatic Identity Management (AIM), - this will return an error. + Gets a service principal by its ID in your identity provider (IdP) and syncs + its details and group memberships from your IdP. If the service principal + isn't in your account yet, it's added. Requires automatic identity management + with Microsoft Entra ID as your IdP. Arguments: - NAME: Required. The resource name of the external service principal. Format: - accounts/{account_id}/external-service-principals/{external_service_principal_id}` + NAME: The resource name of the external service principal, in the format + accounts/{account_id}/external-service-principals/{external_service_principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1442,13 +1438,13 @@ func newGetExternalUser() *cobra.Command { cmd.Short = `Get an external user in the account.` cmd.Long = `Get an external user in the account. - Retrieves an external 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. + Gets a user by their ID in your identity provider (IdP) and syncs their + details and group memberships from your IdP. If the user isn't in your account + yet, they're added. Requires automatic identity management. Arguments: - NAME: Required. The resource name of the external user. Format: - accounts/{account_id}/external-users/{external_user_id}` + NAME: The resource name of the external user, in the format + accounts/{account_id}/external-users/{external_user_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1504,11 +1500,11 @@ func newGetGroup() *cobra.Command { cmd.Short = `Get a group in the account.` cmd.Long = `Get a group in the account. - Fetches a group from the Databricks account by its internal ID. + Gets a group by its Databricks ID. Arguments: - NAME: The resource name of the group. Format: - accounts/{account_id}/groups/{group_id}` + NAME: The resource name of the group, in the format + accounts/{account_id}/groups/{group_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1564,12 +1560,12 @@ func newGetIdentityVisibilityFilter() *cobra.Command { cmd.Short = `Get an identity-visibility filter.` cmd.Long = `Get an identity-visibility filter. - Gets a group visibility filter by its resource name. Requires account admin - privileges. Returns the filter rule, not the groups matched by the rule. + Gets a group visibility filter. It returns the rule, not the groups it + matches. Arguments: - NAME: Required. The resource name of the filter. Format: - accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}` + NAME: The resource name of the filter, in the format + accounts/{account_id}/identity-visibility-filters/{identity_visibility_filter_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1625,11 +1621,11 @@ func newGetServicePrincipal() *cobra.Command { cmd.Short = `Get a service principal in the account.` cmd.Long = `Get a service principal in the account. - Fetches a service principal from the Databricks account by its internal ID. + Gets a service principal by its Databricks ID. Arguments: - NAME: The resource name of the service principal. Format: - accounts/{account_id}/service-principals/{service_principal_id}` + NAME: The resource name of the service principal, in the format + accounts/{account_id}/service-principals/{service_principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1685,11 +1681,11 @@ func newGetUser() *cobra.Command { cmd.Short = `Get a user in the account.` cmd.Long = `Get a user in the account. - Fetches a user from the Databricks account by its internal ID. + Gets a user by their Databricks ID. Arguments: - NAME: The resource name of the user. Format: - accounts/{account_id}/users/{user_id}` + NAME: The resource name of the user, in the format + accounts/{account_id}/users/{user_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1814,11 +1810,12 @@ func newGetWorkspaceAssignment() *cobra.Command { cmd.Short = `Get a workspace assignment for a principal.` cmd.Long = `Get a workspace assignment for a principal. - Returns the assignment for a principal in a workspace. + Gets a principal's direct assignment to a workspace, including its effective + entitlements. Returns an error if the principal isn't assigned directly. Arguments: - NAME: The resource name of the workspace assignment. Format: - accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}` + NAME: The resource name of the assignment, in the format + accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1947,7 +1944,7 @@ func newListDirectGroupMembers() *cobra.Command { // branches, so the method-call path is always reached. var listDirectGroupMembersLimit int - cmd.Flags().IntVar(&listDirectGroupMembersReq.PageSize, "page-size", listDirectGroupMembersReq.PageSize, `The maximum number of members to return.`) + cmd.Flags().IntVar(&listDirectGroupMembersReq.PageSize, "page-size", listDirectGroupMembersReq.PageSize, `The maximum number of members to return, up to 1000.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listDirectGroupMembersLimit, "limit", 0, `Maximum number of results to return.`) @@ -1960,12 +1957,13 @@ func newListDirectGroupMembers() *cobra.Command { cmd.Short = `List direct group members.` cmd.Long = `List direct group members. - Lists provisioned direct members of a group with their membership source - (internal or from identity provider). + Lists the direct members of a group, sorted by display name, with where each + membership comes from. Members in your identity provider who haven't been + added to Databricks aren't included. Arguments: - PARENT: The parent resource name of the group whose direct members to list. - Format: accounts/{account_id}/groups/{group_id}` + PARENT: The resource name of the group, in the format + accounts/{account_id}/groups/{group_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2024,8 +2022,8 @@ func newListGroups() *cobra.Command { // branches, so the method-call path is always reached. var listGroupsLimit int - cmd.Flags().StringVar(&listGroupsReq.Filter, "filter", listGroupsReq.Filter, `Optional.`) - cmd.Flags().IntVar(&listGroupsReq.PageSize, "page-size", listGroupsReq.PageSize, `The maximum number of groups to return.`) + cmd.Flags().StringVar(&listGroupsReq.Filter, "filter", listGroupsReq.Filter, `Filters groups by group_name or external_id, for example group_name eq "Data engineers".`) + cmd.Flags().IntVar(&listGroupsReq.PageSize, "page-size", listGroupsReq.PageSize, `The maximum number of groups to return, up to 1000.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listGroupsLimit, "limit", 0, `Maximum number of results to return.`) @@ -2038,12 +2036,12 @@ func newListGroups() *cobra.Command { cmd.Short = `List groups in the account.` cmd.Long = `List groups in the account. - Lists the groups in the Databricks account, returning one page per call. - Supports filtering by group name or external ID. + Lists the groups in your account, sorted by Databricks ID. Groups in your + identity provider that haven't been added to Databricks aren't included. Arguments: - PARENT: The parent resource name of the account whose groups to list. Format: - accounts/{account_id}` + PARENT: The resource name of the account to list groups in, in the format + accounts/{account_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2102,7 +2100,7 @@ func newListIdentityVisibilityFilters() *cobra.Command { // branches, so the method-call path is always reached. var listIdentityVisibilityFiltersLimit int - cmd.Flags().IntVar(&listIdentityVisibilityFiltersReq.PageSize, "page-size", listIdentityVisibilityFiltersReq.PageSize, `The maximum number of filters to return.`) + cmd.Flags().IntVar(&listIdentityVisibilityFiltersReq.PageSize, "page-size", listIdentityVisibilityFiltersReq.PageSize, `The maximum number of filters to return, up to 1000.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listIdentityVisibilityFiltersLimit, "limit", 0, `Maximum number of results to return.`) @@ -2115,14 +2113,11 @@ func newListIdentityVisibilityFilters() *cobra.Command { cmd.Short = `List the identity-visibility filters in the account.` cmd.Long = `List the identity-visibility filters in the account. - Lists group visibility filters in the account, returning one page per call. - Requires account admin privileges. Returns filter rules, not the groups - matched by those rules. To retrieve the next page, pass the response's - next_page_token as page_token in the next request. If next_page_token is - omitted, there are no more pages. + Lists the group visibility filters in an account. It returns the rules, not + the groups they match. Arguments: - PARENT: Required. The parent account. Format: accounts/{account_id}` + PARENT: The resource name of the account, in the format accounts/{account_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2181,8 +2176,8 @@ func newListServicePrincipals() *cobra.Command { // branches, so the method-call path is always reached. var listServicePrincipalsLimit int - cmd.Flags().StringVar(&listServicePrincipalsReq.Filter, "filter", listServicePrincipalsReq.Filter, `Optional.`) - cmd.Flags().IntVar(&listServicePrincipalsReq.PageSize, "page-size", listServicePrincipalsReq.PageSize, `The maximum number of service principals to return.`) + cmd.Flags().StringVar(&listServicePrincipalsReq.Filter, "filter", listServicePrincipalsReq.Filter, `Filters service principals by application_id or external_id, for example application_id eq "".`) + cmd.Flags().IntVar(&listServicePrincipalsReq.PageSize, "page-size", listServicePrincipalsReq.PageSize, `The maximum number of service principals to return, up to 1000.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listServicePrincipalsLimit, "limit", 0, `Maximum number of results to return.`) @@ -2195,12 +2190,13 @@ func newListServicePrincipals() *cobra.Command { cmd.Short = `List service principals in the account.` cmd.Long = `List service principals in the account. - Lists the service principals in the Databricks account, returning one page per - call. Supports filtering by application ID or external ID. + Lists the service principals in your account, sorted by Databricks ID. Service + principals in your identity provider that haven't been added to Databricks + aren't included. Arguments: - PARENT: The parent resource name of the account whose service principals to list. - Format: accounts/{account_id}` + PARENT: The resource name of the account to list service principals in, in the + format accounts/{account_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2255,18 +2251,21 @@ func newListTransitiveParentGroups() *cobra.Command { var listTransitiveParentGroupsReq iamv2.ListTransitiveParentGroupsRequest - cmd.Flags().IntVar(&listTransitiveParentGroupsReq.PageSize, "page-size", listTransitiveParentGroupsReq.PageSize, `The maximum number of parent groups to return.`) - cmd.Flags().StringVar(&listTransitiveParentGroupsReq.PageToken, "page-token", listTransitiveParentGroupsReq.PageToken, `A page token, received from a previous ListTransitiveParentGroups call.`) + cmd.Flags().IntVar(&listTransitiveParentGroupsReq.PageSize, "page-size", listTransitiveParentGroupsReq.PageSize, `The maximum number of groups to return, up to 1000.`) + cmd.Flags().StringVar(&listTransitiveParentGroupsReq.PageToken, "page-token", listTransitiveParentGroupsReq.PageToken, `The next_page_token from a previous response, to get the next page.`) cmd.Use = "list-transitive-parent-groups PARENT" cmd.Short = `List all transitive parent groups of a principal.` cmd.Long = `List all transitive parent groups of a principal. - Lists all transitive parent groups of a principal. + Lists every group that a user, service principal, or group belongs to, + directly or through other groups, sorted by Databricks ID. If automatic + identity management is on, the principal's group memberships are synced from + your identity provider first. Arguments: - PARENT: The parent resource name of the principal whose transitive parent groups - to list. Format: accounts/{account_id}/principals/{principal_id}` + PARENT: The user, service principal, or group whose parent groups to list, in the + format accounts/{account_id}/principals/{principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2322,8 +2321,8 @@ func newListUsers() *cobra.Command { // branches, so the method-call path is always reached. var listUsersLimit int - cmd.Flags().StringVar(&listUsersReq.Filter, "filter", listUsersReq.Filter, `Optional.`) - cmd.Flags().IntVar(&listUsersReq.PageSize, "page-size", listUsersReq.PageSize, `The maximum number of users to return.`) + cmd.Flags().StringVar(&listUsersReq.Filter, "filter", listUsersReq.Filter, `Filters users by username or external_id, for example username eq "someone@example.com".`) + cmd.Flags().IntVar(&listUsersReq.PageSize, "page-size", listUsersReq.PageSize, `The maximum number of users to return, up to 1000.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listUsersLimit, "limit", 0, `Maximum number of results to return.`) @@ -2336,12 +2335,12 @@ func newListUsers() *cobra.Command { cmd.Short = `List users in the account.` cmd.Long = `List users in the account. - Lists the users in the Databricks account, returning one page per call. - Supports filtering by username or external ID. + Lists the users in your account, sorted by Databricks ID. Users in your + identity provider who haven't been added to Databricks aren't included. Arguments: - PARENT: The parent resource name of the account whose users to list. Format: - accounts/{account_id}` + PARENT: The resource name of the account to list users in, in the format + accounts/{account_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2485,7 +2484,7 @@ func newListWorkspaceAssignments() *cobra.Command { // branches, so the method-call path is always reached. var listWorkspaceAssignmentsLimit int - cmd.Flags().IntVar(&listWorkspaceAssignmentsReq.PageSize, "page-size", listWorkspaceAssignmentsReq.PageSize, `The maximum number of workspace assignments to return.`) + cmd.Flags().IntVar(&listWorkspaceAssignmentsReq.PageSize, "page-size", listWorkspaceAssignmentsReq.PageSize, `The maximum number of assignments to return, up to 1000.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listWorkspaceAssignmentsLimit, "limit", 0, `Maximum number of results to return.`) @@ -2498,14 +2497,13 @@ func newListWorkspaceAssignments() *cobra.Command { cmd.Short = `List workspace assignments for a workspace.` cmd.Long = `List workspace assignments for a workspace. - Lists workspace assignments for a workspace. The response omits the - per-principal entitlement fields (entitlements and - effective_entitlements). To read the entitlements for a single principal, - get that principal's assignment. + Lists the principals assigned directly to a workspace. The response leaves + entitlements and effective_entitlements empty. To read a principal's + entitlements, get its assignment. Arguments: - PARENT: The parent resource name of the workspace whose assignments to list. - Format: accounts/{account_id}/workspaces/{workspace_id}` + PARENT: The resource name of the workspace, in the format + accounts/{account_id}/workspaces/{workspace_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2569,13 +2567,13 @@ func newResolveGroup() *cobra.Command { 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 - error. + Gets a group by its ID in your identity provider (IdP) and syncs its name and + parent groups from your IdP. If the group isn't in your account yet, it's + added. Requires automatic identity management. If your account has group + visibility filters, the group must match them. Arguments: - EXTERNAL_ID: Required. The external ID of the group in the customer's IdP.` + EXTERNAL_ID: The ID of the group in your IdP.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -2657,13 +2655,13 @@ func newResolveServicePrincipal() *cobra.Command { Resolve an external service principal in the Databricks account. - Resolves a service principal with the given external ID from the customer's - IdP. If the service principal does not exist, it will be created. If the - customer is not onboarded onto Automatic Identity Management (AIM), this will - return an error. + Gets a service principal by its ID in your identity provider (IdP) and syncs + its details and group memberships from your IdP. If the service principal + isn't in your account yet, it's added. Requires automatic identity management + with Microsoft Entra ID as your IdP. Arguments: - EXTERNAL_ID: Required. The external ID of the service principal in the customer's IdP.` + EXTERNAL_ID: The ID of the service principal in your IdP.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -2745,12 +2743,12 @@ func newResolveUser() *cobra.Command { 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. + Gets a user by their ID in your identity provider (IdP) and syncs their + details and group memberships from your IdP. If the user isn't in your account + yet, they're added. Requires automatic identity management. Arguments: - EXTERNAL_ID: Required. The external ID of the user in the customer's IdP.` + EXTERNAL_ID: The ID of the user in your IdP.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -2827,30 +2825,27 @@ func newUpdateGroup() *cobra.Command { cmd.Flags().Var(&updateGroupJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateGroupReq.Group.ExternalId, "external-id", updateGroupReq.Group.ExternalId, `ExternalId of the group in the customer's IdP.`) - cmd.Flags().StringVar(&updateGroupReq.Group.GroupName, "group-name", updateGroupReq.Group.GroupName, `Display name of the group.`) - cmd.Flags().StringVar(&updateGroupReq.Group.Name, "name", updateGroupReq.Group.Name, `The resource name of the group.`) + cmd.Flags().StringVar(&updateGroupReq.Group.ExternalId, "external-id", updateGroupReq.Group.ExternalId, `The ID of the group in your identity provider (IdP).`) + cmd.Flags().StringVar(&updateGroupReq.Group.GroupName, "group-name", updateGroupReq.Group.GroupName, `The name of the group.`) + cmd.Flags().StringVar(&updateGroupReq.Group.Name, "name", updateGroupReq.Group.Name, `The resource name of the group, in one of these formats: - Account APIs: accounts/{account_id}/groups/{group_id} - Workspace APIs: groups/{group_id}.`) cmd.Use = "update-group NAME UPDATE_MASK" cmd.Short = `Update a group in the account.` cmd.Long = `Update a group in the account. - Updates an existing group in the Databricks account. Only the fields named in - the update mask are modified. Returns the updated Group resource. + Updates a group. Only the fields in update_mask change. - When AIM is enabled and the group is an external identity (its external_id is - set), only external_id can be updated; its other fields are sourced from your - identity provider. With AIM and group visibility filters, a new nonempty - external_id must identify a visible group. Clearing external_id is allowed. - - Authorization: the caller must be an account admin or a manager of the group - (holds the roles/group.manager role on it). + If automatic identity management is on and the group has an external_id, you + can only update external_id. The group's other fields come from your + identity provider. If your account also has group visibility filters, a new + external_id must match them. You can always clear external_id. Arguments: - NAME: The resource name of the group. The format depends on the API that - returned it: - Account-scoped: accounts/{account_id}/groups/{group_id} - - Workspace-scoped: groups/{group_id} - UPDATE_MASK: Required. The list of fields to update.` + NAME: The resource name of the group, in one of these formats: - Account APIs: + accounts/{account_id}/groups/{group_id} - Workspace APIs: + groups/{group_id} + UPDATE_MASK: The fields to update, separated by commas. You can update group_name and + external_id.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2919,32 +2914,29 @@ func newUpdateServicePrincipal() *cobra.Command { cmd.Flags().Var(&updateServicePrincipalJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateServicePrincipalReq.ServicePrincipal.ExternalId, "external-id", updateServicePrincipalReq.ServicePrincipal.ExternalId, `ExternalId of the service principal in the customer's IdP.`) - cmd.Flags().StringVar(&updateServicePrincipalReq.ServicePrincipal.Name, "name", updateServicePrincipalReq.ServicePrincipal.Name, `The resource name of the service principal.`) + cmd.Flags().StringVar(&updateServicePrincipalReq.ServicePrincipal.ExternalId, "external-id", updateServicePrincipalReq.ServicePrincipal.ExternalId, `The ID of the service principal in your identity provider (IdP).`) + cmd.Flags().StringVar(&updateServicePrincipalReq.ServicePrincipal.Name, "name", updateServicePrincipalReq.ServicePrincipal.Name, `The resource name of the service principal, in one of these formats: - Account APIs: accounts/{account_id}/service-principals/{service_principal_id} - Workspace APIs: service-principals/{service_principal_id}.`) cmd.Use = "update-service-principal NAME UPDATE_MASK DISPLAY_NAME ACCOUNT_SP_STATUS" cmd.Short = `Update a service principal in the account.` cmd.Long = `Update a service principal in the account. - Updates an existing service principal in the Databricks account. Only the - fields named in the update mask are modified. Returns the updated - ServicePrincipal resource. - - To change is_agent on a locally managed service principal, set it to true or - false. Naming is_agent in the update mask without a value leaves it unchanged. + Updates a service principal. Only the fields in update_mask change. - When AIM is enabled and the service principal is an external identity (its - external_id is set), only external_id can be updated; its other fields are - sourced from your identity provider. + If automatic identity management is on and the service principal has an + external_id, you can only update external_id. Its other fields come from + your identity provider. A service principal can't deactivate itself, and you + can't update service principals that Databricks manages. Arguments: - NAME: The resource name of the service principal. The format depends on the API - that returned it: - Account-scoped: + NAME: The resource name of the service principal, in one of these formats: - + Account APIs: accounts/{account_id}/service-principals/{service_principal_id} - - Workspace-scoped: service-principals/{service_principal_id} - UPDATE_MASK: Required. The list of fields to update. - DISPLAY_NAME: Display name of the service principal. - ACCOUNT_SP_STATUS: The activity status of a service principal in a Databricks account. + Workspace APIs: service-principals/{service_principal_id} + UPDATE_MASK: The fields to update, separated by commas. You can update display_name, + account_sp_status, and external_id. + DISPLAY_NAME: The service principal's display name. + ACCOUNT_SP_STATUS: Whether the service principal is active in the account. Supported values: [ACTIVE, INACTIVE]` cmd.Annotations = make(map[string]string) @@ -3031,29 +3023,32 @@ func newUpdateUser() *cobra.Command { cmd.Flags().Var(&updateUserJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateUserReq.User.ExternalId, "external-id", updateUserReq.User.ExternalId, `ExternalId of the user in the customer's IdP.`) - cmd.Flags().StringVar(&updateUserReq.User.Name, "name", updateUserReq.User.Name, `The resource name of the user.`) + cmd.Flags().StringVar(&updateUserReq.User.ExternalId, "external-id", updateUserReq.User.ExternalId, `The ID of the user in your identity provider (IdP).`) + cmd.Flags().StringVar(&updateUserReq.User.Name, "name", updateUserReq.User.Name, `The resource name of the user, in one of these formats: - Account APIs: accounts/{account_id}/users/{user_id} - Workspace APIs: users/{user_id}.`) cmd.Use = "update-user NAME UPDATE_MASK USERNAME FULL_NAME ACCOUNT_USER_STATUS" cmd.Short = `Update a user in the account.` cmd.Long = `Update a user in the account. - Updates an existing user in the Databricks account and returns the updated - user. Only the fields named in the update mask are modified. The updatable - fields are fullName.givenName, fullName.familyName, status, and externalId. + Updates a user. Only the fields in update_mask change. - When AIM is enabled and the user is an external identity (its external_id is - set), only external_id can be updated; its other fields are sourced from your - identity provider. + If automatic identity management is on and the user has an external_id, you + can only update external_id. The user's other fields come from your identity + provider. You can't deactivate yourself or change the status of the account + owner. Arguments: - NAME: The resource name of the user. The format depends on the API that returned - it: - Account-scoped: accounts/{account_id}/users/{user_id} - - Workspace-scoped: users/{user_id} - UPDATE_MASK: Required. The list of fields to update. - USERNAME: Username/email of the user. - FULL_NAME: - ACCOUNT_USER_STATUS: The activity status of a user in a Databricks account. + NAME: The resource name of the user, in one of these formats: - Account APIs: + accounts/{account_id}/users/{user_id} - Workspace APIs: + users/{user_id} + UPDATE_MASK: The fields to update, separated by commas. You can update + full_name.given_name, full_name.family_name, account_user_status, + and external_id. + USERNAME: The user's username, which is their email address. It can't be changed + after the user is created. + FULL_NAME: The user's name. + ACCOUNT_USER_STATUS: Whether the user is active in the account. New users are active unless you + set this to INACTIVE. Supported values: [ACTIVE, INACTIVE]` cmd.Annotations = make(map[string]string) @@ -3149,26 +3144,27 @@ func newUpdateWorkspaceAssignment() *cobra.Command { // TODO: array: effective_entitlements // TODO: array: entitlements - cmd.Flags().StringVar(&updateWorkspaceAssignmentReq.WorkspaceAssignment.Name, "name", updateWorkspaceAssignmentReq.WorkspaceAssignment.Name, `The resource name of the workspace assignment.`) + cmd.Flags().StringVar(&updateWorkspaceAssignmentReq.WorkspaceAssignment.Name, "name", updateWorkspaceAssignmentReq.WorkspaceAssignment.Name, `The resource name of the assignment, in one of these formats: - Account APIs: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id} - Workspace APIs: workspace-assignments/{principal_id}.`) cmd.Use = "update-workspace-assignment NAME UPDATE_MASK PRINCIPAL_ID" cmd.Short = `Update a workspace assignment.` cmd.Long = `Update a workspace assignment. - Updates the entitlements of a directly assigned principal in a workspace. - Changes are applied one at a time rather than atomically. If the request fails - partway through, only some of the requested changes take effect. Get the - assignment afterwards to confirm the final state. + Replaces the entitlements of a principal's direct assignment to a workspace. + The new list can't be empty. + + Entitlements are changed one at a time. If the request fails partway through, + only some of the changes take effect. Get the assignment afterwards to check + the result. Arguments: - NAME: The resource name of the workspace assignment. The format depends on the - API that returned it: - Account-scoped: + NAME: The resource name of the assignment, in one of these formats: - Account + APIs: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id} - - Workspace-scoped: workspace-assignments/{principal_id} - UPDATE_MASK: Required. The list of fields to update. - PRINCIPAL_ID: The internal ID of the principal (user/sp/group) in Databricks. Set when - the assignment is created and cannot be changed afterwards; to assign a - different principal, create a new assignment.` + - Workspace APIs: workspace-assignments/{principal_id} + UPDATE_MASK: The fields to update. The only supported field is entitlements. + PRINCIPAL_ID: The Databricks ID of the assigned user, service principal, or group. It + can't be changed after the assignment is created.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/account/settings-v2/settings-v2.go b/cmd/account/settings-v2/settings-v2.go index b84f334b6c5..f96bdc9c93b 100644 --- a/cmd/account/settings-v2/settings-v2.go +++ b/cmd/account/settings-v2/settings-v2.go @@ -358,6 +358,7 @@ func newPatchPublicAccountSetting() *cobra.Command { // TODO: complex arg: effective_personal_compute // TODO: complex arg: effective_restrict_workspace_admins // TODO: complex arg: effective_string_val + // TODO: complex arg: effective_workspace_dashboard_theme // TODO: complex arg: effective_workspace_label // TODO: complex arg: integer_val cmd.Flags().StringVar(&patchPublicAccountSettingReq.Setting.Name, "name", patchPublicAccountSettingReq.Setting.Name, `Name of the setting.`) @@ -365,6 +366,7 @@ func newPatchPublicAccountSetting() *cobra.Command { // TODO: complex arg: personal_compute // TODO: complex arg: restrict_workspace_admins // TODO: complex arg: string_val + // TODO: complex arg: workspace_dashboard_theme // TODO: complex arg: workspace_label cmd.Use = "patch-public-account-setting NAME" diff --git a/cmd/workspace/ai-search/ai-search.go b/cmd/workspace/ai-search/ai-search.go index 82e664eb3e2..e96c157ff52 100644 --- a/cmd/workspace/ai-search/ai-search.go +++ b/cmd/workspace/ai-search/ai-search.go @@ -1021,9 +1021,9 @@ Update an AI Search endpoint. Update an existing AI Search endpoint. Multi-bucket masks are supported and dispatched in deterministic bucket order: budget policy, custom tags, - throughput, then scaling/replicas. Per-bucket dispatch is not atomic across - buckets — if a later bucket fails, earlier buckets may already have been - applied. + throughput, scaling/replicas, then metrics export. Per-bucket dispatch is not + atomic across buckets — if a later bucket fails, earlier buckets may already + have been applied. Arguments: NAME: Name of the AI Search endpoint. Server-assigned full resource path diff --git a/cmd/workspace/cmd.go b/cmd/workspace/cmd.go index 520921ecb2e..58d58cafcef 100644 --- a/cmd/workspace/cmd.go +++ b/cmd/workspace/cmd.go @@ -107,11 +107,13 @@ import ( schemas "github.com/databricks/cli/cmd/workspace/schemas" secrets "github.com/databricks/cli/cmd/workspace/secrets" secrets_uc "github.com/databricks/cli/cmd/workspace/secrets-uc" + serverless_compute_service "github.com/databricks/cli/cmd/workspace/serverless-compute-service" service_principal_secrets_proxy "github.com/databricks/cli/cmd/workspace/service-principal-secrets-proxy" service_principals_v2 "github.com/databricks/cli/cmd/workspace/service-principals-v2" serving_endpoints "github.com/databricks/cli/cmd/workspace/serving-endpoints" settings "github.com/databricks/cli/cmd/workspace/settings" shares "github.com/databricks/cli/cmd/workspace/shares" + software_artifacts "github.com/databricks/cli/cmd/workspace/software-artifacts" storage_credentials "github.com/databricks/cli/cmd/workspace/storage-credentials" supervisor_agents "github.com/databricks/cli/cmd/workspace/supervisor-agents" system_schemas "github.com/databricks/cli/cmd/workspace/system-schemas" @@ -248,11 +250,13 @@ func All() []*cobra.Command { out = append(out, schemas.New()) out = append(out, secrets.New()) out = append(out, secrets_uc.New()) + out = append(out, serverless_compute_service.New()) out = append(out, service_principal_secrets_proxy.New()) out = append(out, service_principals_v2.New()) out = append(out, serving_endpoints.New()) out = append(out, settings.New()) out = append(out, shares.New()) + out = append(out, software_artifacts.New()) out = append(out, storage_credentials.New()) out = append(out, supervisor_agents.New()) out = append(out, system_schemas.New()) diff --git a/cmd/workspace/feature-engineering/feature-engineering.go b/cmd/workspace/feature-engineering/feature-engineering.go index 5f39476128c..d081e5a5bb4 100644 --- a/cmd/workspace/feature-engineering/feature-engineering.go +++ b/cmd/workspace/feature-engineering/feature-engineering.go @@ -63,6 +63,7 @@ func New() *cobra.Command { cmd.AddCommand(newListMaterializedFeatures()) cmd.AddCommand(newListStreams()) cmd.AddCommand(newPurgeFeatureEntities()) + cmd.AddCommand(newTriggerMaterializationSet()) cmd.AddCommand(newUpdateFeature()) cmd.AddCommand(newUpdateKafkaConfig()) cmd.AddCommand(newUpdateMaterializationSet()) @@ -702,6 +703,7 @@ func newCreateMaterializedFeature() *cobra.Command { cmd.Flags().StringVar(&createMaterializedFeatureReq.MaterializedFeature.BudgetPolicyId, "budget-policy-id", createMaterializedFeatureReq.MaterializedFeature.BudgetPolicyId, `The ID of the budget policy used to attribute the serverless compute cost of this materialization.`) cmd.Flags().StringVar(&createMaterializedFeatureReq.MaterializedFeature.CronSchedule, "cron-schedule", createMaterializedFeatureReq.MaterializedFeature.CronSchedule, ``) // TODO: complex arg: cron_schedule_trigger + // TODO: complex arg: external_trigger cmd.Flags().StringVar(&createMaterializedFeatureReq.MaterializedFeature.MaterializedFeatureId, "materialized-feature-id", createMaterializedFeatureReq.MaterializedFeature.MaterializedFeatureId, `Server-assigned unique identifier for the materialized feature.`) // TODO: complex arg: notifications // TODO: complex arg: offline_store_config @@ -2133,6 +2135,140 @@ func newPurgeFeatureEntities() *cobra.Command { return cmd } +// start trigger-materialization-set command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var triggerMaterializationSetOverrides []func( + *cobra.Command, + *ml.TriggerMaterializationSetRequest, +) + +func newTriggerMaterializationSet() *cobra.Command { + cmd := &cobra.Command{} + + var triggerMaterializationSetReq ml.TriggerMaterializationSetRequest + var triggerMaterializationSetJson flags.JsonFlag + + var triggerMaterializationSetSkipWait bool + var triggerMaterializationSetTimeout time.Duration + + cmd.Flags().BoolVar(&triggerMaterializationSetSkipWait, "no-wait", triggerMaterializationSetSkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&triggerMaterializationSetTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) + + cmd.Flags().Var(&triggerMaterializationSetJson, "json", `either inline JSON string or @path/to/file.json with request body`) + + cmd.Flags().StringVar(&triggerMaterializationSetReq.RequestId, "request-id", triggerMaterializationSetReq.RequestId, `Idempotency token in UUID format.`) + + cmd.Use = "trigger-materialization-set MATERIALIZATION_SET_ID" + cmd.Short = `Trigger a materialization set.` + cmd.Long = `Trigger a materialization set. + + Requests materialization of all members of the set. The set must be nonempty + and contain only batch materializations. Runs are allowed while automatic + scheduling is paused. Requested runs may wait in a queue, subject to queue + limits and expiry. + + Returns a long-running operation that completes when every requested run + reaches a terminal state. Success requires all runs and any required online + synchronization to succeed. Individual outcomes are available in + MaterializationSetTriggerProgress. + + Use CancelOperation to request cancellation of this operation's unfinished + work. Cancellation is best effort and does not undo completed writes. Online + synchronization already in progress may continue. + + Runs use the features' configured windows and settling delay. + + This is a long-running operation. By default, the command waits for the + operation to complete. Use --no-wait to return immediately with the raw + operation details. The operation's 'name' field can then be used to poll for + completion using the get-operation command. + + Arguments: + MATERIALIZATION_SET_ID: The ID of the materialization set to trigger.` + + // This command is being previewed; hide from help output. + cmd.Hidden = true + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + if cmd.Flags().Changed("json") { + diags := triggerMaterializationSetJson.Unmarshal(&triggerMaterializationSetReq) + if diags.HasError() { + return diags.Error() + } + if len(diags) > 0 { + err := cmdio.RenderDiagnostics(ctx, diags) + if err != nil { + return err + } + } + } + triggerMaterializationSetReq.MaterializationSetId = args[0] + + // Determine which mode to execute based on flags. + switch { + case triggerMaterializationSetSkipWait: + wait, err := w.FeatureEngineering.TriggerMaterializationSet(ctx, triggerMaterializationSetReq) + if err != nil { + return err + } + + // Return operation immediately without waiting. + operation, err := w.FeatureEngineering.GetOperation(ctx, ml.GetOperationRequest{ + Name: wait.Name(), + }) + if err != nil { + return err + } + return cmdio.Render(ctx, operation) + + default: + wait, err := w.FeatureEngineering.TriggerMaterializationSet(ctx, triggerMaterializationSetReq) + if err != nil { + return err + } + + // Show spinner while waiting for completion. + sp := cmdio.NewSpinner(ctx) + sp.Update("Waiting for trigger-materialization-set to complete...") + + // Wait for completion. + opts := api.WithTimeout(triggerMaterializationSetTimeout) + response, err := wait.Wait(ctx, opts) + if err != nil { + return err + } + sp.Close() + return cmdio.Render(ctx, response) + } + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range triggerMaterializationSetOverrides { + fn(cmd, &triggerMaterializationSetReq) + } + + return cmd +} + // start update-feature command // Slice with functions to override default command behavior. @@ -2527,6 +2663,7 @@ func newUpdateMaterializedFeature() *cobra.Command { cmd.Flags().StringVar(&updateMaterializedFeatureReq.MaterializedFeature.BudgetPolicyId, "budget-policy-id", updateMaterializedFeatureReq.MaterializedFeature.BudgetPolicyId, `The ID of the budget policy used to attribute the serverless compute cost of this materialization.`) cmd.Flags().StringVar(&updateMaterializedFeatureReq.MaterializedFeature.CronSchedule, "cron-schedule", updateMaterializedFeatureReq.MaterializedFeature.CronSchedule, ``) // TODO: complex arg: cron_schedule_trigger + // TODO: complex arg: external_trigger cmd.Flags().StringVar(&updateMaterializedFeatureReq.MaterializedFeature.MaterializedFeatureId, "materialized-feature-id", updateMaterializedFeatureReq.MaterializedFeature.MaterializedFeatureId, `Server-assigned unique identifier for the materialized feature.`) // TODO: complex arg: notifications // TODO: complex arg: offline_store_config diff --git a/cmd/workspace/lakewatch/lakewatch.go b/cmd/workspace/lakewatch/lakewatch.go index 3450b839fcf..511c70d4f28 100644 --- a/cmd/workspace/lakewatch/lakewatch.go +++ b/cmd/workspace/lakewatch/lakewatch.go @@ -97,8 +97,9 @@ func newCreateDatasource() *cobra.Command { // TODO: complex arg: status // TODO: complex arg: unity_catalog_connection // TODO: complex arg: updated_by + cmd.Flags().StringVar(&createDatasourceReq.Datasource.WarehouseId, "warehouse-id", createDatasourceReq.Datasource.WarehouseId, `ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update request, such as source and destination access checks.`) - cmd.Use = "create-datasource CATALOG_NAME SCHEMA_NAME DATASOURCE_NAME SCHEDULE WAREHOUSE_ID" + cmd.Use = "create-datasource CATALOG_NAME SCHEMA_NAME DATASOURCE_NAME SCHEDULE" cmd.Short = `*Beta* Create a datasource.` cmd.Long = `This command is in Beta and may change without notice. @@ -116,19 +117,13 @@ Create a datasource. supplied; the schema's current name is reported in effective_schema_name. DATASOURCE_NAME: Name of the datasource in Unity Catalog, unique within its schema. - Required on create and cannot be changed afterward. Reads return the value - as supplied; the datasource's current Unity Catalog name, which reflects - renames, is reported in effective_datasource_name. + Required on create and can be updated within the same catalog and schema. + Get synchronizes this field with the current Unity Catalog name, also + reported in effective_datasource_name. SCHEDULE: Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a request that sets schedule.enabled to false is rejected. Continuous schedules are not supported for Unity Catalog - connection datasources. - WAREHOUSE_ID: ID of the SQL warehouse that runs the checks Lakewatch performs to - validate a create or update request, such as source and destination access - checks. Required and non-blank on every create and update request; there - is no default warehouse. The requester must be able to use the warehouse. - Used only for those checks: it is not stored, is not returned on reads, - and does not affect the compute that runs the ingestion job.` + connection datasources.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -138,11 +133,11 @@ Create a datasource. if cmd.Flags().Changed("json") { err := root.ExactArgs(0)(cmd, args) if err != nil { - return errors.New("when --json flag is specified, no positional arguments are allowed. Provide 'catalog_name', 'schema_name', 'datasource_name', 'schedule', 'warehouse_id' in your JSON input") + return errors.New("when --json flag is specified, no positional arguments are allowed. Provide 'catalog_name', 'schema_name', 'datasource_name', 'schedule' in your JSON input") } return nil } - check := root.ExactArgs(5) + check := root.ExactArgs(4) return check(cmd, args) } @@ -179,9 +174,6 @@ Create a datasource. } } - if !cmd.Flags().Changed("json") { - createDatasourceReq.Datasource.WarehouseId = args[4] - } response, err := w.Lakewatch.CreateDatasource(ctx, createDatasourceReq) if err != nil { @@ -258,9 +250,10 @@ Create a rule. SCHEMA_NAME: Name of the Unity Catalog schema that contains the rule. Required. Cannot be changed after creation. Reads return the value as supplied; the schema's current name is reported in effective_schema_name. - RULE_NAME: Name of the rule within its Unity Catalog schema. Required. Cannot be - changed after creation. Reads return the value as supplied; the current UC - name is reported in effective_rule_name. + RULE_NAME: Name of the rule within its Unity Catalog schema. Required on create; can + be updated within the same catalog and schema. Get synchronizes this field + with the current Unity Catalog name, also reported in + effective_rule_name. SEVERITY: Free-form severity label, such as Informational, Medium, High, or Critical. FIDELITY: Signal quality for this rule. @@ -1227,8 +1220,9 @@ func newUpdateDatasource() *cobra.Command { // TODO: complex arg: status // TODO: complex arg: unity_catalog_connection // TODO: complex arg: updated_by + cmd.Flags().StringVar(&updateDatasourceReq.Datasource.WarehouseId, "warehouse-id", updateDatasourceReq.Datasource.WarehouseId, `ID of the SQL warehouse that runs the checks Lakewatch performs to validate a create or update request, such as source and destination access checks.`) - cmd.Use = "update-datasource NAME UPDATE_MASK CATALOG_NAME SCHEMA_NAME DATASOURCE_NAME SCHEDULE WAREHOUSE_ID" + cmd.Use = "update-datasource NAME UPDATE_MASK CATALOG_NAME SCHEMA_NAME DATASOURCE_NAME SCHEDULE" cmd.Short = `*Beta* Update a datasource.` cmd.Long = `This command is in Beta and may change without notice. @@ -1262,19 +1256,13 @@ Update a datasource. supplied; the schema's current name is reported in effective_schema_name. DATASOURCE_NAME: Name of the datasource in Unity Catalog, unique within its schema. - Required on create and cannot be changed afterward. Reads return the value - as supplied; the datasource's current Unity Catalog name, which reflects - renames, is reported in effective_datasource_name. + Required on create and can be updated within the same catalog and schema. + Get synchronizes this field with the current Unity Catalog name, also + reported in effective_datasource_name. SCHEDULE: Schedule on which the datasource's ingestion job runs. A datasource cannot be paused, so a request that sets schedule.enabled to false is rejected. Continuous schedules are not supported for Unity Catalog - connection datasources. - WAREHOUSE_ID: ID of the SQL warehouse that runs the checks Lakewatch performs to - validate a create or update request, such as source and destination access - checks. Required and non-blank on every create and update request; there - is no default warehouse. The requester must be able to use the warehouse. - Used only for those checks: it is not stored, is not returned on reads, - and does not affect the compute that runs the ingestion job.` + connection datasources.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -1284,11 +1272,11 @@ Update a datasource. if cmd.Flags().Changed("json") { err := root.ExactArgs(2)(cmd, args) if err != nil { - return errors.New("when --json flag is specified, provide only NAME, UPDATE_MASK as positional arguments. Provide 'catalog_name', 'schema_name', 'datasource_name', 'schedule', 'warehouse_id' in your JSON input") + return errors.New("when --json flag is specified, provide only NAME, UPDATE_MASK as positional arguments. Provide 'catalog_name', 'schema_name', 'datasource_name', 'schedule' in your JSON input") } return nil } - check := root.ExactArgs(7) + check := root.ExactArgs(6) return check(cmd, args) } @@ -1330,9 +1318,6 @@ Update a datasource. } } - if !cmd.Flags().Changed("json") { - updateDatasourceReq.Datasource.WarehouseId = args[6] - } response, err := w.Lakewatch.UpdateDatasource(ctx, updateDatasourceReq) if err != nil { @@ -1511,9 +1496,10 @@ Update a rule. SCHEMA_NAME: Name of the Unity Catalog schema that contains the rule. Required. Cannot be changed after creation. Reads return the value as supplied; the schema's current name is reported in effective_schema_name. - RULE_NAME: Name of the rule within its Unity Catalog schema. Required. Cannot be - changed after creation. Reads return the value as supplied; the current UC - name is reported in effective_rule_name. + RULE_NAME: Name of the rule within its Unity Catalog schema. Required on create; can + be updated within the same catalog and schema. Get synchronizes this field + with the current Unity Catalog name, also reported in + effective_rule_name. SEVERITY: Free-form severity label, such as Informational, Medium, High, or Critical. FIDELITY: Signal quality for this rule. diff --git a/cmd/workspace/postgres/postgres.go b/cmd/workspace/postgres/postgres.go index 1c11e863bf1..c5c1ed330c7 100644 --- a/cmd/workspace/postgres/postgres.go +++ b/cmd/workspace/postgres/postgres.go @@ -50,12 +50,15 @@ func New() *cobra.Command { cmd.Annotations["launch_stage_display"] = "GA" // Add methods + cmd.AddCommand(newAcknowledgeAssessmentWarnings()) + cmd.AddCommand(newAssessMigration()) cmd.AddCommand(newCreateBranch()) cmd.AddCommand(newCreateCatalog()) cmd.AddCommand(newCreateCdfConfig()) cmd.AddCommand(newCreateDataApi()) cmd.AddCommand(newCreateDatabase()) cmd.AddCommand(newCreateEndpoint()) + cmd.AddCommand(newCreateMigration()) cmd.AddCommand(newCreateProject()) cmd.AddCommand(newCreateRole()) cmd.AddCommand(newCreateSnapshot()) @@ -66,11 +69,13 @@ func New() *cobra.Command { cmd.AddCommand(newDeleteDataApi()) cmd.AddCommand(newDeleteDatabase()) cmd.AddCommand(newDeleteEndpoint()) + cmd.AddCommand(newDeleteMigration()) cmd.AddCommand(newDeleteProject()) cmd.AddCommand(newDeleteRole()) cmd.AddCommand(newDeleteSnapshot()) cmd.AddCommand(newDeleteSyncedTable()) cmd.AddCommand(newGenerateDatabaseCredential()) + cmd.AddCommand(newGetAssessment()) cmd.AddCommand(newGetBranch()) cmd.AddCommand(newGetCatalog()) cmd.AddCommand(newGetCdfConfig()) @@ -78,27 +83,33 @@ func New() *cobra.Command { cmd.AddCommand(newGetDataApi()) cmd.AddCommand(newGetDatabase()) cmd.AddCommand(newGetEndpoint()) + cmd.AddCommand(newGetMigration()) cmd.AddCommand(newGetOperation()) cmd.AddCommand(newGetProject()) cmd.AddCommand(newGetRole()) cmd.AddCommand(newGetSnapshot()) cmd.AddCommand(newGetSnapshotSchedule()) cmd.AddCommand(newGetSyncedTable()) + cmd.AddCommand(newListAssessments()) cmd.AddCommand(newListBranches()) cmd.AddCommand(newListCdfConfigs()) cmd.AddCommand(newListCdfStatuses()) cmd.AddCommand(newListDatabases()) cmd.AddCommand(newListEndpoints()) + cmd.AddCommand(newListMigrations()) cmd.AddCommand(newListProjects()) cmd.AddCommand(newListRoles()) cmd.AddCommand(newListSnapshots()) cmd.AddCommand(newRevealRolePassword()) + cmd.AddCommand(newStartMigration()) cmd.AddCommand(newUndeleteBranch()) + cmd.AddCommand(newUndeleteMigration()) cmd.AddCommand(newUndeleteProject()) cmd.AddCommand(newUpdateBranch()) cmd.AddCommand(newUpdateDataApi()) cmd.AddCommand(newUpdateDatabase()) cmd.AddCommand(newUpdateEndpoint()) + cmd.AddCommand(newUpdateMigration()) cmd.AddCommand(newUpdateProject()) cmd.AddCommand(newUpdateRole()) cmd.AddCommand(newUpdateSnapshotSchedule()) @@ -111,6 +122,215 @@ func New() *cobra.Command { return cmd } +// start acknowledge-assessment-warnings command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var acknowledgeAssessmentWarningsOverrides []func( + *cobra.Command, + *postgres.AcknowledgeAssessmentWarningsRequest, +) + +func newAcknowledgeAssessmentWarnings() *cobra.Command { + cmd := &cobra.Command{} + + var acknowledgeAssessmentWarningsReq postgres.AcknowledgeAssessmentWarningsRequest + + var acknowledgeAssessmentWarningsSkipWait bool + var acknowledgeAssessmentWarningsTimeout time.Duration + + cmd.Flags().BoolVar(&acknowledgeAssessmentWarningsSkipWait, "no-wait", acknowledgeAssessmentWarningsSkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&acknowledgeAssessmentWarningsTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) + + cmd.Use = "acknowledge-assessment-warnings NAME" + cmd.Short = `Acknowledge assessment warnings.` + cmd.Long = `Acknowledge assessment warnings. + + Acknowledges non-blocking warnings on a specific assessment. + + This is a long-running operation. By default, the command waits for the + operation to complete. Use --no-wait to return immediately with the raw + operation details. The operation's 'name' field can then be used to poll for + completion using the get-operation command. + + Arguments: + NAME: Required. The assessment resource name, in the format + migrations/{migration}/assessments/{assessment}.` + + // This command is being previewed; hide from help output. + cmd.Hidden = true + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + acknowledgeAssessmentWarningsReq.Name = args[0] + + // Determine which mode to execute based on flags. + switch { + case acknowledgeAssessmentWarningsSkipWait: + wait, err := w.Postgres.AcknowledgeAssessmentWarnings(ctx, acknowledgeAssessmentWarningsReq) + if err != nil { + return err + } + + // Return operation immediately without waiting. + operation, err := w.Postgres.GetOperation(ctx, postgres.GetOperationRequest{ + Name: wait.Name(), + }) + if err != nil { + return err + } + return cmdio.Render(ctx, operation) + + default: + wait, err := w.Postgres.AcknowledgeAssessmentWarnings(ctx, acknowledgeAssessmentWarningsReq) + if err != nil { + return err + } + + // Show spinner while waiting for completion. + sp := cmdio.NewSpinner(ctx) + sp.Update("Waiting for acknowledge-assessment-warnings to complete...") + + // Wait for completion. + opts := api.WithTimeout(acknowledgeAssessmentWarningsTimeout) + response, err := wait.Wait(ctx, opts) + if err != nil { + return err + } + sp.Close() + return cmdio.Render(ctx, response) + } + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range acknowledgeAssessmentWarningsOverrides { + fn(cmd, &acknowledgeAssessmentWarningsReq) + } + + return cmd +} + +// start assess-migration command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var assessMigrationOverrides []func( + *cobra.Command, + *postgres.AssessMigrationRequest, +) + +func newAssessMigration() *cobra.Command { + cmd := &cobra.Command{} + + var assessMigrationReq postgres.AssessMigrationRequest + + var assessMigrationSkipWait bool + var assessMigrationTimeout time.Duration + + cmd.Flags().BoolVar(&assessMigrationSkipWait, "no-wait", assessMigrationSkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&assessMigrationTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) + + cmd.Use = "assess-migration NAME" + cmd.Short = `Assess a migration.` + cmd.Long = `Assess a migration. + + Creates an immutable assessment run for the migration's current source + configuration. + + This is a long-running operation. By default, the command waits for the + operation to complete. Use --no-wait to return immediately with the raw + operation details. The operation's 'name' field can then be used to poll for + completion using the get-operation command. + + Arguments: + NAME: Required. The migration resource name, in the format + migrations/{migration}.` + + // This command is being previewed; hide from help output. + cmd.Hidden = true + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + assessMigrationReq.Name = args[0] + + // Determine which mode to execute based on flags. + switch { + case assessMigrationSkipWait: + wait, err := w.Postgres.AssessMigration(ctx, assessMigrationReq) + if err != nil { + return err + } + + // Return operation immediately without waiting. + operation, err := w.Postgres.GetOperation(ctx, postgres.GetOperationRequest{ + Name: wait.Name(), + }) + if err != nil { + return err + } + return cmdio.Render(ctx, operation) + + default: + wait, err := w.Postgres.AssessMigration(ctx, assessMigrationReq) + if err != nil { + return err + } + + // Show spinner while waiting for completion. + sp := cmdio.NewSpinner(ctx) + sp.Update("Waiting for assess-migration to complete...") + + // Wait for completion. + opts := api.WithTimeout(assessMigrationTimeout) + response, err := wait.Wait(ctx, opts) + if err != nil { + return err + } + sp.Close() + return cmdio.Render(ctx, response) + } + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range assessMigrationOverrides { + fn(cmd, &assessMigrationReq) + } + + return cmd +} + // start create-branch command // Slice with functions to override default command behavior. @@ -883,42 +1103,39 @@ func newCreateEndpoint() *cobra.Command { return cmd } -// start create-project command +// start create-migration command // Slice with functions to override default command behavior. // Functions can be added from the `init()` function in manually curated files in this directory. -var createProjectOverrides []func( +var createMigrationOverrides []func( *cobra.Command, - *postgres.CreateProjectRequest, + *postgres.CreateMigrationRequest, ) -func newCreateProject() *cobra.Command { +func newCreateMigration() *cobra.Command { cmd := &cobra.Command{} - var createProjectReq postgres.CreateProjectRequest - createProjectReq.Project = postgres.Project{} - var createProjectJson flags.JsonFlag + var createMigrationReq postgres.CreateMigrationRequest + createMigrationReq.Migration = postgres.Migration{} + var createMigrationJson flags.JsonFlag - var createProjectSkipWait bool - var createProjectTimeout time.Duration + var createMigrationSkipWait bool + var createMigrationTimeout time.Duration - cmd.Flags().BoolVar(&createProjectSkipWait, "no-wait", createProjectSkipWait, `do not wait to reach DONE state`) - cmd.Flags().DurationVar(&createProjectTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) + cmd.Flags().BoolVar(&createMigrationSkipWait, "no-wait", createMigrationSkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&createMigrationTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) - cmd.Flags().Var(&createProjectJson, "json", `either inline JSON string or @path/to/file.json with request body`) + cmd.Flags().Var(&createMigrationJson, "json", `either inline JSON string or @path/to/file.json with request body`) - // TODO: complex arg: initial_branch_spec - // TODO: complex arg: initial_endpoint_spec - cmd.Flags().StringVar(&createProjectReq.Project.Name, "name", createProjectReq.Project.Name, `Output only.`) - // TODO: complex arg: spec - // TODO: complex arg: status + // TODO: complex arg: error + cmd.Flags().StringVar(&createMigrationReq.Migration.Name, "name", createMigrationReq.Migration.Name, `The migration resource name, in the format migrations/{migration}.`) + cmd.Flags().StringVar(&createMigrationReq.Migration.TargetBranch, "target-branch", createMigrationReq.Migration.TargetBranch, `The Lakebase branch receiving the migrated databases, in the format projects/{project_id}/branches/{branch_id}.`) - cmd.Use = "create-project PROJECT_ID" - cmd.Short = `Create a Project.` - cmd.Long = `Create a Project. + cmd.Use = "create-migration MIGRATION_ID SOURCE_CONNECTION DATABASE_MAPPINGS MIGRATION_TYPE" + cmd.Short = `Create a migration.` + cmd.Long = `Create a migration. - Creates a new Lakebase Autoscaling Postgres database project, which contains - branches and compute endpoints. + Creates a migration. This is a long-running operation. By default, the command waits for the operation to complete. Use --no-wait to return immediately with the raw @@ -926,17 +1143,34 @@ func newCreateProject() *cobra.Command { completion using the get-operation command. Arguments: - PROJECT_ID: The ID to use for the Project. This becomes the final component of the - project's resource name. The ID is required and must be 1-63 characters - long, start with a lowercase letter, and contain only lowercase letters, - numbers, and hyphens. For example, my-app becomes projects/my-app.` + MIGRATION_ID: Required. The ID to use for the migration. It becomes the final component + of the resource name (migrations/{migration_id}). It must be 1-63 + characters long, start with a lowercase letter, and contain only lowercase + letters, numbers, and hyphens. + SOURCE_CONNECTION: Required. The name of the Unity Catalog connection (a UC securable name, + such as my_postgres_connection) used to connect to the source PostgreSQL + server. + DATABASE_MAPPINGS: Required. Mappings from source databases to target databases. + MIGRATION_TYPE: Required. Immutable. The intended migration mode, selected when the + migration is created. + Supported values: [MIGRATION_TYPE_ONE_TIME_COPY, MIGRATION_TYPE_ONLINE]` + + // This command is being previewed; hide from help output. + cmd.Hidden = true cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "GA" - cmd.Annotations["launch_stage_display"] = "GA" + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" cmd.Args = func(cmd *cobra.Command, args []string) error { - check := root.ExactArgs(1) + if cmd.Flags().Changed("json") { + err := root.ExactArgs(1)(cmd, args) + if err != nil { + return errors.New("when --json flag is specified, provide only MIGRATION_ID as positional arguments. Provide 'source_connection', 'database_mappings', 'migration_type' in your JSON input") + } + return nil + } + check := root.ExactArgs(4) return check(cmd, args) } @@ -946,7 +1180,7 @@ func newCreateProject() *cobra.Command { w := cmdctx.WorkspaceClient(ctx) if cmd.Flags().Changed("json") { - diags := createProjectJson.Unmarshal(&createProjectReq.Project) + diags := createMigrationJson.Unmarshal(&createMigrationReq.Migration) if diags.HasError() { return diags.Error() } @@ -957,12 +1191,29 @@ func newCreateProject() *cobra.Command { } } } - createProjectReq.ProjectId = args[0] + createMigrationReq.MigrationId = args[0] + if !cmd.Flags().Changed("json") { + createMigrationReq.Migration.SourceConnection = args[1] + } + if !cmd.Flags().Changed("json") { + _, err = fmt.Sscan(args[2], &createMigrationReq.Migration.DatabaseMappings) + if err != nil { + return fmt.Errorf("invalid DATABASE_MAPPINGS: %s", args[2]) + } + + } + if !cmd.Flags().Changed("json") { + _, err = fmt.Sscan(args[3], &createMigrationReq.Migration.MigrationType) + if err != nil { + return fmt.Errorf("invalid MIGRATION_TYPE: %s", args[3]) + } + + } // Determine which mode to execute based on flags. switch { - case createProjectSkipWait: - wait, err := w.Postgres.CreateProject(ctx, createProjectReq) + case createMigrationSkipWait: + wait, err := w.Postgres.CreateMigration(ctx, createMigrationReq) if err != nil { return err } @@ -977,17 +1228,17 @@ func newCreateProject() *cobra.Command { return cmdio.Render(ctx, operation) default: - wait, err := w.Postgres.CreateProject(ctx, createProjectReq) + wait, err := w.Postgres.CreateMigration(ctx, createMigrationReq) if err != nil { return err } // Show spinner while waiting for completion. sp := cmdio.NewSpinner(ctx) - sp.Update("Waiting for create-project to complete...") + sp.Update("Waiting for create-migration to complete...") // Wait for completion. - opts := api.WithTimeout(createProjectTimeout) + opts := api.WithTimeout(createMigrationTimeout) response, err := wait.Wait(ctx, opts) if err != nil { return err @@ -1002,45 +1253,171 @@ func newCreateProject() *cobra.Command { cmd.ValidArgsFunction = cobra.NoFileCompletions // Apply optional overrides to this command. - for _, fn := range createProjectOverrides { - fn(cmd, &createProjectReq) + for _, fn := range createMigrationOverrides { + fn(cmd, &createMigrationReq) } return cmd } -// start create-role command +// start create-project command // Slice with functions to override default command behavior. // Functions can be added from the `init()` function in manually curated files in this directory. -var createRoleOverrides []func( +var createProjectOverrides []func( *cobra.Command, - *postgres.CreateRoleRequest, + *postgres.CreateProjectRequest, ) -func newCreateRole() *cobra.Command { +func newCreateProject() *cobra.Command { cmd := &cobra.Command{} - var createRoleReq postgres.CreateRoleRequest - createRoleReq.Role = postgres.Role{} - var createRoleJson flags.JsonFlag + var createProjectReq postgres.CreateProjectRequest + createProjectReq.Project = postgres.Project{} + var createProjectJson flags.JsonFlag - var createRoleSkipWait bool - var createRoleTimeout time.Duration + var createProjectSkipWait bool + var createProjectTimeout time.Duration - cmd.Flags().BoolVar(&createRoleSkipWait, "no-wait", createRoleSkipWait, `do not wait to reach DONE state`) - cmd.Flags().DurationVar(&createRoleTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) + cmd.Flags().BoolVar(&createProjectSkipWait, "no-wait", createProjectSkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&createProjectTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) - cmd.Flags().Var(&createRoleJson, "json", `either inline JSON string or @path/to/file.json with request body`) + cmd.Flags().Var(&createProjectJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().BoolVar(&createRoleReq.ReplaceExisting, "replace-existing", createRoleReq.ReplaceExisting, `If true, update the role if it already exists instead of returning an error.`) - cmd.Flags().StringVar(&createRoleReq.RoleId, "role-id", createRoleReq.RoleId, `The ID to use for the Role, which will become the final component of the role's resource name.`) - cmd.Flags().StringVar(&createRoleReq.Role.Name, "name", createRoleReq.Role.Name, `Output only.`) + // TODO: complex arg: initial_branch_spec + // TODO: complex arg: initial_endpoint_spec + cmd.Flags().StringVar(&createProjectReq.Project.Name, "name", createProjectReq.Project.Name, `Output only.`) // TODO: complex arg: spec // TODO: complex arg: status - cmd.Use = "create-role PARENT" - cmd.Short = `Create a Postgres Role for a Branch.` + cmd.Use = "create-project PROJECT_ID" + cmd.Short = `Create a Project.` + cmd.Long = `Create a Project. + + Creates a new Lakebase Autoscaling Postgres database project, which contains + branches and compute endpoints. + + This is a long-running operation. By default, the command waits for the + operation to complete. Use --no-wait to return immediately with the raw + operation details. The operation's 'name' field can then be used to poll for + completion using the get-operation command. + + Arguments: + PROJECT_ID: The ID to use for the Project. This becomes the final component of the + project's resource name. The ID is required and must be 1-63 characters + long, start with a lowercase letter, and contain only lowercase letters, + numbers, and hyphens. For example, my-app becomes projects/my-app.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + if cmd.Flags().Changed("json") { + diags := createProjectJson.Unmarshal(&createProjectReq.Project) + if diags.HasError() { + return diags.Error() + } + if len(diags) > 0 { + err := cmdio.RenderDiagnostics(ctx, diags) + if err != nil { + return err + } + } + } + createProjectReq.ProjectId = args[0] + + // Determine which mode to execute based on flags. + switch { + case createProjectSkipWait: + wait, err := w.Postgres.CreateProject(ctx, createProjectReq) + if err != nil { + return err + } + + // Return operation immediately without waiting. + operation, err := w.Postgres.GetOperation(ctx, postgres.GetOperationRequest{ + Name: wait.Name(), + }) + if err != nil { + return err + } + return cmdio.Render(ctx, operation) + + default: + wait, err := w.Postgres.CreateProject(ctx, createProjectReq) + if err != nil { + return err + } + + // Show spinner while waiting for completion. + sp := cmdio.NewSpinner(ctx) + sp.Update("Waiting for create-project to complete...") + + // Wait for completion. + opts := api.WithTimeout(createProjectTimeout) + response, err := wait.Wait(ctx, opts) + if err != nil { + return err + } + sp.Close() + return cmdio.Render(ctx, response) + } + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range createProjectOverrides { + fn(cmd, &createProjectReq) + } + + return cmd +} + +// start create-role command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var createRoleOverrides []func( + *cobra.Command, + *postgres.CreateRoleRequest, +) + +func newCreateRole() *cobra.Command { + cmd := &cobra.Command{} + + var createRoleReq postgres.CreateRoleRequest + createRoleReq.Role = postgres.Role{} + var createRoleJson flags.JsonFlag + + var createRoleSkipWait bool + var createRoleTimeout time.Duration + + cmd.Flags().BoolVar(&createRoleSkipWait, "no-wait", createRoleSkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&createRoleTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) + + cmd.Flags().Var(&createRoleJson, "json", `either inline JSON string or @path/to/file.json with request body`) + + cmd.Flags().BoolVar(&createRoleReq.ReplaceExisting, "replace-existing", createRoleReq.ReplaceExisting, `If true, update the role if it already exists instead of returning an error.`) + cmd.Flags().StringVar(&createRoleReq.RoleId, "role-id", createRoleReq.RoleId, `The ID to use for the Role, which will become the final component of the role's resource name.`) + cmd.Flags().StringVar(&createRoleReq.Role.Name, "name", createRoleReq.Role.Name, `Output only.`) + // TODO: complex arg: spec + // TODO: complex arg: status + + cmd.Use = "create-role PARENT" + cmd.Short = `Create a Postgres Role for a Branch.` cmd.Long = `Create a Postgres Role for a Branch. Creates a new Postgres role in the branch. @@ -2005,6 +2382,110 @@ func newDeleteEndpoint() *cobra.Command { return cmd } +// start delete-migration command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var deleteMigrationOverrides []func( + *cobra.Command, + *postgres.DeleteMigrationRequest, +) + +func newDeleteMigration() *cobra.Command { + cmd := &cobra.Command{} + + var deleteMigrationReq postgres.DeleteMigrationRequest + + var deleteMigrationSkipWait bool + var deleteMigrationTimeout time.Duration + + cmd.Flags().BoolVar(&deleteMigrationSkipWait, "no-wait", deleteMigrationSkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&deleteMigrationTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) + + cmd.Use = "delete-migration NAME" + cmd.Short = `Delete a migration.` + cmd.Long = `Delete a migration. + + Soft-deletes a migration. + + This is a long-running operation. By default, the command waits for the + operation to complete. Use --no-wait to return immediately with the raw + operation details. The operation's 'name' field can then be used to poll for + completion using the get-operation command. + + Arguments: + NAME: Required. The migration resource name, in the format + migrations/{migration}.` + + // This command is being previewed; hide from help output. + cmd.Hidden = true + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + deleteMigrationReq.Name = args[0] + + // Determine which mode to execute based on flags. + switch { + case deleteMigrationSkipWait: + wait, err := w.Postgres.DeleteMigration(ctx, deleteMigrationReq) + if err != nil { + return err + } + + // Return operation immediately without waiting. + operation, err := w.Postgres.GetOperation(ctx, postgres.GetOperationRequest{ + Name: wait.Name(), + }) + if err != nil { + return err + } + return cmdio.Render(ctx, operation) + + default: + wait, err := w.Postgres.DeleteMigration(ctx, deleteMigrationReq) + if err != nil { + return err + } + + // Show spinner while waiting for completion. + sp := cmdio.NewSpinner(ctx) + sp.Update("Waiting for delete-migration to complete...") + + // Wait for completion. + opts := api.WithTimeout(deleteMigrationTimeout) + response, err := wait.Wait(ctx, opts) + if err != nil { + return err + } + sp.Close() + return cmdio.Render(ctx, response) + } + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range deleteMigrationOverrides { + fn(cmd, &deleteMigrationReq) + } + + return cmd +} + // start delete-project command // Slice with functions to override default command behavior. @@ -2526,33 +3007,36 @@ func newGenerateDatabaseCredential() *cobra.Command { return cmd } -// start get-branch command +// start get-assessment command // Slice with functions to override default command behavior. // Functions can be added from the `init()` function in manually curated files in this directory. -var getBranchOverrides []func( +var getAssessmentOverrides []func( *cobra.Command, - *postgres.GetBranchRequest, + *postgres.GetAssessmentRequest, ) -func newGetBranch() *cobra.Command { +func newGetAssessment() *cobra.Command { cmd := &cobra.Command{} - var getBranchReq postgres.GetBranchRequest + var getAssessmentReq postgres.GetAssessmentRequest - cmd.Use = "get-branch NAME" - cmd.Short = `Get a Branch.` - cmd.Long = `Get a Branch. + cmd.Use = "get-assessment NAME" + cmd.Short = `Get a migration assessment.` + cmd.Long = `Get a migration assessment. - Retrieves information about the specified database branch. + Gets a migration assessment run. Arguments: - NAME: The full resource path of the branch to retrieve. Format: - projects/{project_id}/branches/{branch_id}` + NAME: Required. The assessment resource name, in the format + migrations/{migration}/assessments/{assessment}.` + + // This command is being previewed; hide from help output. + cmd.Hidden = true cmd.Annotations = make(map[string]string) - cmd.Annotations["launch_stage"] = "GA" - cmd.Annotations["launch_stage_display"] = "GA" + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" cmd.Args = func(cmd *cobra.Command, args []string) error { check := root.ExactArgs(1) @@ -2564,9 +3048,9 @@ func newGetBranch() *cobra.Command { ctx := cmd.Context() w := cmdctx.WorkspaceClient(ctx) - getBranchReq.Name = args[0] + getAssessmentReq.Name = args[0] - response, err := w.Postgres.GetBranch(ctx, getBranchReq) + response, err := w.Postgres.GetAssessment(ctx, getAssessmentReq) if err != nil { return err } @@ -2579,35 +3063,36 @@ func newGetBranch() *cobra.Command { cmd.ValidArgsFunction = cobra.NoFileCompletions // Apply optional overrides to this command. - for _, fn := range getBranchOverrides { - fn(cmd, &getBranchReq) + for _, fn := range getAssessmentOverrides { + fn(cmd, &getAssessmentReq) } return cmd } -// start get-catalog command +// start get-branch command // Slice with functions to override default command behavior. // Functions can be added from the `init()` function in manually curated files in this directory. -var getCatalogOverrides []func( +var getBranchOverrides []func( *cobra.Command, - *postgres.GetCatalogRequest, + *postgres.GetBranchRequest, ) -func newGetCatalog() *cobra.Command { +func newGetBranch() *cobra.Command { cmd := &cobra.Command{} - var getCatalogReq postgres.GetCatalogRequest + var getBranchReq postgres.GetBranchRequest - cmd.Use = "get-catalog NAME" - cmd.Short = `Get a Database Catalog.` - cmd.Long = `Get a Database Catalog. + cmd.Use = "get-branch NAME" + cmd.Short = `Get a Branch.` + cmd.Long = `Get a Branch. - Arguments: - NAME: The full resource path of the catalog to retrieve. + Retrieves information about the specified database branch. - Format: "catalogs/{catalog_id}".` + Arguments: + NAME: The full resource path of the branch to retrieve. Format: + projects/{project_id}/branches/{branch_id}` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2623,7 +3108,66 @@ func newGetCatalog() *cobra.Command { ctx := cmd.Context() w := cmdctx.WorkspaceClient(ctx) - getCatalogReq.Name = args[0] + getBranchReq.Name = args[0] + + response, err := w.Postgres.GetBranch(ctx, getBranchReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range getBranchOverrides { + fn(cmd, &getBranchReq) + } + + return cmd +} + +// start get-catalog command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var getCatalogOverrides []func( + *cobra.Command, + *postgres.GetCatalogRequest, +) + +func newGetCatalog() *cobra.Command { + cmd := &cobra.Command{} + + var getCatalogReq postgres.GetCatalogRequest + + cmd.Use = "get-catalog NAME" + cmd.Short = `Get a Database Catalog.` + cmd.Long = `Get a Database Catalog. + + Arguments: + NAME: The full resource path of the catalog to retrieve. + + Format: "catalogs/{catalog_id}".` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "GA" + cmd.Annotations["launch_stage_display"] = "GA" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + getCatalogReq.Name = args[0] response, err := w.Postgres.GetCatalog(ctx, getCatalogReq) if err != nil { @@ -2953,6 +3497,69 @@ func newGetEndpoint() *cobra.Command { return cmd } +// start get-migration command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var getMigrationOverrides []func( + *cobra.Command, + *postgres.GetMigrationRequest, +) + +func newGetMigration() *cobra.Command { + cmd := &cobra.Command{} + + var getMigrationReq postgres.GetMigrationRequest + + cmd.Use = "get-migration NAME" + cmd.Short = `Get a migration.` + cmd.Long = `Get a migration. + + Gets a migration. + + Arguments: + NAME: Required. The migration resource name, in the format + migrations/{migration}.` + + // This command is being previewed; hide from help output. + cmd.Hidden = true + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + getMigrationReq.Name = args[0] + + response, err := w.Postgres.GetMigration(ctx, getMigrationReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range getMigrationOverrides { + fn(cmd, &getMigrationReq) + } + + return cmd +} + // start get-operation command // Slice with functions to override default command behavior. @@ -3315,6 +3922,85 @@ func newGetSyncedTable() *cobra.Command { return cmd } +// start list-assessments command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var listAssessmentsOverrides []func( + *cobra.Command, + *postgres.ListAssessmentsRequest, +) + +func newListAssessments() *cobra.Command { + cmd := &cobra.Command{} + + var listAssessmentsReq postgres.ListAssessmentsRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listAssessmentsLimit int + + cmd.Flags().IntVar(&listAssessmentsReq.PageSize, "page-size", listAssessmentsReq.PageSize, `The maximum number of assessments to return.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listAssessmentsLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listAssessmentsReq.PageToken, "page-token", listAssessmentsReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list-assessments PARENT" + cmd.Short = `List migration assessments.` + cmd.Long = `List migration assessments. + + Lists assessment runs for a migration. + + Arguments: + PARENT: Required. The parent migration resource name, in the format + migrations/{migration}.` + + // This command is being previewed; hide from help output. + cmd.Hidden = true + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + listAssessmentsReq.Parent = args[0] + + response := w.Postgres.ListAssessments(ctx, listAssessmentsReq) + if listAssessmentsLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listAssessmentsLimit) + } + if listAssessmentsLimit > 0 { + ctx = cmdio.WithLimit(ctx, listAssessmentsLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range listAssessmentsOverrides { + fn(cmd, &listAssessmentsReq) + } + + return cmd +} + // start list-branches command // Slice with functions to override default command behavior. @@ -3704,6 +4390,80 @@ func newListEndpoints() *cobra.Command { return cmd } +// start list-migrations command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var listMigrationsOverrides []func( + *cobra.Command, + *postgres.ListMigrationsRequest, +) + +func newListMigrations() *cobra.Command { + cmd := &cobra.Command{} + + var listMigrationsReq postgres.ListMigrationsRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listMigrationsLimit int + + cmd.Flags().IntVar(&listMigrationsReq.PageSize, "page-size", listMigrationsReq.PageSize, `The maximum number of migrations to return.`) + cmd.Flags().BoolVar(&listMigrationsReq.ShowDeleted, "show-deleted", listMigrationsReq.ShowDeleted, `Whether to include soft-deleted migrations in the response.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listMigrationsLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listMigrationsReq.PageToken, "page-token", listMigrationsReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list-migrations" + cmd.Short = `List migrations.` + cmd.Long = `List migrations. + + Lists migrations in the workspace.` + + // This command is being previewed; hide from help output. + cmd.Hidden = true + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(0) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + response := w.Postgres.ListMigrations(ctx, listMigrationsReq) + if listMigrationsLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listMigrationsLimit) + } + if listMigrationsLimit > 0 { + ctx = cmdio.WithLimit(ctx, listMigrationsLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range listMigrationsOverrides { + fn(cmd, &listMigrationsReq) + } + + return cmd +} + // start list-projects command // Slice with functions to override default command behavior. @@ -3990,6 +4750,113 @@ func newRevealRolePassword() *cobra.Command { return cmd } +// start start-migration command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var startMigrationOverrides []func( + *cobra.Command, + *postgres.StartMigrationRequest, +) + +func newStartMigration() *cobra.Command { + cmd := &cobra.Command{} + + var startMigrationReq postgres.StartMigrationRequest + + var startMigrationSkipWait bool + var startMigrationTimeout time.Duration + + cmd.Flags().BoolVar(&startMigrationSkipWait, "no-wait", startMigrationSkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&startMigrationTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) + + cmd.Use = "start-migration NAME" + cmd.Short = `Start a migration.` + cmd.Long = `Start a migration. + + Starts the assessed migration named in the request, moving it from + READY_TO_START into execution. Its first phase, SCHEMA_LOAD, creates the + target databases, roles, and schema on the migration's target Lakebase branch + without copying any table data, ahead of INITIAL_DATA_LOAD. + + This is a long-running operation. By default, the command waits for the + operation to complete. Use --no-wait to return immediately with the raw + operation details. The operation's 'name' field can then be used to poll for + completion using the get-operation command. + + Arguments: + NAME: Required. The migration resource name, in the format + migrations/{migration}.` + + // This command is being previewed; hide from help output. + cmd.Hidden = true + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + startMigrationReq.Name = args[0] + + // Determine which mode to execute based on flags. + switch { + case startMigrationSkipWait: + wait, err := w.Postgres.StartMigration(ctx, startMigrationReq) + if err != nil { + return err + } + + // Return operation immediately without waiting. + operation, err := w.Postgres.GetOperation(ctx, postgres.GetOperationRequest{ + Name: wait.Name(), + }) + if err != nil { + return err + } + return cmdio.Render(ctx, operation) + + default: + wait, err := w.Postgres.StartMigration(ctx, startMigrationReq) + if err != nil { + return err + } + + // Show spinner while waiting for completion. + sp := cmdio.NewSpinner(ctx) + sp.Update("Waiting for start-migration to complete...") + + // Wait for completion. + opts := api.WithTimeout(startMigrationTimeout) + response, err := wait.Wait(ctx, opts) + if err != nil { + return err + } + sp.Close() + return cmdio.Render(ctx, response) + } + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range startMigrationOverrides { + fn(cmd, &startMigrationReq) + } + + return cmd +} + // start undelete-branch command // Slice with functions to override default command behavior. @@ -4095,6 +4962,110 @@ func newUndeleteBranch() *cobra.Command { return cmd } +// start undelete-migration command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var undeleteMigrationOverrides []func( + *cobra.Command, + *postgres.UndeleteMigrationRequest, +) + +func newUndeleteMigration() *cobra.Command { + cmd := &cobra.Command{} + + var undeleteMigrationReq postgres.UndeleteMigrationRequest + + var undeleteMigrationSkipWait bool + var undeleteMigrationTimeout time.Duration + + cmd.Flags().BoolVar(&undeleteMigrationSkipWait, "no-wait", undeleteMigrationSkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&undeleteMigrationTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) + + cmd.Use = "undelete-migration NAME" + cmd.Short = `Undelete a migration.` + cmd.Long = `Undelete a migration. + + Restores a soft-deleted migration before it is permanently purged. + + This is a long-running operation. By default, the command waits for the + operation to complete. Use --no-wait to return immediately with the raw + operation details. The operation's 'name' field can then be used to poll for + completion using the get-operation command. + + Arguments: + NAME: Required. The migration resource name, in the format + migrations/{migration}.` + + // This command is being previewed; hide from help output. + cmd.Hidden = true + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + undeleteMigrationReq.Name = args[0] + + // Determine which mode to execute based on flags. + switch { + case undeleteMigrationSkipWait: + wait, err := w.Postgres.UndeleteMigration(ctx, undeleteMigrationReq) + if err != nil { + return err + } + + // Return operation immediately without waiting. + operation, err := w.Postgres.GetOperation(ctx, postgres.GetOperationRequest{ + Name: wait.Name(), + }) + if err != nil { + return err + } + return cmdio.Render(ctx, operation) + + default: + wait, err := w.Postgres.UndeleteMigration(ctx, undeleteMigrationReq) + if err != nil { + return err + } + + // Show spinner while waiting for completion. + sp := cmdio.NewSpinner(ctx) + sp.Update("Waiting for undelete-migration to complete...") + + // Wait for completion. + opts := api.WithTimeout(undeleteMigrationTimeout) + response, err := wait.Wait(ctx, opts) + if err != nil { + return err + } + sp.Close() + return cmdio.Render(ctx, response) + } + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range undeleteMigrationOverrides { + fn(cmd, &undeleteMigrationReq) + } + + return cmd +} + // start undelete-project command // Slice with functions to override default command behavior. @@ -4706,6 +5677,165 @@ func newUpdateEndpoint() *cobra.Command { return cmd } +// start update-migration command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var updateMigrationOverrides []func( + *cobra.Command, + *postgres.UpdateMigrationRequest, +) + +func newUpdateMigration() *cobra.Command { + cmd := &cobra.Command{} + + var updateMigrationReq postgres.UpdateMigrationRequest + updateMigrationReq.Migration = postgres.Migration{} + var updateMigrationJson flags.JsonFlag + + var updateMigrationSkipWait bool + var updateMigrationTimeout time.Duration + + cmd.Flags().BoolVar(&updateMigrationSkipWait, "no-wait", updateMigrationSkipWait, `do not wait to reach DONE state`) + cmd.Flags().DurationVar(&updateMigrationTimeout, "timeout", 0, `maximum amount of time to reach DONE state`) + + cmd.Flags().Var(&updateMigrationJson, "json", `either inline JSON string or @path/to/file.json with request body`) + + // TODO: complex arg: error + cmd.Flags().StringVar(&updateMigrationReq.Migration.Name, "name", updateMigrationReq.Migration.Name, `The migration resource name, in the format migrations/{migration}.`) + cmd.Flags().StringVar(&updateMigrationReq.Migration.TargetBranch, "target-branch", updateMigrationReq.Migration.TargetBranch, `The Lakebase branch receiving the migrated databases, in the format projects/{project_id}/branches/{branch_id}.`) + + cmd.Use = "update-migration NAME UPDATE_MASK SOURCE_CONNECTION DATABASE_MAPPINGS MIGRATION_TYPE" + cmd.Short = `Update a migration.` + cmd.Long = `Update a migration. + + Updates user-owned migration configuration. + + This is a long-running operation. By default, the command waits for the + operation to complete. Use --no-wait to return immediately with the raw + operation details. The operation's 'name' field can then be used to poll for + completion using the get-operation command. + + Arguments: + NAME: The migration resource name, in the format migrations/{migration}. + UPDATE_MASK: Required. The fields to update. + SOURCE_CONNECTION: Required. The name of the Unity Catalog connection (a UC securable name, + such as my_postgres_connection) used to connect to the source PostgreSQL + server. + DATABASE_MAPPINGS: Required. Mappings from source databases to target databases. + MIGRATION_TYPE: Required. Immutable. The intended migration mode, selected when the + migration is created. + Supported values: [MIGRATION_TYPE_ONE_TIME_COPY, MIGRATION_TYPE_ONLINE]` + + // This command is being previewed; hide from help output. + cmd.Hidden = true + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + if cmd.Flags().Changed("json") { + err := root.ExactArgs(2)(cmd, args) + if err != nil { + return errors.New("when --json flag is specified, provide only NAME, UPDATE_MASK as positional arguments. Provide 'source_connection', 'database_mappings', 'migration_type' in your JSON input") + } + return nil + } + check := root.ExactArgs(5) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + if cmd.Flags().Changed("json") { + diags := updateMigrationJson.Unmarshal(&updateMigrationReq.Migration) + if diags.HasError() { + return diags.Error() + } + if len(diags) > 0 { + err := cmdio.RenderDiagnostics(ctx, diags) + if err != nil { + return err + } + } + } + updateMigrationReq.Name = args[0] + if args[1] != "" { + updateMaskArray := strings.Split(args[1], ",") + updateMigrationReq.UpdateMask = *fieldmask.New(updateMaskArray) + } + if !cmd.Flags().Changed("json") { + updateMigrationReq.Migration.SourceConnection = args[2] + } + if !cmd.Flags().Changed("json") { + _, err = fmt.Sscan(args[3], &updateMigrationReq.Migration.DatabaseMappings) + if err != nil { + return fmt.Errorf("invalid DATABASE_MAPPINGS: %s", args[3]) + } + + } + if !cmd.Flags().Changed("json") { + _, err = fmt.Sscan(args[4], &updateMigrationReq.Migration.MigrationType) + if err != nil { + return fmt.Errorf("invalid MIGRATION_TYPE: %s", args[4]) + } + + } + + // Determine which mode to execute based on flags. + switch { + case updateMigrationSkipWait: + wait, err := w.Postgres.UpdateMigration(ctx, updateMigrationReq) + if err != nil { + return err + } + + // Return operation immediately without waiting. + operation, err := w.Postgres.GetOperation(ctx, postgres.GetOperationRequest{ + Name: wait.Name(), + }) + if err != nil { + return err + } + return cmdio.Render(ctx, operation) + + default: + wait, err := w.Postgres.UpdateMigration(ctx, updateMigrationReq) + if err != nil { + return err + } + + // Show spinner while waiting for completion. + sp := cmdio.NewSpinner(ctx) + sp.Update("Waiting for update-migration to complete...") + + // Wait for completion. + opts := api.WithTimeout(updateMigrationTimeout) + response, err := wait.Wait(ctx, opts) + if err != nil { + return err + } + sp.Close() + return cmdio.Render(ctx, response) + } + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range updateMigrationOverrides { + fn(cmd, &updateMigrationReq) + } + + return cmd +} + // start update-project command // Slice with functions to override default command behavior. @@ -4887,16 +6017,14 @@ func newUpdateRole() *cobra.Command { spec.attributes.createrole, and spec.attributes.bypassrls. spec.identity_type, spec.auth_method, and spec.postgres_role cannot - be changed. Values supplied for these fields in the request body are - ignored. Including one of these fields as an explicit path in update_mask - returns an INVALID_PARAMETER_VALUE error. When spec is the only path in - the mask, only the supplied mutable attributes are updated. * by itself, - or spec combined with other supported paths, selects all supported - mutable fields. For these masks, all three attributes (createdb, - createrole, and bypassrls) must be supplied; omitting any returns an - INVALID_PARAMETER_VALUE error. Each of these mask forms replaces - membership_roles. Omitting it or supplying an empty list clears all - memberships, including DATABRICKS_SUPERUSER.` + be changed. Including an immutable field as an explicit path in + update_mask returns INVALID_PARAMETER_VALUE. With * or masks containing + only mutable fields, supplied values for these immutable fields are + ignored. * by itself selects all supported mutable fields. For this + mask, all three attributes (createdb, createrole, and bypassrls) + must be supplied; omitting any returns an INVALID_PARAMETER_VALUE error. + The * mask replaces membership_roles. Omitting it or supplying an + empty list clears all memberships, including DATABRICKS_SUPERUSER.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/serverless-compute-service/serverless-compute-service.go b/cmd/workspace/serverless-compute-service/serverless-compute-service.go new file mode 100644 index 00000000000..09789adec60 --- /dev/null +++ b/cmd/workspace/serverless-compute-service/serverless-compute-service.go @@ -0,0 +1,190 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package serverless_compute_service + +import ( + "fmt" + + "github.com/databricks/cli/cmd/root" + "github.com/databricks/cli/libs/cmdctx" + "github.com/databricks/cli/libs/cmdio" + "github.com/databricks/databricks-sdk-go/service/compute" + "github.com/spf13/cobra" +) + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var cmdOverrides []func(*cobra.Command) + +func New() *cobra.Command { + cmd := &cobra.Command{ + Use: "serverless-compute-service", + Short: `ServerlessCompute Service API.`, + Long: `ServerlessCompute Service API.`, + GroupID: "compute", + + // This service is being previewed; hide from help output. + Hidden: true, + RunE: root.ReportUnknownSubcommand, + } + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + // Add methods + cmd.AddCommand(newList()) + cmd.AddCommand(newListComputePolicies()) + + // Apply optional overrides to this command. + for _, fn := range cmdOverrides { + fn(cmd) + } + + return cmd +} + +// start list command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var listOverrides []func( + *cobra.Command, + *compute.ListServerlessComputesRequest, +) + +func newList() *cobra.Command { + cmd := &cobra.Command{} + + var listReq compute.ListServerlessComputesRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listLimit int + + cmd.Flags().IntVar(&listReq.PageSize, "page-size", listReq.PageSize, `Maximum number of computes to return per response.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listReq.PageToken, "page-token", listReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list" + cmd.Short = `List serverless computes.` + cmd.Long = `List serverless computes. + + Lists Interactive serverless computes that the caller can use or manage. + Results are returned in an unspecified order.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(0) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + response := w.ServerlessComputeService.List(ctx, listReq) + if listLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listLimit) + } + if listLimit > 0 { + ctx = cmdio.WithLimit(ctx, listLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range listOverrides { + fn(cmd, &listReq) + } + + return cmd +} + +// start list-compute-policies command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var listComputePoliciesOverrides []func( + *cobra.Command, + *compute.ListComputePoliciesRequest, +) + +func newListComputePolicies() *cobra.Command { + cmd := &cobra.Command{} + + var listComputePoliciesReq compute.ListComputePoliciesRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listComputePoliciesLimit int + + cmd.Flags().IntVar(&listComputePoliciesReq.PageSize, "page-size", listComputePoliciesReq.PageSize, `Maximum number of policies to return per response.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listComputePoliciesLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listComputePoliciesReq.PageToken, "page-token", listComputePoliciesReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list-compute-policies" + cmd.Short = `List compute policies.` + cmd.Long = `List compute policies. + + Lists compute policies in the workspace. Results are returned in an + unspecified order; callers should sort client-side if a specific order is + needed.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PRIVATE_PREVIEW" + cmd.Annotations["launch_stage_display"] = "Private Preview" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(0) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + response := w.ServerlessComputeService.ListComputePolicies(ctx, listComputePoliciesReq) + if listComputePoliciesLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listComputePoliciesLimit) + } + if listComputePoliciesLimit > 0 { + ctx = cmdio.WithLimit(ctx, listComputePoliciesLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range listComputePoliciesOverrides { + fn(cmd, &listComputePoliciesReq) + } + + return cmd +} + +// end service ServerlessComputeService diff --git a/cmd/workspace/software-artifacts/software-artifacts.go b/cmd/workspace/software-artifacts/software-artifacts.go new file mode 100644 index 00000000000..72351e1a7d1 --- /dev/null +++ b/cmd/workspace/software-artifacts/software-artifacts.go @@ -0,0 +1,512 @@ +// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT. + +package software_artifacts + +import ( + "errors" + "fmt" + "strings" + + "github.com/databricks/cli/cmd/root" + "github.com/databricks/cli/libs/cmdctx" + "github.com/databricks/cli/libs/cmdio" + "github.com/databricks/cli/libs/flags" + "github.com/databricks/databricks-sdk-go/common/types/fieldmask" + "github.com/databricks/databricks-sdk-go/service/softwareartifacts" + "github.com/spf13/cobra" +) + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var cmdOverrides []func(*cobra.Command) + +func New() *cobra.Command { + cmd := &cobra.Command{ + Use: "software-artifacts", + Short: `*Beta* Manage software artifacts and their versions in Unity Catalog.`, + Long: `This command is in Beta and may change without notice. + +Manage software artifacts and their versions in Unity Catalog.`, + GroupID: "catalog", + RunE: root.ReportUnknownSubcommand, + } + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + // Add methods + cmd.AddCommand(newGetSoftwareArtifact()) + cmd.AddCommand(newGetSoftwareArtifactVersion()) + cmd.AddCommand(newListSoftwareArtifactVersions()) + cmd.AddCommand(newListSoftwareArtifacts()) + cmd.AddCommand(newResolveSoftwareArtifactVersion()) + cmd.AddCommand(newUpdateSoftwareArtifact()) + + // Apply optional overrides to this command. + for _, fn := range cmdOverrides { + fn(cmd) + } + + return cmd +} + +// start get-software-artifact command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var getSoftwareArtifactOverrides []func( + *cobra.Command, + *softwareartifacts.GetSoftwareArtifactRequest, +) + +func newGetSoftwareArtifact() *cobra.Command { + cmd := &cobra.Command{} + + var getSoftwareArtifactReq softwareartifacts.GetSoftwareArtifactRequest + + cmd.Use = "get-software-artifact NAME" + cmd.Short = `*Beta* .` + cmd.Long = `This command is in Beta and may change without notice. + +. + + Gets a software artifact. + + Arguments: + NAME: Resource name of the artifact, of the form + software-artifacts/{catalog}.{schema}.{artifact}.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + getSoftwareArtifactReq.Name = args[0] + + response, err := w.SoftwareArtifacts.GetSoftwareArtifact(ctx, getSoftwareArtifactReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range getSoftwareArtifactOverrides { + fn(cmd, &getSoftwareArtifactReq) + } + + return cmd +} + +// start get-software-artifact-version command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var getSoftwareArtifactVersionOverrides []func( + *cobra.Command, + *softwareartifacts.GetSoftwareArtifactVersionRequest, +) + +func newGetSoftwareArtifactVersion() *cobra.Command { + cmd := &cobra.Command{} + + var getSoftwareArtifactVersionReq softwareartifacts.GetSoftwareArtifactVersionRequest + + cmd.Use = "get-software-artifact-version NAME" + cmd.Short = `*Beta* .` + cmd.Long = `This command is in Beta and may change without notice. + +. + + Gets a software artifact version. + + Arguments: + NAME: Resource name of the version, of the form + software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + getSoftwareArtifactVersionReq.Name = args[0] + + response, err := w.SoftwareArtifacts.GetSoftwareArtifactVersion(ctx, getSoftwareArtifactVersionReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range getSoftwareArtifactVersionOverrides { + fn(cmd, &getSoftwareArtifactVersionReq) + } + + return cmd +} + +// start list-software-artifact-versions command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var listSoftwareArtifactVersionsOverrides []func( + *cobra.Command, + *softwareartifacts.ListSoftwareArtifactVersionsRequest, +) + +func newListSoftwareArtifactVersions() *cobra.Command { + cmd := &cobra.Command{} + + var listSoftwareArtifactVersionsReq softwareartifacts.ListSoftwareArtifactVersionsRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listSoftwareArtifactVersionsLimit int + + cmd.Flags().IntVar(&listSoftwareArtifactVersionsReq.PageSize, "page-size", listSoftwareArtifactVersionsReq.PageSize, `Maximum number of versions to return.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listSoftwareArtifactVersionsLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listSoftwareArtifactVersionsReq.PageToken, "page-token", listSoftwareArtifactVersionsReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list-software-artifact-versions PARENT" + cmd.Short = `*Beta* .` + cmd.Long = `This command is in Beta and may change without notice. + +. + + Lists the versions of a software artifact. + + Arguments: + PARENT: Resource name of the parent artifact, of the form + software-artifacts/{catalog}.{schema}.{artifact}.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + listSoftwareArtifactVersionsReq.Parent = args[0] + + response := w.SoftwareArtifacts.ListSoftwareArtifactVersions(ctx, listSoftwareArtifactVersionsReq) + if listSoftwareArtifactVersionsLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listSoftwareArtifactVersionsLimit) + } + if listSoftwareArtifactVersionsLimit > 0 { + ctx = cmdio.WithLimit(ctx, listSoftwareArtifactVersionsLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range listSoftwareArtifactVersionsOverrides { + fn(cmd, &listSoftwareArtifactVersionsReq) + } + + return cmd +} + +// start list-software-artifacts command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var listSoftwareArtifactsOverrides []func( + *cobra.Command, + *softwareartifacts.ListSoftwareArtifactsRequest, +) + +func newListSoftwareArtifacts() *cobra.Command { + cmd := &cobra.Command{} + + var listSoftwareArtifactsReq softwareartifacts.ListSoftwareArtifactsRequest + // Registered for all paginated methods. Validated at call time in the + // method-call template. Paginated list methods never have Wait or LRO + // branches, so the method-call path is always reached. + var listSoftwareArtifactsLimit int + + cmd.Flags().IntVar(&listSoftwareArtifactsReq.PageSize, "page-size", listSoftwareArtifactsReq.PageSize, `Maximum number of software artifacts to return.`) + + // Limit flag for total result capping. + cmd.Flags().IntVar(&listSoftwareArtifactsLimit, "limit", 0, `Maximum number of results to return.`) + + // Hidden pagination flags (internal API parameters). + cmd.Flags().StringVar(&listSoftwareArtifactsReq.PageToken, "page-token", listSoftwareArtifactsReq.PageToken, `Pagination token.`) + cmd.Flags().Lookup("page-token").Hidden = true + + cmd.Use = "list-software-artifacts PARENT" + cmd.Short = `*Beta* .` + cmd.Long = `This command is in Beta and may change without notice. + +. + + Lists software artifacts in a schema. + + Arguments: + PARENT: Resource name of the parent schema, of the form + schemas/{catalog}.{schema}.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(1) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + listSoftwareArtifactsReq.Parent = args[0] + + response := w.SoftwareArtifacts.ListSoftwareArtifacts(ctx, listSoftwareArtifactsReq) + if listSoftwareArtifactsLimit < 0 { + return fmt.Errorf("--limit must be a non-negative integer, got %d", listSoftwareArtifactsLimit) + } + if listSoftwareArtifactsLimit > 0 { + ctx = cmdio.WithLimit(ctx, listSoftwareArtifactsLimit) + } + + return cmdio.RenderIterator(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range listSoftwareArtifactsOverrides { + fn(cmd, &listSoftwareArtifactsReq) + } + + return cmd +} + +// start resolve-software-artifact-version command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var resolveSoftwareArtifactVersionOverrides []func( + *cobra.Command, + *softwareartifacts.ResolveSoftwareArtifactVersionRequest, +) + +func newResolveSoftwareArtifactVersion() *cobra.Command { + cmd := &cobra.Command{} + + var resolveSoftwareArtifactVersionReq softwareartifacts.ResolveSoftwareArtifactVersionRequest + var resolveSoftwareArtifactVersionJson flags.JsonFlag + + cmd.Flags().Var(&resolveSoftwareArtifactVersionJson, "json", `either inline JSON string or @path/to/file.json with request body`) + + cmd.Use = "resolve-software-artifact-version PARENT ALIAS" + cmd.Short = `*Beta* .` + cmd.Long = `This command is in Beta and may change without notice. + +. + + Resolves a software artifact version from its tag alias. + + Arguments: + PARENT: Resource name of the software artifact containing the alias. + ALIAS: Image tag alias selecting the version.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + if cmd.Flags().Changed("json") { + err := root.ExactArgs(1)(cmd, args) + if err != nil { + return errors.New("when --json flag is specified, provide only PARENT as positional arguments. Provide 'alias' in your JSON input") + } + return nil + } + check := root.ExactArgs(2) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + if cmd.Flags().Changed("json") { + diags := resolveSoftwareArtifactVersionJson.Unmarshal(&resolveSoftwareArtifactVersionReq) + if diags.HasError() { + return diags.Error() + } + if len(diags) > 0 { + err := cmdio.RenderDiagnostics(ctx, diags) + if err != nil { + return err + } + } + } + resolveSoftwareArtifactVersionReq.Parent = args[0] + if !cmd.Flags().Changed("json") { + resolveSoftwareArtifactVersionReq.Alias = args[1] + } + + response, err := w.SoftwareArtifacts.ResolveSoftwareArtifactVersion(ctx, resolveSoftwareArtifactVersionReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range resolveSoftwareArtifactVersionOverrides { + fn(cmd, &resolveSoftwareArtifactVersionReq) + } + + return cmd +} + +// start update-software-artifact command + +// Slice with functions to override default command behavior. +// Functions can be added from the `init()` function in manually curated files in this directory. +var updateSoftwareArtifactOverrides []func( + *cobra.Command, + *softwareartifacts.UpdateSoftwareArtifactRequest, +) + +func newUpdateSoftwareArtifact() *cobra.Command { + cmd := &cobra.Command{} + + var updateSoftwareArtifactReq softwareartifacts.UpdateSoftwareArtifactRequest + updateSoftwareArtifactReq.SoftwareArtifact = softwareartifacts.SoftwareArtifact{} + var updateSoftwareArtifactJson flags.JsonFlag + + cmd.Flags().Var(&updateSoftwareArtifactJson, "json", `either inline JSON string or @path/to/file.json with request body`) + + cmd.Flags().StringVar(&updateSoftwareArtifactReq.SoftwareArtifact.Name, "name", updateSoftwareArtifactReq.SoftwareArtifact.Name, `Resource name of the artifact, of the form software-artifacts/{catalog}.{schema}.{artifact}.`) + cmd.Flags().StringVar(&updateSoftwareArtifactReq.SoftwareArtifact.Owner, "owner", updateSoftwareArtifactReq.SoftwareArtifact.Owner, `Principal name (a user, service principal, or group) that owns this artifact.`) + + cmd.Use = "update-software-artifact NAME UPDATE_MASK" + cmd.Short = `*Beta* .` + cmd.Long = `This command is in Beta and may change without notice. + +. + + Updates a software artifact. The name is immutable; only the owner may be + changed. The destination owner must exist in the account. The caller needs + MANAGE_ACCESS_CONTROL on the artifact. The response contains its name and the + requested owner; audit fields are omitted. + + Arguments: + NAME: Resource name of the artifact, of the form + software-artifacts/{catalog}.{schema}.{artifact}. + UPDATE_MASK: Fields to update, relative to software_artifact. Accepts owner or *; + owner is the only mutable field, so both select the same update. + Output-only values in the resource are ignored.` + + cmd.Annotations = make(map[string]string) + cmd.Annotations["launch_stage"] = "PUBLIC_BETA" + cmd.Annotations["launch_stage_display"] = "Beta" + + cmd.Args = func(cmd *cobra.Command, args []string) error { + check := root.ExactArgs(2) + return check(cmd, args) + } + + cmd.PreRunE = root.MustWorkspaceClient + cmd.RunE = func(cmd *cobra.Command, args []string) (err error) { + ctx := cmd.Context() + w := cmdctx.WorkspaceClient(ctx) + + if cmd.Flags().Changed("json") { + diags := updateSoftwareArtifactJson.Unmarshal(&updateSoftwareArtifactReq.SoftwareArtifact) + if diags.HasError() { + return diags.Error() + } + if len(diags) > 0 { + err := cmdio.RenderDiagnostics(ctx, diags) + if err != nil { + return err + } + } + } + updateSoftwareArtifactReq.Name = args[0] + if args[1] != "" { + updateMaskArray := strings.Split(args[1], ",") + updateSoftwareArtifactReq.UpdateMask = *fieldmask.New(updateMaskArray) + } + + response, err := w.SoftwareArtifacts.UpdateSoftwareArtifact(ctx, updateSoftwareArtifactReq) + if err != nil { + return err + } + + return cmdio.Render(ctx, response) + } + + // Disable completions since they are not applicable. + // Can be overridden by manual implementation in `override.go`. + cmd.ValidArgsFunction = cobra.NoFileCompletions + + // Apply optional overrides to this command. + for _, fn := range updateSoftwareArtifactOverrides { + fn(cmd, &updateSoftwareArtifactReq) + } + + return cmd +} + +// end service SoftwareArtifacts diff --git a/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go b/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go index 6b870b4686a..b6f841ca75b 100644 --- a/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go +++ b/cmd/workspace/workspace-iam-v2/workspace-iam-v2.go @@ -101,18 +101,22 @@ func newCreateDirectGroupMemberProxy() *cobra.Command { cmd.Flags().Var(&createDirectGroupMemberProxyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createDirectGroupMemberProxyReq.DirectGroupMember.Name, "name", createDirectGroupMemberProxyReq.DirectGroupMember.Name, `The resource name of the group membership.`) + cmd.Flags().StringVar(&createDirectGroupMemberProxyReq.DirectGroupMember.Name, "name", createDirectGroupMemberProxyReq.DirectGroupMember.Name, `The resource name of the membership, in one of these formats: - Account APIs: accounts/{account_id}/groups/{group_id}/direct-members/{principal_id} - Workspace APIs: groups/{group_id}/direct-members/{principal_id}.`) cmd.Use = "create-direct-group-member-proxy PARENT PRINCIPAL_ID" cmd.Short = `Create a direct group membership.` cmd.Long = `Create a direct group membership. - Creates a group membership (assigns a principal to a group). + Adds a user, service principal, or group as a direct member of a group in the + account that contains this workspace. + + If automatic identity management is on and the group has an external_id, its + members come from your identity provider and can't be changed in Databricks. Arguments: - PARENT: The parent resource name of the group to add the member to. Format: - groups/{group_id} - PRINCIPAL_ID: Internal ID of the principal in Databricks.` + PARENT: The resource name of the group to add the member to, in the format + groups/{group_id}. + PRINCIPAL_ID: The Databricks ID of the member.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -194,24 +198,21 @@ func newCreateGroupProxy() *cobra.Command { cmd.Flags().Var(&createGroupProxyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createGroupProxyReq.Parent, "parent", createGroupProxyReq.Parent, `The resource name of the account to create the group in, accounts/{account_id}.`) - cmd.Flags().StringVar(&createGroupProxyReq.Group.ExternalId, "external-id", createGroupProxyReq.Group.ExternalId, `ExternalId of the group in the customer's IdP.`) - cmd.Flags().StringVar(&createGroupProxyReq.Group.GroupName, "group-name", createGroupProxyReq.Group.GroupName, `Display name of the group.`) - cmd.Flags().StringVar(&createGroupProxyReq.Group.Name, "name", createGroupProxyReq.Group.Name, `The resource name of the group.`) + cmd.Flags().StringVar(&createGroupProxyReq.Parent, "parent", createGroupProxyReq.Parent, `The resource name of the account to create the group in, in the format accounts/{account_id}.`) + cmd.Flags().StringVar(&createGroupProxyReq.Group.ExternalId, "external-id", createGroupProxyReq.Group.ExternalId, `The ID of the group in your identity provider (IdP).`) + cmd.Flags().StringVar(&createGroupProxyReq.Group.GroupName, "group-name", createGroupProxyReq.Group.GroupName, `The name of the group.`) + cmd.Flags().StringVar(&createGroupProxyReq.Group.Name, "name", createGroupProxyReq.Group.Name, `The resource name of the group, in one of these formats: - Account APIs: accounts/{account_id}/groups/{group_id} - Workspace APIs: groups/{group_id}.`) cmd.Use = "create-group-proxy" cmd.Short = `Create a group in the account.` cmd.Long = `Create a group in the account. - Creates a local group in the Databricks account that parents the calling - workspace and returns the created group. A local group is one that is not - synced from the customer's identity provider, and can be created whether or - not Account Identity Management (AIM) is enabled. + Creates a local group in the account that contains this workspace. A local + group is a group that isn't synced from your identity provider (IdP). You + become a manager of the new group. - When AIM is enabled, supplying an external ID returns an error. To provision - the identity from your identity provider, resolve it by its external ID with - ResolveGroup; to read an existing external identity, use the ExternalGroup - resource.` + If automatic identity management is on, you can't set external_id. To add a + group from your IdP, get it as an external group instead.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -278,27 +279,25 @@ func newCreateServicePrincipalProxy() *cobra.Command { cmd.Flags().Var(&createServicePrincipalProxyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createServicePrincipalProxyReq.Parent, "parent", createServicePrincipalProxyReq.Parent, `The resource name of the account to create the service principal in, accounts/{account_id}.`) - cmd.Flags().StringVar(&createServicePrincipalProxyReq.ServicePrincipal.ExternalId, "external-id", createServicePrincipalProxyReq.ServicePrincipal.ExternalId, `ExternalId of the service principal in the customer's IdP.`) - cmd.Flags().StringVar(&createServicePrincipalProxyReq.ServicePrincipal.Name, "name", createServicePrincipalProxyReq.ServicePrincipal.Name, `The resource name of the service principal.`) + cmd.Flags().StringVar(&createServicePrincipalProxyReq.Parent, "parent", createServicePrincipalProxyReq.Parent, `The resource name of the account to create the service principal in, in the format accounts/{account_id}.`) + cmd.Flags().StringVar(&createServicePrincipalProxyReq.ServicePrincipal.ExternalId, "external-id", createServicePrincipalProxyReq.ServicePrincipal.ExternalId, `The ID of the service principal in your identity provider (IdP).`) + cmd.Flags().StringVar(&createServicePrincipalProxyReq.ServicePrincipal.Name, "name", createServicePrincipalProxyReq.ServicePrincipal.Name, `The resource name of the service principal, in one of these formats: - Account APIs: accounts/{account_id}/service-principals/{service_principal_id} - Workspace APIs: service-principals/{service_principal_id}.`) cmd.Use = "create-service-principal-proxy DISPLAY_NAME ACCOUNT_SP_STATUS" cmd.Short = `Create a service principal in the account.` cmd.Long = `Create a service principal in the account. - Creates a local service principal in the Databricks account that parents the - calling workspace and returns the created service principal. A local service - principal is one that is not synced from the customer's identity provider, and - can be created whether or not Account Identity Management (AIM) is enabled. + Creates a local service principal in the account that contains this workspace. + A local service principal is one that isn't synced from your identity provider + (IdP). - When AIM is enabled, supplying an external ID returns an error. To provision - the identity from your identity provider, resolve it by its external ID with - ResolveServicePrincipal; to read an existing external identity, use the - ExternalServicePrincipal resource. + If automatic identity management is on, you can't set external_id. To add a + service principal from your IdP, get it as an external service principal + instead. Arguments: - DISPLAY_NAME: Display name of the service principal. - ACCOUNT_SP_STATUS: The activity status of a service principal in a Databricks account. + DISPLAY_NAME: The service principal's display name. + ACCOUNT_SP_STATUS: Whether the service principal is active in the account. Supported values: [ACTIVE, INACTIVE]` cmd.Annotations = make(map[string]string) @@ -383,28 +382,26 @@ func newCreateUserProxy() *cobra.Command { cmd.Flags().Var(&createUserProxyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createUserProxyReq.Parent, "parent", createUserProxyReq.Parent, `The resource name of the account to create the user in, accounts/{account_id}.`) - cmd.Flags().StringVar(&createUserProxyReq.User.ExternalId, "external-id", createUserProxyReq.User.ExternalId, `ExternalId of the user in the customer's IdP.`) - cmd.Flags().StringVar(&createUserProxyReq.User.Name, "name", createUserProxyReq.User.Name, `The resource name of the user.`) + cmd.Flags().StringVar(&createUserProxyReq.Parent, "parent", createUserProxyReq.Parent, `The resource name of the account to create the user in, in the format accounts/{account_id}.`) + cmd.Flags().StringVar(&createUserProxyReq.User.ExternalId, "external-id", createUserProxyReq.User.ExternalId, `The ID of the user in your identity provider (IdP).`) + cmd.Flags().StringVar(&createUserProxyReq.User.Name, "name", createUserProxyReq.User.Name, `The resource name of the user, in one of these formats: - Account APIs: accounts/{account_id}/users/{user_id} - Workspace APIs: users/{user_id}.`) cmd.Use = "create-user-proxy USERNAME FULL_NAME ACCOUNT_USER_STATUS" cmd.Short = `Create a user in the account.` cmd.Long = `Create a user in the account. - Creates a local user in the Databricks account that parents the calling - workspace and returns the created user. A local user is one that is not synced - from the customer's identity provider, and can be created whether or not - Account Identity Management (AIM) is enabled. + Creates a local user in the account that contains this workspace. A local user + is a user that isn't synced from your identity provider (IdP). - When AIM is enabled, supplying an external ID returns an error. To provision - the identity from your identity provider, resolve it by its external ID with - ResolveUser; to read an existing external identity, use the ExternalUser - resource. + If automatic identity management is on, you can't set external_id. To add a + user from your IdP, get them as an external user instead. Arguments: - USERNAME: Username/email of the user. - FULL_NAME: - ACCOUNT_USER_STATUS: The activity status of a user in a Databricks account. + USERNAME: The user's username, which is their email address. It can't be changed + after the user is created. + FULL_NAME: The user's name. + ACCOUNT_USER_STATUS: Whether the user is active in the account. New users are active unless you + set this to INACTIVE. Supported values: [ACTIVE, INACTIVE]` cmd.Annotations = make(map[string]string) @@ -591,25 +588,26 @@ func newCreateWorkspaceAssignmentProxy() *cobra.Command { cmd.Flags().Var(&createWorkspaceAssignmentProxyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&createWorkspaceAssignmentProxyReq.Parent, "parent", createWorkspaceAssignmentProxyReq.Parent, `The resource name of the workspace to assign the principal to, accounts/{account_id}/workspaces/{workspace_id}.`) + cmd.Flags().StringVar(&createWorkspaceAssignmentProxyReq.Parent, "parent", createWorkspaceAssignmentProxyReq.Parent, `The resource name of the workspace, in the format accounts/{account_id}/workspaces/{workspace_id}.`) // TODO: array: effective_entitlements // TODO: array: entitlements - cmd.Flags().StringVar(&createWorkspaceAssignmentProxyReq.WorkspaceAssignment.Name, "name", createWorkspaceAssignmentProxyReq.WorkspaceAssignment.Name, `The resource name of the workspace assignment.`) + cmd.Flags().StringVar(&createWorkspaceAssignmentProxyReq.WorkspaceAssignment.Name, "name", createWorkspaceAssignmentProxyReq.WorkspaceAssignment.Name, `The resource name of the assignment, in one of these formats: - Account APIs: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id} - Workspace APIs: workspace-assignments/{principal_id}.`) cmd.Use = "create-workspace-assignment-proxy PRINCIPAL_ID" cmd.Short = `Create a workspace assignment for a workspace.` cmd.Long = `Create a workspace assignment for a workspace. - Creates a workspace assignment for a principal in the calling workspace. - Entitlements are granted one at a time rather than atomically. If the request - fails partway through, the principal stays assigned to the workspace with only - some of the requested entitlements. Get the assignment afterwards to confirm - which entitlements were granted. + Assigns a user, service principal, or group directly to this workspace with + the given entitlements. Returns an error if the principal is already assigned + directly. + + Entitlements are granted one at a time. If the request fails partway through, + the principal stays assigned with only some of the entitlements. Get the + assignment afterwards to check which were granted. Arguments: - PRINCIPAL_ID: The internal ID of the principal (user/sp/group) in Databricks. Set when - the assignment is created and cannot be changed afterwards; to assign a - different principal, create a new assignment.` + PRINCIPAL_ID: The Databricks ID of the assigned user, service principal, or group. It + can't be changed after the assignment is created.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -690,11 +688,15 @@ func newDeleteDirectGroupMemberProxy() *cobra.Command { cmd.Short = `Delete a direct group membership.` cmd.Long = `Delete a direct group membership. - Deletes a group membership (unassigns a principal from a group). + Removes a direct member from a group in the account that contains this + workspace. + + If automatic identity management is on and the group has an external_id, its + members come from your identity provider and can't be changed in Databricks. Arguments: - NAME: The resource name of the group membership. Format: - groups/{group_id}/direct-members/{principal_id}` + NAME: The resource name of the membership, in the format + groups/{group_id}/direct-members/{principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -749,11 +751,11 @@ func newDeleteGroupProxy() *cobra.Command { cmd.Short = `Delete a group in the account.` cmd.Long = `Delete a group in the account. - Deletes a group by its internal ID from the Databricks account that parents - the calling workspace. + Deletes a group from the account that contains this workspace and removes it + from the workspaces it's assigned to. Arguments: - NAME: The resource name of the group. Format: groups/{group_id}` + NAME: The resource name of the group, in the format groups/{group_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -808,12 +810,13 @@ func newDeleteServicePrincipalProxy() *cobra.Command { cmd.Short = `Delete a service principal in the account.` cmd.Long = `Delete a service principal in the account. - Deletes a service principal by its internal ID from the Databricks account - that parents the calling workspace. + Deletes a service principal from the account that contains this workspace and + removes it from the workspaces it's assigned to. You can't delete service + principals that Databricks manages. Arguments: - NAME: The resource name of the service principal. Format: - service-principals/{service_principal_id}` + NAME: The resource name of the service principal, in the format + service-principals/{service_principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -868,11 +871,11 @@ func newDeleteUserProxy() *cobra.Command { cmd.Short = `Delete a user in the account.` cmd.Long = `Delete a user in the account. - Deletes a user by its internal ID from the Databricks account that parents the - calling workspace. + Deletes a user from the account that contains this workspace and removes them + from the workspaces they're assigned to. Arguments: - NAME: The resource name of the user. Format: users/{user_id}` + NAME: The resource name of the user, in the format users/{user_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -996,14 +999,17 @@ func newDeleteWorkspaceAssignmentProxy() *cobra.Command { cmd.Short = `Delete a workspace assignment for a workspace.` cmd.Long = `Delete a workspace assignment for a workspace. - Deletes a workspace assignment for a principal in the calling workspace, - revoking all of its entitlements. Entitlements are revoked one at a time - rather than atomically. If the request fails partway through, the principal - stays assigned with some of its original entitlements. Retrying is safe. + Removes a principal's direct assignment to this workspace and revokes the + entitlements it granted. The principal keeps any access it gets through + groups. + + Entitlements are revoked one at a time. If the request fails partway through, + the principal stays assigned with some of its entitlements. You can retry the + request. Arguments: - NAME: The resource name of the workspace assignment. Format: - workspace-assignments/{principal_id}` + NAME: The resource name of the assignment, in the format + workspace-assignments/{principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1058,11 +1064,13 @@ func newGetDirectGroupMemberProxy() *cobra.Command { cmd.Short = `Get a direct group member.` cmd.Long = `Get a direct group member. - Gets a provisioned direct member of a group. + Gets a direct member of a group in the account that contains this workspace, + including where the membership comes from. Returns an error if the principal + isn't a direct member. Arguments: - NAME: The resource name of the group membership. Format: - groups/{group_id}/direct-members/{principal_id}` + NAME: The resource name of the membership, in the format + groups/{group_id}/direct-members/{principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1118,14 +1126,14 @@ func newGetExternalGroupProxy() *cobra.Command { cmd.Short = `Get an external group in the account.` cmd.Long = `Get an external group in the account. - Retrieves an external 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 error. Workspace-scoped variant for workspace-authenticated callers. + Gets a group by its ID in your identity provider (IdP) and syncs its name and + parent groups from your IdP. If the group isn't in the account that contains + this workspace yet, it's added. Requires automatic identity management. If + your account has group visibility filters, the group must match them. Arguments: - NAME: Required. The resource name of the external group. Format: - external-groups/{external_group_id}` + NAME: The resource name of the external group, in the format + external-groups/{external_group_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1181,15 +1189,14 @@ func newGetExternalServicePrincipalProxy() *cobra.Command { cmd.Short = `Get an external service principal in the account.` cmd.Long = `Get an external service principal in the account. - Retrieves an external service principal with the given external ID from the - customer's IdP. If the service principal does not exist, it will be created. - If the customer is not onboarded onto Automatic Identity Management (AIM), - this will return an error. Workspace-scoped variant for - workspace-authenticated callers. + Gets a service principal by its ID in your identity provider (IdP) and syncs + its details and group memberships from your IdP. If the service principal + isn't in the account that contains this workspace yet, it's added. Requires + automatic identity management with Microsoft Entra ID as your IdP. Arguments: - NAME: Required. The resource name of the external service principal. Format: - external-service-principals/{external_service_principal_id}` + NAME: The resource name of the external service principal, in the format + external-service-principals/{external_service_principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1245,14 +1252,14 @@ func newGetExternalUserProxy() *cobra.Command { cmd.Short = `Get an external user in the account.` cmd.Long = `Get an external user in the account. - Retrieves an external 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. - Workspace-scoped variant for workspace-authenticated callers. + Gets a user by their ID in your identity provider (IdP) and syncs their + details and group memberships from your IdP. If the user isn't in the account + that contains this workspace yet, they're added. Requires automatic identity + management. Arguments: - NAME: Required. The resource name of the external user. Format: - external-users/{external_user_id}` + NAME: The resource name of the external user, in the format + external-users/{external_user_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1308,11 +1315,10 @@ func newGetGroupProxy() *cobra.Command { cmd.Short = `Get a group in the account.` cmd.Long = `Get a group in the account. - Fetches a group by its internal ID from the Databricks account that parents - the calling workspace. + Gets a group in the account that contains this workspace by its Databricks ID. Arguments: - NAME: The resource name of the group. Format: groups/{group_id}` + NAME: The resource name of the group, in the format groups/{group_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1368,12 +1374,12 @@ func newGetServicePrincipalProxy() *cobra.Command { cmd.Short = `Get a service principal in the account.` cmd.Long = `Get a service principal in the account. - Fetches a service principal by its internal ID from the Databricks account - that parents the calling workspace. + Gets a service principal in the account that contains this workspace by its + Databricks ID. Arguments: - NAME: The resource name of the service principal. Format: - service-principals/{service_principal_id}` + NAME: The resource name of the service principal, in the format + service-principals/{service_principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1429,11 +1435,11 @@ func newGetUserProxy() *cobra.Command { cmd.Short = `Get a user in the account.` cmd.Long = `Get a user in the account. - Fetches a user by its internal ID from the Databricks account that parents the - calling workspace. + Gets a user in the account that contains this workspace by their Databricks + ID. Arguments: - NAME: The resource name of the user. Format: users/{user_id}` + NAME: The resource name of the user, in the format users/{user_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1624,11 +1630,13 @@ func newGetWorkspaceAssignmentProxy() *cobra.Command { cmd.Short = `Get a workspace assignment for a principal.` cmd.Long = `Get a workspace assignment for a principal. - Returns the assignment for a principal in the calling workspace. + Gets a principal's direct assignment to this workspace, including its + effective entitlements. Returns an error if the principal isn't assigned + directly. Arguments: - NAME: The resource name of the workspace assignment. Format: - workspace-assignments/{principal_id}` + NAME: The resource name of the assignment, in the format + workspace-assignments/{principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1684,11 +1692,13 @@ func newGetWorkspaceIdentityDetail() *cobra.Command { cmd.Short = `Get workspace identity details for a principal.` cmd.Long = `Get workspace identity details for a principal. - Returns the identity details for a principal in a workspace. + Gets a principal's status in this workspace and whether it has access directly + or through a group. Returns an error if the principal doesn't have access to + the workspace. Arguments: - NAME: The resource name of the workspace identity detail. Format: - principals/{principal_id}/workspace-identity-detail` + NAME: The resource name of the workspace identity detail, in the format + principals/{principal_id}/workspace-identity-detail.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1744,7 +1754,7 @@ func newListDirectGroupMembersProxy() *cobra.Command { // branches, so the method-call path is always reached. var listDirectGroupMembersProxyLimit int - cmd.Flags().IntVar(&listDirectGroupMembersProxyReq.PageSize, "page-size", listDirectGroupMembersProxyReq.PageSize, `The maximum number of members to return.`) + cmd.Flags().IntVar(&listDirectGroupMembersProxyReq.PageSize, "page-size", listDirectGroupMembersProxyReq.PageSize, `The maximum number of members to return, up to 1000.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listDirectGroupMembersProxyLimit, "limit", 0, `Maximum number of results to return.`) @@ -1757,12 +1767,13 @@ func newListDirectGroupMembersProxy() *cobra.Command { cmd.Short = `List direct group members.` cmd.Long = `List direct group members. - Lists provisioned direct members of a group with their membership source - (internal or from identity provider). + Lists the direct members of a group in the account that contains this + workspace, sorted by display name, with where each membership comes from. + Members in your identity provider who haven't been added to Databricks aren't + included. Arguments: - PARENT: The parent resource name of the group whose direct members to list. - Format: groups/{group_id}` + PARENT: The resource name of the group, in the format groups/{group_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1821,9 +1832,9 @@ func newListGroupsProxy() *cobra.Command { // branches, so the method-call path is always reached. var listGroupsProxyLimit int - cmd.Flags().StringVar(&listGroupsProxyReq.Filter, "filter", listGroupsProxyReq.Filter, `Optional.`) - cmd.Flags().IntVar(&listGroupsProxyReq.PageSize, "page-size", listGroupsProxyReq.PageSize, `The maximum number of groups to return.`) - cmd.Flags().StringVar(&listGroupsProxyReq.Parent, "parent", listGroupsProxyReq.Parent, `The resource name of the account to list groups in, accounts/{account_id}.`) + cmd.Flags().StringVar(&listGroupsProxyReq.Filter, "filter", listGroupsProxyReq.Filter, `Filters groups by group_name or external_id, for example group_name eq "Data engineers".`) + cmd.Flags().IntVar(&listGroupsProxyReq.PageSize, "page-size", listGroupsProxyReq.PageSize, `The maximum number of groups to return, up to 1000.`) + cmd.Flags().StringVar(&listGroupsProxyReq.Parent, "parent", listGroupsProxyReq.Parent, `The resource name of the account to list groups in, in the format accounts/{account_id}.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listGroupsProxyLimit, "limit", 0, `Maximum number of results to return.`) @@ -1836,8 +1847,9 @@ func newListGroupsProxy() *cobra.Command { cmd.Short = `List groups in the account.` cmd.Long = `List groups in the account. - Lists the groups in the Databricks account that parents the calling workspace, - returning one page per call. Supports filtering by group name or external ID.` + Lists the groups in the account that contains this workspace, sorted by + Databricks ID. Groups in your identity provider that haven't been added to + Databricks aren't included.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1894,9 +1906,9 @@ func newListServicePrincipalsProxy() *cobra.Command { // branches, so the method-call path is always reached. var listServicePrincipalsProxyLimit int - cmd.Flags().StringVar(&listServicePrincipalsProxyReq.Filter, "filter", listServicePrincipalsProxyReq.Filter, `Optional.`) - cmd.Flags().IntVar(&listServicePrincipalsProxyReq.PageSize, "page-size", listServicePrincipalsProxyReq.PageSize, `The maximum number of SPs to return.`) - cmd.Flags().StringVar(&listServicePrincipalsProxyReq.Parent, "parent", listServicePrincipalsProxyReq.Parent, `The resource name of the account to list service principals in, accounts/{account_id}.`) + cmd.Flags().StringVar(&listServicePrincipalsProxyReq.Filter, "filter", listServicePrincipalsProxyReq.Filter, `Filters service principals by application_id or external_id, for example application_id eq "".`) + cmd.Flags().IntVar(&listServicePrincipalsProxyReq.PageSize, "page-size", listServicePrincipalsProxyReq.PageSize, `The maximum number of service principals to return, up to 1000.`) + cmd.Flags().StringVar(&listServicePrincipalsProxyReq.Parent, "parent", listServicePrincipalsProxyReq.Parent, `The resource name of the account to list service principals in, in the format accounts/{account_id}.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listServicePrincipalsProxyLimit, "limit", 0, `Maximum number of results to return.`) @@ -1909,9 +1921,9 @@ func newListServicePrincipalsProxy() *cobra.Command { cmd.Short = `List service principals in the account.` cmd.Long = `List service principals in the account. - Lists the service principals in the Databricks account that parents the - calling workspace, returning one page per call. Supports filtering by - application ID or external ID.` + Lists the service principals in the account that contains this workspace, + sorted by Databricks ID. Service principals in your identity provider that + haven't been added to Databricks aren't included.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -1964,18 +1976,22 @@ func newListTransitiveParentGroupsProxy() *cobra.Command { var listTransitiveParentGroupsProxyReq iamv2.ListTransitiveParentGroupsProxyRequest - cmd.Flags().IntVar(&listTransitiveParentGroupsProxyReq.PageSize, "page-size", listTransitiveParentGroupsProxyReq.PageSize, `The maximum number of parent groups to return.`) - cmd.Flags().StringVar(&listTransitiveParentGroupsProxyReq.PageToken, "page-token", listTransitiveParentGroupsProxyReq.PageToken, `A page token, received from a previous ListTransitiveParentGroups call.`) + cmd.Flags().IntVar(&listTransitiveParentGroupsProxyReq.PageSize, "page-size", listTransitiveParentGroupsProxyReq.PageSize, `The maximum number of groups to return, up to 1000.`) + cmd.Flags().StringVar(&listTransitiveParentGroupsProxyReq.PageToken, "page-token", listTransitiveParentGroupsProxyReq.PageToken, `The next_page_token from a previous response, to get the next page.`) cmd.Use = "list-transitive-parent-groups-proxy PARENT" cmd.Short = `List all transitive parent groups of a principal.` cmd.Long = `List all transitive parent groups of a principal. - Lists all transitive parent groups of a principal. + Lists every group that a user, service principal, or group belongs to, + directly or through other groups, in the account that contains this workspace. + Results are sorted by Databricks ID. If automatic identity management is on, + the principal's group memberships are synced from your identity provider + first. Arguments: - PARENT: The parent resource name of the principal whose transitive parent groups - to list. Format: principals/{principal_id}` + PARENT: The user, service principal, or group whose parent groups to list, in the + format principals/{principal_id}.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2031,9 +2047,9 @@ func newListUsersProxy() *cobra.Command { // branches, so the method-call path is always reached. var listUsersProxyLimit int - cmd.Flags().StringVar(&listUsersProxyReq.Filter, "filter", listUsersProxyReq.Filter, `Optional.`) - cmd.Flags().IntVar(&listUsersProxyReq.PageSize, "page-size", listUsersProxyReq.PageSize, `The maximum number of users to return.`) - cmd.Flags().StringVar(&listUsersProxyReq.Parent, "parent", listUsersProxyReq.Parent, `The resource name of the account to list users in, accounts/{account_id}.`) + cmd.Flags().StringVar(&listUsersProxyReq.Filter, "filter", listUsersProxyReq.Filter, `Filters users by username or external_id, for example username eq "someone@example.com".`) + cmd.Flags().IntVar(&listUsersProxyReq.PageSize, "page-size", listUsersProxyReq.PageSize, `The maximum number of users to return, up to 1000.`) + cmd.Flags().StringVar(&listUsersProxyReq.Parent, "parent", listUsersProxyReq.Parent, `The resource name of the account to list users in, in the format accounts/{account_id}.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listUsersProxyLimit, "limit", 0, `Maximum number of results to return.`) @@ -2046,8 +2062,9 @@ func newListUsersProxy() *cobra.Command { cmd.Short = `List users in the account.` cmd.Long = `List users in the account. - Lists the users in the Databricks account that parents the calling workspace, - returning one page per call. Supports filtering by username or external ID.` + Lists the users in the account that contains this workspace, sorted by + Databricks ID. Users in your identity provider who haven't been added to + Databricks aren't included.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2180,8 +2197,8 @@ func newListWorkspaceAssignmentsProxy() *cobra.Command { // branches, so the method-call path is always reached. var listWorkspaceAssignmentsProxyLimit int - cmd.Flags().IntVar(&listWorkspaceAssignmentsProxyReq.PageSize, "page-size", listWorkspaceAssignmentsProxyReq.PageSize, `The maximum number of workspace assignments to return.`) - cmd.Flags().StringVar(&listWorkspaceAssignmentsProxyReq.Parent, "parent", listWorkspaceAssignmentsProxyReq.Parent, `The resource name of the workspace to list assignments of, accounts/{account_id}/workspaces/{workspace_id}.`) + cmd.Flags().IntVar(&listWorkspaceAssignmentsProxyReq.PageSize, "page-size", listWorkspaceAssignmentsProxyReq.PageSize, `The maximum number of assignments to return, up to 1000.`) + cmd.Flags().StringVar(&listWorkspaceAssignmentsProxyReq.Parent, "parent", listWorkspaceAssignmentsProxyReq.Parent, `The resource name of the workspace, in the format accounts/{account_id}/workspaces/{workspace_id}.`) // Limit flag for total result capping. cmd.Flags().IntVar(&listWorkspaceAssignmentsProxyLimit, "limit", 0, `Maximum number of results to return.`) @@ -2194,10 +2211,9 @@ func newListWorkspaceAssignmentsProxy() *cobra.Command { cmd.Short = `List workspace assignments for a workspace.` cmd.Long = `List workspace assignments for a workspace. - Lists workspace assignments for the calling workspace. The response omits the - per-principal entitlement fields (entitlements and - effective_entitlements). To read the entitlements for a single principal, - get that principal's assignment.` + Lists the principals assigned directly to this workspace. The response leaves + entitlements and effective_entitlements empty. To read a principal's + entitlements, get its assignment.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2259,13 +2275,13 @@ func newResolveGroupProxy() *cobra.Command { 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 - error. + Gets a group by its ID in your identity provider (IdP) and syncs its name and + parent groups from your IdP. If the group isn't in the account that contains + this workspace yet, it's added. Requires automatic identity management. If + your account has group visibility filters, the group must match them. Arguments: - EXTERNAL_ID: Required. The external ID of the group in the customer's IdP.` + EXTERNAL_ID: The ID of the group in your IdP.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -2347,13 +2363,13 @@ func newResolveServicePrincipalProxy() *cobra.Command { Resolve an external service principal in the Databricks account. - Resolves a service principal with the given external ID from the customer's - IdP. If the service principal does not exist, it will be created. If the - customer is not onboarded onto Automatic Identity Management (AIM), this will - return an error. + Gets a service principal by its ID in your identity provider (IdP) and syncs + its details and group memberships from your IdP. If the service principal + isn't in the account that contains this workspace yet, it's added. Requires + automatic identity management with Microsoft Entra ID as your IdP. Arguments: - EXTERNAL_ID: Required. The external ID of the service principal in the customer's IdP.` + EXTERNAL_ID: The ID of the service principal in your IdP.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -2435,12 +2451,13 @@ func newResolveUserProxy() *cobra.Command { 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. + Gets a user by their ID in your identity provider (IdP) and syncs their + details and group memberships from your IdP. If the user isn't in the account + that contains this workspace yet, they're added. Requires automatic identity + management. Arguments: - EXTERNAL_ID: Required. The external ID of the user in the customer's IdP.` + EXTERNAL_ID: The ID of the user in your IdP.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "PUBLIC_BETA" @@ -2517,28 +2534,28 @@ func newUpdateGroupProxy() *cobra.Command { cmd.Flags().Var(&updateGroupProxyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateGroupProxyReq.Group.ExternalId, "external-id", updateGroupProxyReq.Group.ExternalId, `ExternalId of the group in the customer's IdP.`) - cmd.Flags().StringVar(&updateGroupProxyReq.Group.GroupName, "group-name", updateGroupProxyReq.Group.GroupName, `Display name of the group.`) - cmd.Flags().StringVar(&updateGroupProxyReq.Group.Name, "name", updateGroupProxyReq.Group.Name, `The resource name of the group.`) + cmd.Flags().StringVar(&updateGroupProxyReq.Group.ExternalId, "external-id", updateGroupProxyReq.Group.ExternalId, `The ID of the group in your identity provider (IdP).`) + cmd.Flags().StringVar(&updateGroupProxyReq.Group.GroupName, "group-name", updateGroupProxyReq.Group.GroupName, `The name of the group.`) + cmd.Flags().StringVar(&updateGroupProxyReq.Group.Name, "name", updateGroupProxyReq.Group.Name, `The resource name of the group, in one of these formats: - Account APIs: accounts/{account_id}/groups/{group_id} - Workspace APIs: groups/{group_id}.`) cmd.Use = "update-group-proxy NAME UPDATE_MASK" cmd.Short = `Update a group in the account.` cmd.Long = `Update a group in the account. - Updates an existing group in the Databricks account that parents the calling - workspace. Only the fields named in the update mask are modified. Returns the - updated Group resource. + Updates a group in the account that contains this workspace. Only the fields + in update_mask change. - When AIM is enabled and the group is an external identity (its external_id is - set), only external_id can be updated; its other fields are sourced from your - identity provider. With AIM and group visibility filters, a new nonempty - external_id must identify a visible group. Clearing external_id is allowed. + If automatic identity management is on and the group has an external_id, you + can only update external_id. The group's other fields come from your + identity provider. If your account also has group visibility filters, a new + external_id must match them. You can always clear external_id. Arguments: - NAME: The resource name of the group. The format depends on the API that - returned it: - Account-scoped: accounts/{account_id}/groups/{group_id} - - Workspace-scoped: groups/{group_id} - UPDATE_MASK: Required. The list of fields to update.` + NAME: The resource name of the group, in one of these formats: - Account APIs: + accounts/{account_id}/groups/{group_id} - Workspace APIs: + groups/{group_id} + UPDATE_MASK: The fields to update, separated by commas. You can update group_name and + external_id.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -2607,32 +2624,30 @@ func newUpdateServicePrincipalProxy() *cobra.Command { cmd.Flags().Var(&updateServicePrincipalProxyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateServicePrincipalProxyReq.ServicePrincipal.ExternalId, "external-id", updateServicePrincipalProxyReq.ServicePrincipal.ExternalId, `ExternalId of the service principal in the customer's IdP.`) - cmd.Flags().StringVar(&updateServicePrincipalProxyReq.ServicePrincipal.Name, "name", updateServicePrincipalProxyReq.ServicePrincipal.Name, `The resource name of the service principal.`) + cmd.Flags().StringVar(&updateServicePrincipalProxyReq.ServicePrincipal.ExternalId, "external-id", updateServicePrincipalProxyReq.ServicePrincipal.ExternalId, `The ID of the service principal in your identity provider (IdP).`) + cmd.Flags().StringVar(&updateServicePrincipalProxyReq.ServicePrincipal.Name, "name", updateServicePrincipalProxyReq.ServicePrincipal.Name, `The resource name of the service principal, in one of these formats: - Account APIs: accounts/{account_id}/service-principals/{service_principal_id} - Workspace APIs: service-principals/{service_principal_id}.`) cmd.Use = "update-service-principal-proxy NAME UPDATE_MASK DISPLAY_NAME ACCOUNT_SP_STATUS" cmd.Short = `Update a service principal in the account.` cmd.Long = `Update a service principal in the account. - Updates an existing service principal in the Databricks account that parents - the calling workspace. Only the fields named in the update mask are modified. - Returns the updated ServicePrincipal resource. + Updates a service principal in the account that contains this workspace. Only + the fields in update_mask change. - To change is_agent on a locally managed service principal, set it to true or - false. Naming is_agent in the update mask without a value leaves it unchanged. - - When AIM is enabled and the service principal is an external identity (its - external_id is set), only external_id can be updated; its other fields are - sourced from your identity provider. + If automatic identity management is on and the service principal has an + external_id, you can only update external_id. Its other fields come from + your identity provider. A service principal can't deactivate itself, and you + can't update service principals that Databricks manages. Arguments: - NAME: The resource name of the service principal. The format depends on the API - that returned it: - Account-scoped: + NAME: The resource name of the service principal, in one of these formats: - + Account APIs: accounts/{account_id}/service-principals/{service_principal_id} - - Workspace-scoped: service-principals/{service_principal_id} - UPDATE_MASK: Required. The list of fields to update. - DISPLAY_NAME: Display name of the service principal. - ACCOUNT_SP_STATUS: The activity status of a service principal in a Databricks account. + Workspace APIs: service-principals/{service_principal_id} + UPDATE_MASK: The fields to update, separated by commas. You can update display_name, + account_sp_status, and external_id. + DISPLAY_NAME: The service principal's display name. + ACCOUNT_SP_STATUS: Whether the service principal is active in the account. Supported values: [ACTIVE, INACTIVE]` cmd.Annotations = make(map[string]string) @@ -2719,30 +2734,33 @@ func newUpdateUserProxy() *cobra.Command { cmd.Flags().Var(&updateUserProxyJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateUserProxyReq.User.ExternalId, "external-id", updateUserProxyReq.User.ExternalId, `ExternalId of the user in the customer's IdP.`) - cmd.Flags().StringVar(&updateUserProxyReq.User.Name, "name", updateUserProxyReq.User.Name, `The resource name of the user.`) + cmd.Flags().StringVar(&updateUserProxyReq.User.ExternalId, "external-id", updateUserProxyReq.User.ExternalId, `The ID of the user in your identity provider (IdP).`) + cmd.Flags().StringVar(&updateUserProxyReq.User.Name, "name", updateUserProxyReq.User.Name, `The resource name of the user, in one of these formats: - Account APIs: accounts/{account_id}/users/{user_id} - Workspace APIs: users/{user_id}.`) cmd.Use = "update-user-proxy NAME UPDATE_MASK USERNAME FULL_NAME ACCOUNT_USER_STATUS" cmd.Short = `Update a user in the account.` cmd.Long = `Update a user in the account. - Updates an existing user in the Databricks account that parents the calling - workspace and returns the updated user. Only the fields named in the update - mask are modified. The updatable fields are fullName.givenName, - fullName.familyName, status, and externalId. + Updates a user in the account that contains this workspace. Only the fields in + update_mask change. - When AIM is enabled and the user is an external identity (its external_id is - set), only external_id can be updated; its other fields are sourced from your - identity provider. + If automatic identity management is on and the user has an external_id, you + can only update external_id. The user's other fields come from your identity + provider. You can't deactivate yourself or change the status of the account + owner. Arguments: - NAME: The resource name of the user. The format depends on the API that returned - it: - Account-scoped: accounts/{account_id}/users/{user_id} - - Workspace-scoped: users/{user_id} - UPDATE_MASK: Required. The list of fields to update. - USERNAME: Username/email of the user. - FULL_NAME: - ACCOUNT_USER_STATUS: The activity status of a user in a Databricks account. + NAME: The resource name of the user, in one of these formats: - Account APIs: + accounts/{account_id}/users/{user_id} - Workspace APIs: + users/{user_id} + UPDATE_MASK: The fields to update, separated by commas. You can update + full_name.given_name, full_name.family_name, account_user_status, + and external_id. + USERNAME: The user's username, which is their email address. It can't be changed + after the user is created. + FULL_NAME: The user's name. + ACCOUNT_USER_STATUS: Whether the user is active in the account. New users are active unless you + set this to INACTIVE. Supported values: [ACTIVE, INACTIVE]` cmd.Annotations = make(map[string]string) @@ -2946,26 +2964,27 @@ func newUpdateWorkspaceAssignmentProxy() *cobra.Command { // TODO: array: effective_entitlements // TODO: array: entitlements - cmd.Flags().StringVar(&updateWorkspaceAssignmentProxyReq.WorkspaceAssignment.Name, "name", updateWorkspaceAssignmentProxyReq.WorkspaceAssignment.Name, `The resource name of the workspace assignment.`) + cmd.Flags().StringVar(&updateWorkspaceAssignmentProxyReq.WorkspaceAssignment.Name, "name", updateWorkspaceAssignmentProxyReq.WorkspaceAssignment.Name, `The resource name of the assignment, in one of these formats: - Account APIs: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id} - Workspace APIs: workspace-assignments/{principal_id}.`) cmd.Use = "update-workspace-assignment-proxy NAME UPDATE_MASK PRINCIPAL_ID" cmd.Short = `Update a workspace assignment for a workspace.` cmd.Long = `Update a workspace assignment for a workspace. - Updates the entitlements of a directly assigned principal in the calling - workspace. Changes are applied one at a time rather than atomically. If the - request fails partway through, only some of the requested changes take effect. - Get the assignment afterwards to confirm the final state. + Replaces the entitlements of a principal's direct assignment to this + workspace. The new list can't be empty. + + Entitlements are changed one at a time. If the request fails partway through, + only some of the changes take effect. Get the assignment afterwards to check + the result. Arguments: - NAME: The resource name of the workspace assignment. The format depends on the - API that returned it: - Account-scoped: + NAME: The resource name of the assignment, in one of these formats: - Account + APIs: accounts/{account_id}/workspaces/{workspace_id}/workspace-assignments/{principal_id} - - Workspace-scoped: workspace-assignments/{principal_id} - UPDATE_MASK: Required. The list of fields to update. - PRINCIPAL_ID: The internal ID of the principal (user/sp/group) in Databricks. Set when - the assignment is created and cannot be changed afterwards; to assign a - different principal, create a new assignment.` + - Workspace APIs: workspace-assignments/{principal_id} + UPDATE_MASK: The fields to update. The only supported field is entitlements. + PRINCIPAL_ID: The Databricks ID of the assigned user, service principal, or group. It + can't be changed after the assignment is created.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" @@ -3051,19 +3070,22 @@ func newUpdateWorkspaceIdentityDetail() *cobra.Command { cmd.Flags().Var(&updateWorkspaceIdentityDetailJson, "json", `either inline JSON string or @path/to/file.json with request body`) - cmd.Flags().StringVar(&updateWorkspaceIdentityDetailReq.WorkspaceIdentityDetail.Name, "name", updateWorkspaceIdentityDetailReq.WorkspaceIdentityDetail.Name, `The resource name of the workspace identity detail.`) - cmd.Flags().Var(&updateWorkspaceIdentityDetailReq.WorkspaceIdentityDetail.WorkspaceIdentityStatus, "workspace-identity-status", `The activity status of an identity in a Databricks workspace. Supported values: [ACTIVE, INACTIVE]`) + cmd.Flags().StringVar(&updateWorkspaceIdentityDetailReq.WorkspaceIdentityDetail.Name, "name", updateWorkspaceIdentityDetailReq.WorkspaceIdentityDetail.Name, `The resource name of the workspace identity detail, in the format principals/{principal_id}/workspace-identity-detail.`) + cmd.Flags().Var(&updateWorkspaceIdentityDetailReq.WorkspaceIdentityDetail.WorkspaceIdentityStatus, "workspace-identity-status", `Whether the principal is active in the workspace. Supported values: [ACTIVE, INACTIVE]`) cmd.Use = "update-workspace-identity-detail NAME UPDATE_MASK" cmd.Short = `Update workspace identity details for a principal.` cmd.Long = `Update workspace identity details for a principal. - Updates a workspace identity detail for a principal. + Activates or deactivates a user or service principal in this workspace. You + can only update workspace_identity_status. You can't change your own status + or the status of a group. Arguments: - NAME: The resource name of the workspace identity detail. Format: - principals/{principal_id}/workspace-identity-detail - UPDATE_MASK: Required. The list of fields to update.` + NAME: The resource name of the workspace identity detail, in the format + principals/{principal_id}/workspace-identity-detail. + UPDATE_MASK: The fields to update. The only supported field is + workspace_identity_status.` cmd.Annotations = make(map[string]string) cmd.Annotations["launch_stage"] = "GA" diff --git a/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go b/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go index a9c54d16d03..124eddcbaea 100644 --- a/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go +++ b/cmd/workspace/workspace-settings-v2/workspace-settings-v2.go @@ -211,6 +211,7 @@ func newPatchPublicWorkspaceSetting() *cobra.Command { // TODO: complex arg: effective_personal_compute // TODO: complex arg: effective_restrict_workspace_admins // TODO: complex arg: effective_string_val + // TODO: complex arg: effective_workspace_dashboard_theme // TODO: complex arg: effective_workspace_label // TODO: complex arg: integer_val cmd.Flags().StringVar(&patchPublicWorkspaceSettingReq.Setting.Name, "name", patchPublicWorkspaceSettingReq.Setting.Name, `Name of the setting.`) @@ -218,6 +219,7 @@ func newPatchPublicWorkspaceSetting() *cobra.Command { // TODO: complex arg: personal_compute // TODO: complex arg: restrict_workspace_admins // TODO: complex arg: string_val + // TODO: complex arg: workspace_dashboard_theme // TODO: complex arg: workspace_label cmd.Use = "patch-public-workspace-setting NAME" diff --git a/go.mod b/go.mod index 98164b1e3e6..d3c31cb8393 100644 --- a/go.mod +++ b/go.mod @@ -13,7 +13,7 @@ require ( github.com/charmbracelet/huh v1.0.0 // MIT github.com/charmbracelet/lipgloss v1.1.0 // MIT github.com/charmbracelet/x/ansi v0.11.9 // MIT - github.com/databricks/databricks-sdk-go v0.195.0 // Apache-2.0 + github.com/databricks/databricks-sdk-go v0.196.0 // Apache-2.0 github.com/databricks/sdk-go/auth v0.2.0 // Apache-2.0 github.com/databricks/sdk-go/core v0.1.0 // Apache-2.0 github.com/databricks/sdk-go/files v0.3.0 // Apache-2.0 diff --git a/go.sum b/go.sum index 54878badb2a..cff7ca4efc6 100644 --- a/go.sum +++ b/go.sum @@ -60,8 +60,8 @@ github.com/creack/pty v1.1.24 h1:bJrF4RRfyJnbTJqzRLHzcGaZK1NeM5kTC9jGgovnR1s= github.com/creack/pty v1.1.24/go.mod h1:08sCNb52WyoAwi2QDyzUCTgcvVFhUzewun7wtTfvcwE= github.com/danieljoos/wincred v1.2.3 h1:v7dZC2x32Ut3nEfRH+vhoZGvN72+dQ/snVXo/vMFLdQ= github.com/danieljoos/wincred v1.2.3/go.mod h1:6qqX0WNrS4RzPZ1tnroDzq9kY3fu1KwE7MRLQK4X0bs= -github.com/databricks/databricks-sdk-go v0.195.0 h1:Ec2f806fEKwUJsOEUFWaQuwzTThnixnJPUnL0CizgNI= -github.com/databricks/databricks-sdk-go v0.195.0/go.mod h1:udBw6nxkaqa0fgPQ7ZW1kGFkltQncYx+qFJeVFmxtz8= +github.com/databricks/databricks-sdk-go v0.196.0 h1:uqPseRnA4StdqsEivx+UugZ3PK9/t/J/XgcowGpKpk8= +github.com/databricks/databricks-sdk-go v0.196.0/go.mod h1:udBw6nxkaqa0fgPQ7ZW1kGFkltQncYx+qFJeVFmxtz8= github.com/databricks/sdk-go/auth v0.2.0 h1:543fVMvJ6pVxBymfjGGkkmfiHDbUqX7y9lZseEcE4tQ= github.com/databricks/sdk-go/auth v0.2.0/go.mod h1:eNJdFzBAfu1y32a3wPcTnjaUkjhS9VfyCNblKFPIPEo= github.com/databricks/sdk-go/core v0.1.0 h1:ZolzW/KVIJy1xXQ0zTsu/QYsEB4vQAEApbbq4D3RGHc= diff --git a/python/databricks/bundles/clusters/_models/confidential_compute_type.py b/python/databricks/bundles/clusters/_models/confidential_compute_type.py index e881295bd47..c3ff157557b 100644 --- a/python/databricks/bundles/clusters/_models/confidential_compute_type.py +++ b/python/databricks/bundles/clusters/_models/confidential_compute_type.py @@ -6,8 +6,6 @@ class ConfidentialComputeType(Enum): """ - :meta private: [EXPERIMENTAL] - Confidential computing technology for GCP instances. Aligns with gcloud's --confidential-compute-type flag and the REST API's confidentialInstanceConfig.confidentialInstanceType field. diff --git a/python/databricks/bundles/clusters/_models/gcp_attributes.py b/python/databricks/bundles/clusters/_models/gcp_attributes.py index e31188d405e..0e427400bdf 100644 --- a/python/databricks/bundles/clusters/_models/gcp_attributes.py +++ b/python/databricks/bundles/clusters/_models/gcp_attributes.py @@ -40,7 +40,7 @@ class GcpAttributes: """ :meta private: [EXPERIMENTAL] - [Private Preview] The confidential computing technology for this cluster's instances. + [Beta] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ @@ -116,7 +116,7 @@ class GcpAttributesDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] The confidential computing technology for this cluster's instances. + [Beta] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ diff --git a/python/databricks/bundles/features/_models/sdp_source.py b/python/databricks/bundles/features/_models/sdp_source.py index 3d41a87d5bc..8ec3695889a 100644 --- a/python/databricks/bundles/features/_models/sdp_source.py +++ b/python/databricks/bundles/features/_models/sdp_source.py @@ -42,7 +42,7 @@ class SdpSource: [Private Preview] The full three-part names of the tables the pipeline reads from. Required to materialize this feature with a TableTrigger, which starts a run when these tables update. Each table must exist when the feature is created. Feature Store doesn't confirm that the pipeline reads from these - tables. At most 100 tables. + tables. At most 25 tables. """ output_table: VariableOrOptional[str] = None @@ -107,7 +107,7 @@ class SdpSourceDict(TypedDict, total=False): [Private Preview] The full three-part names of the tables the pipeline reads from. Required to materialize this feature with a TableTrigger, which starts a run when these tables update. Each table must exist when the feature is created. Feature Store doesn't confirm that the pipeline reads from these - tables. At most 100 tables. + tables. At most 25 tables. """ output_table: VariableOrOptional[str] diff --git a/python/databricks/bundles/jobs/_models/confidential_compute_type.py b/python/databricks/bundles/jobs/_models/confidential_compute_type.py index e881295bd47..c3ff157557b 100644 --- a/python/databricks/bundles/jobs/_models/confidential_compute_type.py +++ b/python/databricks/bundles/jobs/_models/confidential_compute_type.py @@ -6,8 +6,6 @@ class ConfidentialComputeType(Enum): """ - :meta private: [EXPERIMENTAL] - Confidential computing technology for GCP instances. Aligns with gcloud's --confidential-compute-type flag and the REST API's confidentialInstanceConfig.confidentialInstanceType field. diff --git a/python/databricks/bundles/jobs/_models/cron_schedule.py b/python/databricks/bundles/jobs/_models/cron_schedule.py index 3c8a37992af..70d688ef87e 100644 --- a/python/databricks/bundles/jobs/_models/cron_schedule.py +++ b/python/databricks/bundles/jobs/_models/cron_schedule.py @@ -39,7 +39,7 @@ class CronSchedule: """ :meta private: [EXPERIMENTAL] - [Private Preview] SQL condition that must be satisfied before a scheduled run is triggered. The condition is evaluated + [Beta] SQL condition that must be satisfied before a scheduled run is triggered. The condition is evaluated after the cron expression fires and must return a truthy result for the run to proceed. """ @@ -73,7 +73,7 @@ class CronScheduleDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] SQL condition that must be satisfied before a scheduled run is triggered. The condition is evaluated + [Beta] SQL condition that must be satisfied before a scheduled run is triggered. The condition is evaluated after the cron expression fires and must return a truthy result for the run to proceed. """ diff --git a/python/databricks/bundles/jobs/_models/gcp_attributes.py b/python/databricks/bundles/jobs/_models/gcp_attributes.py index 2874f9da8e4..d724c73c29f 100644 --- a/python/databricks/bundles/jobs/_models/gcp_attributes.py +++ b/python/databricks/bundles/jobs/_models/gcp_attributes.py @@ -40,7 +40,7 @@ class GcpAttributes: """ :meta private: [EXPERIMENTAL] - [Private Preview] The confidential computing technology for this cluster's instances. + [Beta] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ @@ -116,7 +116,7 @@ class GcpAttributesDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] The confidential computing technology for this cluster's instances. + [Beta] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ diff --git a/python/databricks/bundles/jobs/_models/sql_condition_configuration.py b/python/databricks/bundles/jobs/_models/sql_condition_configuration.py index f6b2da80685..3115d708f59 100644 --- a/python/databricks/bundles/jobs/_models/sql_condition_configuration.py +++ b/python/databricks/bundles/jobs/_models/sql_condition_configuration.py @@ -17,29 +17,27 @@ @dataclass(kw_only=True) class SqlConditionConfiguration: - """ - :meta private: [EXPERIMENTAL] - """ + """""" sql_query_id: VariableOr[str] """ :meta private: [EXPERIMENTAL] - [Private Preview] The ID of the SQL query to evaluate as the trigger condition. + [Beta] The ID of the SQL query to evaluate as the trigger condition. """ warehouse_id: VariableOr[str] """ :meta private: [EXPERIMENTAL] - [Private Preview] The canonical identifier of the SQL warehouse to run the condition query against. + [Beta] The canonical identifier of the SQL warehouse to run the condition query against. """ trigger_mode: VariableOrOptional[SqlConditionTriggerMode] = None """ :meta private: [EXPERIMENTAL] - [Private Preview] Determines how the SQL query result is interpreted to decide whether the condition fires. + [Beta] Determines how the SQL query result is interpreted to decide whether the condition fires. Must be set to a recognized value when provided. When unset on an existing serialized configuration, the server preserves the original semantics by interpreting it as `QUERY_RETURNS_ROWS`. New configurations should set this @@ -61,21 +59,21 @@ class SqlConditionConfigurationDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] The ID of the SQL query to evaluate as the trigger condition. + [Beta] The ID of the SQL query to evaluate as the trigger condition. """ warehouse_id: VariableOr[str] """ :meta private: [EXPERIMENTAL] - [Private Preview] The canonical identifier of the SQL warehouse to run the condition query against. + [Beta] The canonical identifier of the SQL warehouse to run the condition query against. """ trigger_mode: VariableOrOptional[SqlConditionTriggerModeParam] """ :meta private: [EXPERIMENTAL] - [Private Preview] Determines how the SQL query result is interpreted to decide whether the condition fires. + [Beta] Determines how the SQL query result is interpreted to decide whether the condition fires. Must be set to a recognized value when provided. When unset on an existing serialized configuration, the server preserves the original semantics by interpreting it as `QUERY_RETURNS_ROWS`. New configurations should set this diff --git a/python/databricks/bundles/jobs/_models/sql_condition_trigger_mode.py b/python/databricks/bundles/jobs/_models/sql_condition_trigger_mode.py index c2b8472faea..c05cd174670 100644 --- a/python/databricks/bundles/jobs/_models/sql_condition_trigger_mode.py +++ b/python/databricks/bundles/jobs/_models/sql_condition_trigger_mode.py @@ -6,8 +6,6 @@ class SqlConditionTriggerMode(Enum): """ - :meta private: [EXPERIMENTAL] - The strategy used to evaluate a SQL condition trigger against a query result set. * `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`: Sentinel zero-value. Not a valid input — the @@ -16,8 +14,8 @@ class SqlConditionTriggerMode(Enum): * `QUERY_RETURNS_ROWS`: Fires whenever the result set has at least one row. Zero rows means the condition is not met. This is the original SQL condition behavior. * `RESULT_VALUE_CHANGES`: Fires whenever the query's single result value differs from the - previous evaluation. The first evaluation always fires. Queries must return exactly one - cell (one row, one column). + previous evaluation. The first evaluation stores the result as a baseline and does not + fire. Queries must return exactly one cell (one row, one column). """ QUERY_RETURNS_ROWS = "QUERY_RETURNS_ROWS" diff --git a/python/databricks/bundles/jobs/_models/subscription.py b/python/databricks/bundles/jobs/_models/subscription.py index a4720b891e5..b4526d3730c 100644 --- a/python/databricks/bundles/jobs/_models/subscription.py +++ b/python/databricks/bundles/jobs/_models/subscription.py @@ -25,7 +25,7 @@ class Subscription: attachment: VariableOrOptional[SubscriptionAttachment] = None """ - [Public Preview] Optional: The configuration for the files attached to the dashboard snapshot notification. It + Optional: The configuration for the files attached to the dashboard snapshot notification. It controls the underlying data of dashboard widgets that is attached as data files and which pages are included in the attached PDF. If not specified, the notification is sent with only the default snapshot. @@ -60,7 +60,7 @@ class SubscriptionDict(TypedDict, total=False): attachment: VariableOrOptional[SubscriptionAttachmentParam] """ - [Public Preview] Optional: The configuration for the files attached to the dashboard snapshot notification. It + Optional: The configuration for the files attached to the dashboard snapshot notification. It controls the underlying data of dashboard widgets that is attached as data files and which pages are included in the attached PDF. If not specified, the notification is sent with only the default snapshot. diff --git a/python/databricks/bundles/jobs/_models/subscription_attachment.py b/python/databricks/bundles/jobs/_models/subscription_attachment.py index 1ec3ab16427..ce18832323c 100644 --- a/python/databricks/bundles/jobs/_models/subscription_attachment.py +++ b/python/databricks/bundles/jobs/_models/subscription_attachment.py @@ -30,13 +30,13 @@ class SubscriptionAttachment: data_attachment: VariableOrOptional[SubscriptionAttachmentDataAttachment] = None """ - [Public Preview] Optional: The configuration for the underlying data of dashboard widgets attached as tabular + Optional: The configuration for the underlying data of dashboard widgets attached as tabular data files. If not specified, no tabular data is attached. """ page_attachment: VariableOrOptional[SubscriptionAttachmentPageAttachment] = None """ - [Public Preview] Optional: The selection of dashboard pages included in the attached PDF. If not specified, + Optional: The selection of dashboard pages included in the attached PDF. If not specified, only the first page is included. """ @@ -53,13 +53,13 @@ class SubscriptionAttachmentDict(TypedDict, total=False): data_attachment: VariableOrOptional[SubscriptionAttachmentDataAttachmentParam] """ - [Public Preview] Optional: The configuration for the underlying data of dashboard widgets attached as tabular + Optional: The configuration for the underlying data of dashboard widgets attached as tabular data files. If not specified, no tabular data is attached. """ page_attachment: VariableOrOptional[SubscriptionAttachmentPageAttachmentParam] """ - [Public Preview] Optional: The selection of dashboard pages included in the attached PDF. If not specified, + Optional: The selection of dashboard pages included in the attached PDF. If not specified, only the first page is included. """ diff --git a/python/databricks/bundles/jobs/_models/subscription_attachment_data_attachment.py b/python/databricks/bundles/jobs/_models/subscription_attachment_data_attachment.py index 651a3b0236c..19fa0a363e5 100644 --- a/python/databricks/bundles/jobs/_models/subscription_attachment_data_attachment.py +++ b/python/databricks/bundles/jobs/_models/subscription_attachment_data_attachment.py @@ -33,12 +33,12 @@ class SubscriptionAttachmentDataAttachment: file_format: VariableOr[SubscriptionAttachmentDataAttachmentFileFormat] """ - [Public Preview] The file format of the exported tabular data files. + The file format of the exported tabular data files. """ include_applied_filters: VariableOrOptional[bool] = None """ - [Public Preview] When true, the dashboard's applied filter values are included alongside the tabular data as + When true, the dashboard's applied filter values are included alongside the tabular data as an additional attached file. """ @@ -46,7 +46,7 @@ class SubscriptionAttachmentDataAttachment: default_factory=list ) """ - [Public Preview] The widgets whose underlying data is exported. At least one widget must be referenced. + The widgets whose underlying data is exported. At least one widget must be referenced. """ @classmethod @@ -62,18 +62,18 @@ class SubscriptionAttachmentDataAttachmentDict(TypedDict, total=False): file_format: VariableOr[SubscriptionAttachmentDataAttachmentFileFormatParam] """ - [Public Preview] The file format of the exported tabular data files. + The file format of the exported tabular data files. """ include_applied_filters: VariableOrOptional[bool] """ - [Public Preview] When true, the dashboard's applied filter values are included alongside the tabular data as + When true, the dashboard's applied filter values are included alongside the tabular data as an additional attached file. """ widgets: VariableOrList[SubscriptionAttachmentDataAttachmentWidgetParam] """ - [Public Preview] The widgets whose underlying data is exported. At least one widget must be referenced. + The widgets whose underlying data is exported. At least one widget must be referenced. """ diff --git a/python/databricks/bundles/jobs/_models/subscription_attachment_data_attachment_widget.py b/python/databricks/bundles/jobs/_models/subscription_attachment_data_attachment_widget.py index e5db963c65c..51e0374b42c 100644 --- a/python/databricks/bundles/jobs/_models/subscription_attachment_data_attachment_widget.py +++ b/python/databricks/bundles/jobs/_models/subscription_attachment_data_attachment_widget.py @@ -21,14 +21,14 @@ class SubscriptionAttachmentDataAttachmentWidget: page_id: VariableOr[str] """ - [Public Preview] The URL identifier of the page containing the widget. This is the value of the `name` + The URL identifier of the page containing the widget. This is the value of the `name` field of the corresponding entry under `pages` in the serialized dashboard definition. Format: alphanumeric, hyphen, and underscore characters allowed, max length 63. """ widget_id: VariableOr[str] """ - [Public Preview] The URL identifier of the widget. This is the value of the `name` field of the + The URL identifier of the widget. This is the value of the `name` field of the corresponding widget under that page's `layout` in the serialized dashboard definition. Format: alphanumeric, hyphen, and underscore characters allowed, max length 63. """ @@ -48,14 +48,14 @@ class SubscriptionAttachmentDataAttachmentWidgetDict(TypedDict, total=False): page_id: VariableOr[str] """ - [Public Preview] The URL identifier of the page containing the widget. This is the value of the `name` + The URL identifier of the page containing the widget. This is the value of the `name` field of the corresponding entry under `pages` in the serialized dashboard definition. Format: alphanumeric, hyphen, and underscore characters allowed, max length 63. """ widget_id: VariableOr[str] """ - [Public Preview] The URL identifier of the widget. This is the value of the `name` field of the + The URL identifier of the widget. This is the value of the `name` field of the corresponding widget under that page's `layout` in the serialized dashboard definition. Format: alphanumeric, hyphen, and underscore characters allowed, max length 63. """ diff --git a/python/databricks/bundles/jobs/_models/subscription_attachment_page_attachment.py b/python/databricks/bundles/jobs/_models/subscription_attachment_page_attachment.py index e527f7166f7..4d4bfdeac2b 100644 --- a/python/databricks/bundles/jobs/_models/subscription_attachment_page_attachment.py +++ b/python/databricks/bundles/jobs/_models/subscription_attachment_page_attachment.py @@ -24,7 +24,7 @@ class SubscriptionAttachmentPageAttachment: page_ids: VariableOrList[str] = field(default_factory=list) """ - [Public Preview] The identifiers of the pages to include in the PDF. Only specified when `page_selection` is + The identifiers of the pages to include in the PDF. Only specified when `page_selection` is `PAGE_SELECTION_SUBSET`. Each value is the identifier of a page in the dashboard's serialized definition returned by the Get dashboard API (`serialized_dashboard`): the value of the `name` field of an entry under `pages`. @@ -35,7 +35,7 @@ class SubscriptionAttachmentPageAttachment: SubscriptionAttachmentPageAttachmentPageSelection ] = None """ - [Public Preview] How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to + How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to include are listed in `page_ids`. """ @@ -52,7 +52,7 @@ class SubscriptionAttachmentPageAttachmentDict(TypedDict, total=False): page_ids: VariableOrList[str] """ - [Public Preview] The identifiers of the pages to include in the PDF. Only specified when `page_selection` is + The identifiers of the pages to include in the PDF. Only specified when `page_selection` is `PAGE_SELECTION_SUBSET`. Each value is the identifier of a page in the dashboard's serialized definition returned by the Get dashboard API (`serialized_dashboard`): the value of the `name` field of an entry under `pages`. @@ -63,7 +63,7 @@ class SubscriptionAttachmentPageAttachmentDict(TypedDict, total=False): SubscriptionAttachmentPageAttachmentPageSelectionParam ] """ - [Public Preview] How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to + How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to include are listed in `page_ids`. """ diff --git a/python/databricks/bundles/jobs/_models/trigger_configuration.py b/python/databricks/bundles/jobs/_models/trigger_configuration.py index 78f40fc76ae..0e89059f6e3 100644 --- a/python/databricks/bundles/jobs/_models/trigger_configuration.py +++ b/python/databricks/bundles/jobs/_models/trigger_configuration.py @@ -107,7 +107,7 @@ class TriggerConfiguration: """ :meta private: [EXPERIMENTAL] - [Private Preview] Optional SQL condition that gates whether this trigger fires. + [Beta] Optional SQL condition that gates whether this trigger fires. """ table_update: VariableOrOptional[TableUpdateTriggerConfiguration] = None @@ -182,7 +182,7 @@ class TriggerConfigurationDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] Optional SQL condition that gates whether this trigger fires. + [Beta] Optional SQL condition that gates whether this trigger fires. """ table_update: VariableOrOptional[TableUpdateTriggerConfigurationParam] diff --git a/python/databricks/bundles/jobs/_models/trigger_settings.py b/python/databricks/bundles/jobs/_models/trigger_settings.py index 42044a88493..97168198063 100644 --- a/python/databricks/bundles/jobs/_models/trigger_settings.py +++ b/python/databricks/bundles/jobs/_models/trigger_settings.py @@ -73,7 +73,7 @@ class TriggerSettings: """ :meta private: [EXPERIMENTAL] - [Private Preview] SQL condition that must be satisfied for the trigger to fire. Can be used in combination with other trigger types and + [Beta] SQL condition that must be satisfied for the trigger to fire. Can be used in combination with other trigger types and runs *after* other trigger types conditions are evaluated. """ @@ -123,7 +123,7 @@ class TriggerSettingsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] SQL condition that must be satisfied for the trigger to fire. Can be used in combination with other trigger types and + [Beta] SQL condition that must be satisfied for the trigger to fire. Can be used in combination with other trigger types and runs *after* other trigger types conditions are evaluated. """ diff --git a/python/databricks/bundles/materialization_sets/__init__.py b/python/databricks/bundles/materialization_sets/__init__.py index a7e26eaaf07..ef0c3a9fac6 100644 --- a/python/databricks/bundles/materialization_sets/__init__.py +++ b/python/databricks/bundles/materialization_sets/__init__.py @@ -9,6 +9,9 @@ "DependsOn", "DependsOnDict", "DependsOnParam", + "ExternalTrigger", + "ExternalTriggerDict", + "ExternalTriggerParam", "Lifecycle", "LifecycleDict", "LifecycleParam", @@ -60,6 +63,11 @@ DependsOnDict, DependsOnParam, ) +from databricks.bundles.materialization_sets._models.external_trigger import ( + ExternalTrigger, + ExternalTriggerDict, + ExternalTriggerParam, +) from databricks.bundles.materialization_sets._models.lifecycle import ( Lifecycle, LifecycleDict, diff --git a/python/databricks/bundles/materialization_sets/_models/cron_schedule.py b/python/databricks/bundles/materialization_sets/_models/cron_schedule.py index 72fb5d3aedb..54998af980c 100644 --- a/python/databricks/bundles/materialization_sets/_models/cron_schedule.py +++ b/python/databricks/bundles/materialization_sets/_models/cron_schedule.py @@ -38,6 +38,19 @@ class CronSchedule: [Private Preview] How the schedule is determined. Defaults to MANUAL when unset. """ + paused: VariableOrOptional[bool] = None + """ + :meta private: [EXPERIMENTAL] + + [Private Preview] Whether automatic materialization is paused. Defaults to `false`. + Supported only for materializations in a materialization set. + Use the `UpdateMaterializationSet` API to pause or resume the set. + + Pausing does not cancel running or queued runs. Runs can still be + triggered through the `TriggerMaterializationSet` API. Resuming does + not submit a run. Creating a paused materialization skips its initial run. + """ + timezone_id: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] @@ -73,6 +86,19 @@ class CronScheduleDict(TypedDict, total=False): [Private Preview] How the schedule is determined. Defaults to MANUAL when unset. """ + paused: VariableOrOptional[bool] + """ + :meta private: [EXPERIMENTAL] + + [Private Preview] Whether automatic materialization is paused. Defaults to `false`. + Supported only for materializations in a materialization set. + Use the `UpdateMaterializationSet` API to pause or resume the set. + + Pausing does not cancel running or queued runs. Runs can still be + triggered through the `TriggerMaterializationSet` API. Resuming does + not submit a run. Creating a paused materialization skips its initial run. + """ + timezone_id: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] diff --git a/python/databricks/bundles/materialization_sets/_models/external_trigger.py b/python/databricks/bundles/materialization_sets/_models/external_trigger.py new file mode 100644 index 00000000000..da106747a5a --- /dev/null +++ b/python/databricks/bundles/materialization_sets/_models/external_trigger.py @@ -0,0 +1,35 @@ +# Code generated by pydabs-codegen. DO NOT EDIT. + +from dataclasses import dataclass +from typing import TYPE_CHECKING, TypedDict + +from databricks.bundles.core._transform import _transform +from databricks.bundles.core._transform_to_json import _transform_to_json_value + +if TYPE_CHECKING: + from typing_extensions import Self + + +@dataclass(kw_only=True) +class ExternalTrigger: + """ + :meta private: [EXPERIMENTAL] + + A trigger that disables automatic materialization, including the initial run + at creation. Runs are instead triggered through the `TriggerMaterializationSet` + API. Supported only for batch materializations in a materialization set. + """ + + @classmethod + def from_dict(cls, value: "ExternalTriggerDict") -> "Self": + return _transform(cls, value) + + def as_dict(self) -> "ExternalTriggerDict": + return _transform_to_json_value(self) # type:ignore + + +class ExternalTriggerDict(TypedDict, total=False): + """""" + + +ExternalTriggerParam = ExternalTriggerDict | ExternalTrigger diff --git a/python/databricks/bundles/materialization_sets/_models/materialized_feature.py b/python/databricks/bundles/materialization_sets/_models/materialized_feature.py index f4ac4fe7408..b94699ef880 100644 --- a/python/databricks/bundles/materialization_sets/_models/materialized_feature.py +++ b/python/databricks/bundles/materialization_sets/_models/materialized_feature.py @@ -14,6 +14,10 @@ CronSchedule, CronScheduleParam, ) +from databricks.bundles.materialization_sets._models.external_trigger import ( + ExternalTrigger, + ExternalTriggerParam, +) from databricks.bundles.materialization_sets._models.offline_store_config import ( OfflineStoreConfig, OfflineStoreConfigParam, @@ -61,6 +65,15 @@ class MaterializedFeature: A cron-based schedule trigger for batch materialization. """ + external_trigger: VariableOrOptional[ExternalTrigger] = None + """ + :meta private: [EXPERIMENTAL] + + [Private Preview] A trigger that disables automatic materialization, including the initial run + at creation. Runs are instead triggered through the `TriggerMaterializationSet` + API. Supported only for batch materializations in a materialization set. + """ + materialized_feature_id: VariableOrOptional[str] = None """ Server-assigned unique identifier for the materialized feature. @@ -132,6 +145,15 @@ class MaterializedFeatureDict(TypedDict, total=False): A cron-based schedule trigger for batch materialization. """ + external_trigger: VariableOrOptional[ExternalTriggerParam] + """ + :meta private: [EXPERIMENTAL] + + [Private Preview] A trigger that disables automatic materialization, including the initial run + at creation. Runs are instead triggered through the `TriggerMaterializationSet` + API. Supported only for batch materializations in a materialization set. + """ + materialized_feature_id: VariableOrOptional[str] """ Server-assigned unique identifier for the materialized feature. diff --git a/python/databricks/bundles/materialization_sets/_models/table_trigger.py b/python/databricks/bundles/materialization_sets/_models/table_trigger.py index d4c2123656b..fb3062e352d 100644 --- a/python/databricks/bundles/materialization_sets/_models/table_trigger.py +++ b/python/databricks/bundles/materialization_sets/_models/table_trigger.py @@ -42,6 +42,19 @@ class TableTrigger: between 5 minutes and 1 hour. Other features have no minimum. """ + paused: VariableOrOptional[bool] = None + """ + :meta private: [EXPERIMENTAL] + + [Private Preview] Whether automatic materialization is paused. Defaults to `false`. + Supported only for materializations in a materialization set. + Use the `UpdateMaterializationSet` API to pause or resume the set. + + Pausing does not cancel running or queued runs. Runs can still be + triggered through the `TriggerMaterializationSet` API. Resuming does + not submit a run. Creating a paused materialization skips its initial run. + """ + wait_after_last_change: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] @@ -79,6 +92,19 @@ class TableTriggerDict(TypedDict, total=False): between 5 minutes and 1 hour. Other features have no minimum. """ + paused: VariableOrOptional[bool] + """ + :meta private: [EXPERIMENTAL] + + [Private Preview] Whether automatic materialization is paused. Defaults to `false`. + Supported only for materializations in a materialization set. + Use the `UpdateMaterializationSet` API to pause or resume the set. + + Pausing does not cancel running or queued runs. Runs can still be + triggered through the `TriggerMaterializationSet` API. Resuming does + not submit a run. Creating a paused materialization skips its initial run. + """ + wait_after_last_change: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] diff --git a/python/databricks/bundles/model_services/_models/model_service_config_external_model_config.py b/python/databricks/bundles/model_services/_models/model_service_config_external_model_config.py index d82c7ad7d19..2ae916e555f 100644 --- a/python/databricks/bundles/model_services/_models/model_service_config_external_model_config.py +++ b/python/databricks/bundles/model_services/_models/model_service_config_external_model_config.py @@ -27,9 +27,7 @@ class ModelServiceConfigExternalModelConfig: model_provider_service: VariableOr[str] """ Resource name of the governed ModelProviderService that owns provider - auth and provider-specific configuration. The referenced - ModelProviderService also carries the provider type, so this message - does not surface it directly. + auth and provider-specific configuration. Format: `model-provider-services/{catalog}.{schema}.{model_provider_service}`. Each `{...}` component is capped at 255 characters individually. """ @@ -55,9 +53,7 @@ class ModelServiceConfigExternalModelConfigDict(TypedDict, total=False): model_provider_service: VariableOr[str] """ Resource name of the governed ModelProviderService that owns provider - auth and provider-specific configuration. The referenced - ModelProviderService also carries the provider type, so this message - does not surface it directly. + auth and provider-specific configuration. Format: `model-provider-services/{catalog}.{schema}.{model_provider_service}`. Each `{...}` component is capped at 255 characters individually. """ diff --git a/python/databricks/bundles/pipelines/_models/confidential_compute_type.py b/python/databricks/bundles/pipelines/_models/confidential_compute_type.py index e881295bd47..c3ff157557b 100644 --- a/python/databricks/bundles/pipelines/_models/confidential_compute_type.py +++ b/python/databricks/bundles/pipelines/_models/confidential_compute_type.py @@ -6,8 +6,6 @@ class ConfidentialComputeType(Enum): """ - :meta private: [EXPERIMENTAL] - Confidential computing technology for GCP instances. Aligns with gcloud's --confidential-compute-type flag and the REST API's confidentialInstanceConfig.confidentialInstanceType field. diff --git a/python/databricks/bundles/pipelines/_models/gcp_attributes.py b/python/databricks/bundles/pipelines/_models/gcp_attributes.py index 70768dd4921..bc5b9aefbc4 100644 --- a/python/databricks/bundles/pipelines/_models/gcp_attributes.py +++ b/python/databricks/bundles/pipelines/_models/gcp_attributes.py @@ -40,7 +40,7 @@ class GcpAttributes: """ :meta private: [EXPERIMENTAL] - [Private Preview] The confidential computing technology for this cluster's instances. + [Beta] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ @@ -116,7 +116,7 @@ class GcpAttributesDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] The confidential computing technology for this cluster's instances. + [Beta] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """