Package version:

Interface Workspace

A workspace

Hierarchy

Properties

adlaResourceId? connectivityEndpoints? defaultDataLakeStorage? encryption? extraProperties? id? identity? location managedResourceGroupName? managedVirtualNetwork? managedVirtualNetworkSettings? name? privateEndpointConnections? provisioningState? purviewConfiguration? sqlAdministratorLogin? sqlAdministratorLoginPassword? tags? type? virtualNetworkProfile? workspaceRepositoryConfiguration? workspaceUID?

Properties

Optional Readonly adlaResourceId

adlaResourceId?: string

The ADLA resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional connectivityEndpoints

connectivityEndpoints?: {
    [propertyName: string]: string;
}

Connectivity endpoints

Type declaration

  • [propertyName: string]: string

Optional defaultDataLakeStorage

defaultDataLakeStorage?: DataLakeStorageAccountDetails

Workspace default data lake storage account details

Optional encryption

encryption?: EncryptionDetails

The encryption details of the workspace

Optional Readonly extraProperties

extraProperties?: {
    [propertyName: string]: any;
}

Workspace level configs and feature flags NOTE: This property will not be serialized. It can only be populated by the server.

Type declaration

  • [propertyName: string]: any

Optional Readonly id

id?: string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

identity?: ManagedIdentity

Identity of the workspace

location

location: string

The geo-location where the resource lives

Optional managedResourceGroupName

managedResourceGroupName?: string

Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.'

Optional managedVirtualNetwork

managedVirtualNetwork?: string

Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.

Optional managedVirtualNetworkSettings

managedVirtualNetworkSettings?: ManagedVirtualNetworkSettings

Managed Virtual Network Settings

Optional Readonly name

name?: string

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Optional privateEndpointConnections

privateEndpointConnections?: PrivateEndpointConnection[]

Private endpoint connections to the workspace

Optional Readonly provisioningState

provisioningState?: string

Resource provisioning state NOTE: This property will not be serialized. It can only be populated by the server.

Optional purviewConfiguration

purviewConfiguration?: PurviewConfiguration

Purview Configuration

Optional sqlAdministratorLogin

sqlAdministratorLogin?: string

Login for workspace SQL active directory administrator

Optional sqlAdministratorLoginPassword

sqlAdministratorLoginPassword?: string

SQL administrator login password

Optional tags

tags?: {
    [propertyName: string]: string;
}

Resource tags.

Type declaration

  • [propertyName: string]: string

Optional Readonly type

type?: string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Optional virtualNetworkProfile

virtualNetworkProfile?: VirtualNetworkProfile

Virtual Network profile

Optional workspaceRepositoryConfiguration

workspaceRepositoryConfiguration?: WorkspaceRepositoryConfiguration

Git integration settings

Optional Readonly workspaceUID

workspaceUID?: string

The workspace unique identifier NOTE: This property will not be serialized. It can only be populated by the server.

Settings

Member Visibility

Theme

Generated using TypeDoc