w.settings.aibi_dashboard_embedding_access_policy: AI/BI Dashboard Embedding Access Policy¶
- class databricks.sdk.service.settings.AibiDashboardEmbeddingAccessPolicyAPI¶
Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled at the workspace level. By default, this setting is conditionally enabled (ALLOW_APPROVED_DOMAINS).
- delete([, etag: Optional[str]]) DeleteAibiDashboardEmbeddingAccessPolicySettingResponse¶
Delete the AI/BI dashboard embedding access policy, reverting back to the default.
- Parameters:
etag – str (optional) etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> delete pattern to perform setting deletions in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the DELETE request to identify the rule set version you are deleting.
- Returns:
- get([, etag: Optional[str]]) AibiDashboardEmbeddingAccessPolicySetting¶
Retrieves the AI/BI dashboard embedding access policy. The default setting is ALLOW_APPROVED_DOMAINS, permitting AI/BI dashboards to be embedded on approved domains.
- Parameters:
etag – str (optional) etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> delete pattern to perform setting deletions in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the DELETE request to identify the rule set version you are deleting.
- Returns:
- update(allow_missing: bool, setting: AibiDashboardEmbeddingAccessPolicySetting, field_mask: str) AibiDashboardEmbeddingAccessPolicySetting¶
Updates the AI/BI dashboard embedding access policy at the workspace level.
- Parameters:
allow_missing – bool This should always be set to true for Settings API. Added for AIP compliance.
field_mask –
str The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (
.) to navigate sub-fields (e.g.,author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.A field mask of
*indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using*wildcards, as it can lead to unintended results if the API changes in the future.
- Returns: