Workspace interface

Package:

@azure/arm-machinelearning

An object that represents a machine learning workspace.

Extends

ProxyResource

Properties

agentsEndpointUri	The URI of agents endpoint associated with this workspace.
allowPublicAccessWhenBehindVnet	The flag to indicate whether to allow public access when behind VNet.
allowRoleAssignmentOnRG	The flag to indicate whether we will do role assignment for the workspace MSI on resource group level.
applicationInsights	ARM id of the application insights associated with this workspace.
associatedWorkspaces
containerRegistries
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
enableServiceSideCMKEncryption
enableSimplifiedCmk	Flag to tell if simplified CMK should be enabled for this workspace.
enableSoftwareBillOfMaterials	Flag to tell if SoftwareBillOfMaterials should be enabled for this workspace.
encryption
existingWorkspaces
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 managed service identities assigned to this resource.
imageBuildCompute	The compute name for image build
ipAllowlist	The list of IPv4 addresses that are allowed to access the workspace.
keyVault	ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
keyVaults
kind
location
managedNetwork
mlFlowTrackingUri	The URI associated with this workspace that machine learning flow must point at to set up tracking.
networkAcls	A set of rules governing the network accessibility of the workspace.
notebookInfo	The notebook info of Azure ML workspace.
primaryUserAssignedIdentity	The user assigned identity resource id that represents the workspace identity.
privateEndpointConnections	The list of private endpoint connections in the workspace.
privateLinkCount	Count of private connections in the workspace
provisioningState	The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.
provisionNetworkNow	Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing.
publicNetworkAccess	Whether requests from Public Network are allowed.
serverlessComputeSettings	Settings for serverless compute in a 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
sharedPrivateLinkResources	The list of shared private link resources in this workspace.
sku	Optional. This field is required to be implemented by the RP because AML is supporting more than one tier
softDeleteRetentionInDays	Retention time in days after workspace get soft deleted.
storageAccount	ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
storageAccounts
storageHnsEnabled	If the storage associated with the workspace has hierarchical namespace(HNS) enabled.
systemDatastoresAuthMode	The auth mode used for accessing the system datastores of the workspace.
tags
tenantId	The tenant id associated with this workspace.
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.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

agentsEndpointUri

The URI of agents endpoint associated with this workspace.

agentsEndpointUri?: string

Property Value

string

allowPublicAccessWhenBehindVnet

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

allowPublicAccessWhenBehindVnet?: boolean

Property Value

boolean

allowRoleAssignmentOnRG

The flag to indicate whether we will do role assignment for the workspace MSI on resource group level.

allowRoleAssignmentOnRG?: 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[]

containerRegistries

containerRegistries?: 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

enableServiceSideCMKEncryption

enableServiceSideCMKEncryption?: boolean

Property Value

boolean

enableSimplifiedCmk

Flag to tell if simplified CMK should be enabled for this workspace.

enableSimplifiedCmk?: boolean

Property Value

boolean

enableSoftwareBillOfMaterials

Flag to tell if SoftwareBillOfMaterials should be enabled for this workspace.

enableSoftwareBillOfMaterials?: boolean

Property Value

boolean

encryption

encryption?: EncryptionProperty

Property Value

EncryptionProperty

existingWorkspaces

existingWorkspaces?: string[]

Property Value

string[]

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 managed service identities assigned to this resource.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

imageBuildCompute

The compute name for image build

imageBuildCompute?: string

Property Value

string

ipAllowlist

The list of IPv4 addresses that are allowed to access the workspace.

ipAllowlist?: 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

keyVaults

keyVaults?: string[]

Property Value

string[]

kind

kind?: string

Property Value

string

location

location?: string

Property Value

string

managedNetwork

managedNetwork?: ManagedNetworkSettings

Property Value

ManagedNetworkSettings

mlFlowTrackingUri

The URI associated with this workspace that machine learning flow must point at to set up tracking.

mlFlowTrackingUri?: string

Property Value

string

networkAcls

A set of rules governing the network accessibility of the workspace.

networkAcls?: NetworkAcls

Property Value

NetworkAcls

notebookInfo

The notebook info of Azure ML workspace.

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.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

privateLinkCount

Count of private connections in the workspace

privateLinkCount?: number

Property Value

number

provisioningState

The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.

provisioningState?: string

Property Value

string

provisionNetworkNow

Set to trigger the provisioning of the managed VNet with the default Options when creating a Workspace with the managed VNet enabled, or else it does nothing.

provisionNetworkNow?: boolean

Property Value

boolean

publicNetworkAccess

Whether requests from Public Network are allowed.

publicNetworkAccess?: string

Property Value

string

serverlessComputeSettings

Settings for serverless compute in a 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

serviceProvisionedResourceGroup?: string

Property Value

string

sharedPrivateLinkResources

The list of shared private link resources in this workspace.

sharedPrivateLinkResources?: SharedPrivateLinkResource[]

Property Value

SharedPrivateLinkResource[]

sku

Optional. This field is required to be implemented by the RP because AML is supporting more than one tier

sku?: Sku

Property Value

Sku

softDeleteRetentionInDays

Retention time in days after workspace get soft deleted.

softDeleteRetentionInDays?: number

Property Value

number

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

storageAccounts

storageAccounts?: string[]

Property Value

string[]

storageHnsEnabled

If the storage associated with the workspace has hierarchical namespace(HNS) enabled.

storageHnsEnabled?: boolean

Property Value

boolean

systemDatastoresAuthMode

The auth mode used for accessing the system datastores of the workspace.

systemDatastoresAuthMode?: string

Property Value

string

tags

tags?: Record<string, string>

Property Value

Record<string, string>

tenantId

The tenant id associated with this workspace.

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.

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}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type