@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 9.42 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Information about workspace.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
*
* Other available API versions: 2023-02-01, 2023-09-15-preview, 2024-09-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native databricks [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Workspace extends pulumi.CustomResource {
/**
* Get an existing Workspace 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Workspace;
/**
* Returns true if the given object is an instance of Workspace. 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 Workspace;
/**
* Access Connector Resource that is going to be associated with Databricks Workspace
*/
readonly accessConnector: pulumi.Output<outputs.databricks.WorkspacePropertiesResponseAccessConnector | undefined>;
/**
* The workspace provider authorizations.
*/
readonly authorizations: pulumi.Output<outputs.databricks.WorkspaceProviderAuthorizationResponse[] | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Indicates the Object ID, PUID and Application ID of entity that created the workspace.
*/
readonly createdBy: pulumi.Output<outputs.databricks.CreatedByResponse | undefined>;
/**
* Specifies the date and time when the workspace is created.
*/
readonly createdDateTime: pulumi.Output<string>;
/**
* Properties for Default Catalog configuration during workspace creation.
*/
readonly defaultCatalog: pulumi.Output<outputs.databricks.DefaultCatalogPropertiesResponse | undefined>;
/**
* Gets or Sets Default Storage Firewall configuration information
*/
readonly defaultStorageFirewall: pulumi.Output<string | undefined>;
/**
* The resource Id of the managed disk encryption set.
*/
readonly diskEncryptionSetId: pulumi.Output<string>;
/**
* Encryption properties for databricks workspace
*/
readonly encryption: pulumi.Output<outputs.databricks.WorkspacePropertiesResponseEncryption | undefined>;
/**
* Contains settings related to the Enhanced Security and Compliance Add-On.
*/
readonly enhancedSecurityCompliance: pulumi.Output<outputs.databricks.EnhancedSecurityComplianceDefinitionResponse | undefined>;
/**
* Indicates whether unity catalog enabled for the workspace or not.
*/
readonly isUcEnabled: pulumi.Output<boolean>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption
*/
readonly managedDiskIdentity: pulumi.Output<outputs.databricks.ManagedIdentityConfigurationResponse | undefined>;
/**
* The managed resource group Id.
*/
readonly managedResourceGroupId: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The workspace's custom parameters.
*/
readonly parameters: pulumi.Output<outputs.databricks.WorkspaceCustomParametersResponse | undefined>;
/**
* Private endpoint connections created on the workspace
*/
readonly privateEndpointConnections: pulumi.Output<outputs.databricks.PrivateEndpointConnectionResponse[]>;
/**
* The workspace provisioning state.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The network access type for accessing workspace. Set value to disabled to access workspace only via private link.
*/
readonly publicNetworkAccess: pulumi.Output<string | undefined>;
/**
* Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.
*/
readonly requiredNsgRules: pulumi.Output<string | undefined>;
/**
* The SKU of the resource.
*/
readonly sku: pulumi.Output<outputs.databricks.SkuResponse | undefined>;
/**
* The details of Managed Identity of Storage Account
*/
readonly storageAccountIdentity: pulumi.Output<outputs.databricks.ManagedIdentityConfigurationResponse | undefined>;
/**
* The system metadata relating to this resource
*/
readonly systemData: pulumi.Output<outputs.databricks.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
*/
readonly type: pulumi.Output<string>;
/**
* The blob URI where the UI definition file is located.
*/
readonly uiDefinitionUri: pulumi.Output<string | undefined>;
/**
* Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.
*/
readonly updatedBy: pulumi.Output<outputs.databricks.CreatedByResponse | undefined>;
/**
* The unique identifier of the databricks workspace in databricks control plane.
*/
readonly workspaceId: pulumi.Output<string>;
/**
* The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'
*/
readonly workspaceUrl: pulumi.Output<string>;
/**
* Create a Workspace 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: WorkspaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Workspace resource.
*/
export interface WorkspaceArgs {
/**
* Access Connector Resource that is going to be associated with Databricks Workspace
*/
accessConnector?: pulumi.Input<inputs.databricks.WorkspacePropertiesAccessConnectorArgs>;
/**
* The workspace provider authorizations.
*/
authorizations?: pulumi.Input<pulumi.Input<inputs.databricks.WorkspaceProviderAuthorizationArgs>[]>;
/**
* Properties for Default Catalog configuration during workspace creation.
*/
defaultCatalog?: pulumi.Input<inputs.databricks.DefaultCatalogPropertiesArgs>;
/**
* Gets or Sets Default Storage Firewall configuration information
*/
defaultStorageFirewall?: pulumi.Input<string | enums.databricks.DefaultStorageFirewall>;
/**
* Encryption properties for databricks workspace
*/
encryption?: pulumi.Input<inputs.databricks.WorkspacePropertiesEncryptionArgs>;
/**
* Contains settings related to the Enhanced Security and Compliance Add-On.
*/
enhancedSecurityCompliance?: pulumi.Input<inputs.databricks.EnhancedSecurityComplianceDefinitionArgs>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* The managed resource group Id.
*/
managedResourceGroupId: pulumi.Input<string>;
/**
* The workspace's custom parameters.
*/
parameters?: pulumi.Input<inputs.databricks.WorkspaceCustomParametersArgs>;
/**
* The network access type for accessing workspace. Set value to disabled to access workspace only via private link.
*/
publicNetworkAccess?: pulumi.Input<string | enums.databricks.PublicNetworkAccess>;
/**
* Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.
*/
requiredNsgRules?: pulumi.Input<string | enums.databricks.RequiredNsgRules>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The SKU of the resource.
*/
sku?: pulumi.Input<inputs.databricks.SkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The blob URI where the UI definition file is located.
*/
uiDefinitionUri?: pulumi.Input<string>;
/**
* The name of the workspace.
*/
workspaceName?: pulumi.Input<string>;
}