Share via


Workspace Class

Definition

Information about workspace.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.WorkspaceTypeConverter))]
public class Workspace : Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace, Microsoft.Azure.PowerShell.Cmdlets.Databricks.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.WorkspaceTypeConverter))>]
type Workspace = class
    interface IWorkspace
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates
Public Class Workspace
Implements IValidates, IWorkspace
Inheritance
Workspace
Attributes
Implements

Constructors

Workspace()

Creates an new Workspace instance.

Properties

AccessConnectorId

The resource ID of Azure Databricks Access Connector Resource.

AccessConnectorIdentityType

The identity type of the Access Connector Resource.

AccessConnectorUserAssignedIdentityId

The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'.

AmlWorkspaceIdType

The type of variable that this is

AmlWorkspaceIdValue

The value which should be used for this field.

Authorization

The workspace provider authorizations.

AutomaticClusterUpdateValue
ComplianceSecurityProfileComplianceStandard

Compliance standards associated with the workspace.

ComplianceSecurityProfileValue
CreatedByApplicationId

The application ID of the application that initiated the creation of the workspace. For example, Azure Portal.

CreatedByOid

The Object ID that created the workspace.

CreatedByPuid

The Personal Object ID corresponding to the object ID above

CreatedDateTime

Specifies the date and time when the workspace is created.

CustomPrivateSubnetNameType

The type of variable that this is

CustomPrivateSubnetNameValue

The value which should be used for this field.

CustomPublicSubnetNameType

The type of variable that this is

CustomPublicSubnetNameValue

The value which should be used for this field.

CustomVirtualNetworkIdType

The type of variable that this is

CustomVirtualNetworkIdValue

The value which should be used for this field.

DefaultCatalogInitialName

Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used.

DefaultCatalogInitialType

Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog

DefaultStorageFirewall

Gets or Sets Default Storage Firewall configuration information

DiskEncryptionSetId

The resource Id of the managed disk encryption set.

EnableNoPublicIP

The value which should be used for this field.

EnableNoPublicIPType

The type of variable that this is

EncryptionKeyName

The name of KeyVault key.

EncryptionKeySource

The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault

EncryptionKeyVaultUri

The Uri of KeyVault.

EncryptionKeyVersion

The version of KeyVault key.

EncryptionType

The type of variable that this is

EnhancedSecurityMonitoringValue
Id

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

IsUcEnabled

Indicates whether unity catalog enabled for the workspace or not.

LoadBalancerBackendPoolNameType

The type of variable that this is

LoadBalancerBackendPoolNameValue

The value which should be used for this field.

LoadBalancerIdType

The type of variable that this is

LoadBalancerIdValue

The value which should be used for this field.

Location

The geo-location where the resource lives

ManagedDiskIdentityPrincipalId

The objectId of the Managed Identity that is linked to the Managed Storage account.

ManagedDiskIdentityTenantId

The tenant Id where the Managed Identity is created.

ManagedDiskIdentityType

The type of Identity created. It can be either SystemAssigned or UserAssigned.

ManagedDiskKeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault

ManagedDiskKeyVaultPropertiesKeyName

The name of KeyVault key.

ManagedDiskKeyVaultPropertiesKeyVaultUri

The URI of KeyVault.

ManagedDiskKeyVaultPropertiesKeyVersion

The version of KeyVault key.

ManagedDiskRotationToLatestKeyVersionEnabled

Indicate whether the latest key version should be automatically used for Managed Disk Encryption.

ManagedResourceGroupId

The managed resource group Id.

ManagedServiceKeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault

ManagedServicesKeyVaultPropertiesKeyName

The name of KeyVault key.

ManagedServicesKeyVaultPropertiesKeyVaultUri

The Uri of KeyVault.

ManagedServicesKeyVaultPropertiesKeyVersion

The version of KeyVault key.

Name

The name of the resource

NatGatewayNameType

The type of variable that this is

NatGatewayNameValue

The value which should be used for this field.

PrepareEncryption

The value which should be used for this field.

PrepareEncryptionType

The type of variable that this is

PrivateEndpointConnection

Private endpoint connections created on the workspace

ProvisioningState

The workspace provisioning state.

PublicIPNameType

The type of variable that this is

PublicIPNameValue

The value which should be used for this field.

PublicNetworkAccess

The network access type for accessing workspace. Set value to disabled to access workspace only via private link.

RequiredNsgRule

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.

RequireInfrastructureEncryption

The value which should be used for this field.

RequireInfrastructureEncryptionType

The type of variable that this is

ResourceGroupName

Gets the resource group name

ResourceTagType

The type of variable that this is

ResourceTagValue

The value which should be used for this field.

SkuName

The SKU name.

SkuTier

The SKU tier.

StorageAccountIdentityPrincipalId

The objectId of the Managed Identity that is linked to the Managed Storage account.

StorageAccountIdentityTenantId

The tenant Id where the Managed Identity is created.

StorageAccountIdentityType

The type of Identity created. It can be either SystemAssigned or UserAssigned.

StorageAccountNameType

The type of variable that this is

StorageAccountNameValue

The value which should be used for this field.

StorageAccountSkuNameType

The type of variable that this is

StorageAccountSkuNameValue

The value which should be used for this field.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Resource tags.

Type

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

UiDefinitionUri

The blob URI where the UI definition file is located.

UpdatedByApplicationId

The application ID of the application that initiated the creation of the workspace. For example, Azure Portal.

UpdatedByOid

The Object ID that created the workspace.

UpdatedByPuid

The Personal Object ID corresponding to the object ID above

Url

The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'

VnetAddressPrefixType

The type of variable that this is

VnetAddressPrefixValue

The value which should be used for this field.

WorkspaceId

The unique identifier of the databricks workspace in databricks control plane.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Workspace.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Workspace.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Databricks.Models.Api20240501.IWorkspace.

FromJsonString(String)

Creates a new instance of Workspace, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of Workspace into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to