@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
101 lines (100 loc) • 4.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* The `databricks.AibiDashboardEmbeddingAccessPolicySetting` resource allows you to control [embedding of AI/BI Dashboards](https://learn.microsoft.com/en-us/azure/databricks/dashboards/admin/#manage-dashboard-embedding) into other sites.
*
* > This resource can only be used with a workspace-level provider!
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = new databricks.AibiDashboardEmbeddingAccessPolicySetting("this", {aibiDashboardEmbeddingAccessPolicy: {
* accessPolicyType: "ALLOW_APPROVED_DOMAINS",
* }});
* ```
*
* ## Related Resources
*
* The following resources are often used in the same context:
*
* - databricks.AibiDashboardEmbeddingApprovedDomainsSetting is used to control approved domains.
*
* ## Import
*
* This resource can be imported by predefined name `global`:
*
* hcl
*
* import {
*
* to = databricks_aibi_dashboard_embedding_access_policy_setting.this
*
* id = "global"
*
* }
*
* Alternatively, when using `terraform` version 1.4 or earlier, import using the `pulumi import` command:
*
* bash
*
* ```sh
* $ pulumi import databricks:index/aibiDashboardEmbeddingAccessPolicySetting:AibiDashboardEmbeddingAccessPolicySetting this global
* ```
*/
export declare class AibiDashboardEmbeddingAccessPolicySetting extends pulumi.CustomResource {
/**
* Get an existing AibiDashboardEmbeddingAccessPolicySetting resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AibiDashboardEmbeddingAccessPolicySettingState, opts?: pulumi.CustomResourceOptions): AibiDashboardEmbeddingAccessPolicySetting;
/**
* Returns true if the given object is an instance of AibiDashboardEmbeddingAccessPolicySetting. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AibiDashboardEmbeddingAccessPolicySetting;
/**
* block with following attributes:
*/
readonly aibiDashboardEmbeddingAccessPolicy: pulumi.Output<outputs.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy>;
readonly etag: pulumi.Output<string>;
readonly settingName: pulumi.Output<string>;
/**
* Create a AibiDashboardEmbeddingAccessPolicySetting resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AibiDashboardEmbeddingAccessPolicySettingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AibiDashboardEmbeddingAccessPolicySetting resources.
*/
export interface AibiDashboardEmbeddingAccessPolicySettingState {
/**
* block with following attributes:
*/
aibiDashboardEmbeddingAccessPolicy?: pulumi.Input<inputs.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy>;
etag?: pulumi.Input<string>;
settingName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AibiDashboardEmbeddingAccessPolicySetting resource.
*/
export interface AibiDashboardEmbeddingAccessPolicySettingArgs {
/**
* block with following attributes:
*/
aibiDashboardEmbeddingAccessPolicy: pulumi.Input<inputs.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy>;
etag?: pulumi.Input<string>;
settingName?: pulumi.Input<string>;
}