Workspace interface

Package:

@azure/arm-machinelearning

An object that represents a machine learning workspace.

Extends

Resource

Properties

allowPublicAccessWhenBehindVnet	The flag to indicate whether to allow public access when behind VNet.
applicationInsights	ARM id of the application insights associated with this workspace.
associatedWorkspaces
containerRegistry	ARM id of the container registry associated with this workspace.
description	The description of this workspace.
discoveryUrl	Url for the discovery service to identify regional endpoints for machine learning experimentation services
enableDataIsolation
encryption	The encryption settings of Azure ML workspace.
featureStoreSettings	Settings for feature store type workspace.
friendlyName	The friendly name for this workspace. This name in mutable
hbiWorkspace	The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
hubResourceId
identity	The identity of the resource.
imageBuildCompute	The compute name for image build
keyVault	ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
kind
location	Specifies the location of the resource.
managedNetwork	Managed Network settings for a machine learning workspace.
mlFlowTrackingUri	The URI associated with this workspace that machine learning flow must point at to set up tracking. NOTE: This property will not be serialized. It can only be populated by the server.
notebookInfo	The notebook info of Azure ML workspace. NOTE: This property will not be serialized. It can only be populated by the server.
primaryUserAssignedIdentity	The user assigned identity resource id that represents the workspace identity.
privateEndpointConnections	The list of private endpoint connections in the workspace. NOTE: This property will not be serialized. It can only be populated by the server.
privateLinkCount	Count of private connections in the workspace NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess	Whether requests from Public Network are allowed.
serverlessComputeSettings	Settings for serverless compute created in the workspace
serviceManagedResourcesSettings	The service managed resource settings.
serviceProvisionedResourceGroup	The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace NOTE: This property will not be serialized. It can only be populated by the server.
sharedPrivateLinkResources	The list of shared private link resources in this workspace.
sku	The sku of the workspace.
storageAccount	ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
storageHnsEnabled	If the storage associated with the workspace has hierarchical namespace(HNS) enabled. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Contains resource tags defined as key/value pairs.
tenantId	The tenant id associated with this workspace. NOTE: This property will not be serialized. It can only be populated by the server.
v1LegacyMode	Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.
workspaceHubConfig	WorkspaceHub's configuration object.
workspaceId	The immutable id associated with this workspace. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	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.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	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.

Property Details

allowPublicAccessWhenBehindVnet

The flag to indicate whether to allow public access when behind VNet.

allowPublicAccessWhenBehindVnet?: boolean

Property Value

boolean

applicationInsights

ARM id of the application insights associated with this workspace.

applicationInsights?: string

Property Value

string

associatedWorkspaces

associatedWorkspaces?: string[]

Property Value

string[]

containerRegistry

ARM id of the container registry associated with this workspace.

containerRegistry?: string

Property Value

string

description

The description of this workspace.

description?: string

Property Value

string

discoveryUrl

Url for the discovery service to identify regional endpoints for machine learning experimentation services

discoveryUrl?: string

Property Value

string

enableDataIsolation

enableDataIsolation?: boolean

Property Value

boolean

encryption

The encryption settings of Azure ML workspace.

encryption?: EncryptionProperty

Property Value

EncryptionProperty

featureStoreSettings

Settings for feature store type workspace.

featureStoreSettings?: FeatureStoreSettings

Property Value

FeatureStoreSettings

friendlyName

The friendly name for this workspace. This name in mutable

friendlyName?: string

Property Value

string

hbiWorkspace

The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service

hbiWorkspace?: boolean

Property Value

boolean

hubResourceId

hubResourceId?: string

Property Value

string

identity

The identity of the resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

imageBuildCompute

The compute name for image build

imageBuildCompute?: string

Property Value

string

keyVault

ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created

keyVault?: string

Property Value

string

kind

kind?: string

Property Value

string

location

Specifies the location of the resource.

location?: string

Property Value

string

managedNetwork

Managed Network settings for a machine learning workspace.

managedNetwork?: ManagedNetworkSettings

Property Value

ManagedNetworkSettings

mlFlowTrackingUri

The URI associated with this workspace that machine learning flow must point at to set up tracking. NOTE: This property will not be serialized. It can only be populated by the server.

mlFlowTrackingUri?: string

Property Value

string

notebookInfo

The notebook info of Azure ML workspace. NOTE: This property will not be serialized. It can only be populated by the server.

notebookInfo?: NotebookResourceInfo

Property Value

NotebookResourceInfo

primaryUserAssignedIdentity

The user assigned identity resource id that represents the workspace identity.

primaryUserAssignedIdentity?: string

Property Value

string

privateEndpointConnections

The list of private endpoint connections in the workspace. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

privateLinkCount

Count of private connections in the workspace NOTE: This property will not be serialized. It can only be populated by the server.

privateLinkCount?: number

Property Value

number

provisioningState

The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

Whether requests from Public Network are allowed.

publicNetworkAccess?: string

Property Value

string

serverlessComputeSettings

Settings for serverless compute created in the workspace

serverlessComputeSettings?: ServerlessComputeSettings

Property Value

ServerlessComputeSettings

serviceManagedResourcesSettings

The service managed resource settings.

serviceManagedResourcesSettings?: ServiceManagedResourcesSettings

Property Value

ServiceManagedResourcesSettings

serviceProvisionedResourceGroup

The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace NOTE: This property will not be serialized. It can only be populated by the server.

serviceProvisionedResourceGroup?: string

Property Value

string

sharedPrivateLinkResources

The list of shared private link resources in this workspace.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Property Value

SharedPrivateLinkResource[]

sku

The sku of the workspace.

sku?: Sku

Property Value

Sku

storageAccount

ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created

storageAccount?: string

Property Value

string

storageHnsEnabled

If the storage associated with the workspace has hierarchical namespace(HNS) enabled. NOTE: This property will not be serialized. It can only be populated by the server.

storageHnsEnabled?: boolean

Property Value

boolean

tags

Contains resource tags defined as key/value pairs.

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

Property Value

{[propertyName: string]: string}

tenantId

The tenant id associated with this workspace. NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

Property Value

string

v1LegacyMode

Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.

v1LegacyMode?: boolean

Property Value

boolean

workspaceHubConfig

WorkspaceHub's configuration object.

workspaceHubConfig?: WorkspaceHubConfig

Property Value

WorkspaceHubConfig

workspaceId

The immutable id associated with this workspace. NOTE: This property will not be serialized. It can only be populated by the server.

workspaceId?: string

Property Value

string

Inherited Property Details

id

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.

id?: string

Property Value

string

Inherited From Resource.id

name

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

name?: string

Property Value

string

Inherited From Resource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From Resource.systemData

type

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.

type?: string

Property Value

string

Inherited From Resource.type