Workspace Interface

Package:
com.azure.resourcemanager.machinelearning.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0

public interface Workspace

An immutable client-side representation of Workspace.

Method Summary

Modifier and Type Method and Description
abstract Boolean allowPublicAccessWhenBehindVnet()

Gets the allowPublicAccessWhenBehindVnet property: The flag to indicate whether to allow public access when behind VNet.
abstract String applicationInsights()

Gets the applicationInsights property: ARM id of the application insights associated with this workspace.
abstract List<String> associatedWorkspaces()

Gets the associatedWorkspaces property: The associatedWorkspaces property.
abstract String containerRegistry()

Gets the containerRegistry property: ARM id of the container registry associated with this workspace.
abstract String description()

Gets the description property: The description of this workspace.
abstract DiagnoseResponseResult diagnose()

Diagnose workspace setup issue.
abstract DiagnoseResponseResult diagnose(DiagnoseWorkspaceParameters parameters, Context context)

Diagnose workspace setup issue.
abstract String discoveryUrl()

Gets the discoveryUrl property: Url for the discovery service to identify regional endpoints for machine learning experimentation services.
abstract Boolean enableDataIsolation()

Gets the enableDataIsolation property: The enableDataIsolation property.
abstract EncryptionProperty encryption()

Gets the encryption property: The encryption settings of Azure ML workspace.
abstract FeatureStoreSettings featureStoreSettings()

Gets the featureStoreSettings property: Settings for feature store type workspace.
abstract String friendlyName()

Gets the friendlyName property: The friendly name for this workspace.
abstract Boolean hbiWorkspace()

Gets the hbiWorkspace property: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service.
abstract String hubResourceId()

Gets the hubResourceId property: The hubResourceId property.
abstract String id()

Gets the id property: Fully qualified resource Id for the resource.
abstract ManagedServiceIdentity identity()

Gets the identity property: The identity of the resource.
abstract String imageBuildCompute()

Gets the imageBuildCompute property: The compute name for image build.
abstract WorkspaceInner innerModel()

Gets the inner com.azure.resourcemanager.machinelearning.fluent.models.WorkspaceInner object.
abstract String keyVault()

Gets the keyVault property: ARM id of the key vault associated with this workspace.
abstract String kind()

Gets the kind property: The kind property.
abstract ListWorkspaceKeysResult listKeys()

Lists all the keys associated with this workspace.
abstract Response<ListWorkspaceKeysResult> listKeysWithResponse(Context context)

Lists all the keys associated with this workspace.
abstract NotebookAccessTokenResult listNotebookAccessToken()

return notebook access token and refresh token.
abstract Response<NotebookAccessTokenResult> listNotebookAccessTokenWithResponse(Context context)

return notebook access token and refresh token.
abstract ListNotebookKeysResult listNotebookKeys()

List keys of a notebook.
abstract Response<ListNotebookKeysResult> listNotebookKeysWithResponse(Context context)

List keys of a notebook.
abstract ListStorageAccountKeysResult listStorageAccountKeys()

List storage account keys of a workspace.
abstract Response<ListStorageAccountKeysResult> listStorageAccountKeysWithResponse(Context context)

List storage account keys of a workspace.
abstract String location()

Gets the location property: Specifies the location of the resource.
abstract ManagedNetworkSettings managedNetwork()

Gets the managedNetwork property: Managed Network settings for a machine learning workspace.
abstract String mlFlowTrackingUri()

Gets the mlFlowTrackingUri property: The URI associated with this workspace that machine learning flow must point at to set up tracking.
abstract String name()

Gets the name property: The name of the resource.
abstract NotebookResourceInfo notebookInfo()

Gets the notebookInfo property: The notebook info of Azure ML workspace.
abstract NotebookResourceInfo prepareNotebook()

Prepare a notebook.
abstract NotebookResourceInfo prepareNotebook(Context context)

Prepare a notebook.
abstract String primaryUserAssignedIdentity()

Gets the primaryUserAssignedIdentity property: The user assigned identity resource id that represents the workspace identity.
abstract List<PrivateEndpointConnection> privateEndpointConnections()

Gets the privateEndpointConnections property: The list of private endpoint connections in the workspace.
abstract Integer privateLinkCount()

Gets the privateLinkCount property: Count of private connections in the workspace.
abstract ProvisioningState provisioningState()

Gets the provisioningState property: The current deployment state of workspace resource.
abstract PublicNetworkAccess publicNetworkAccess()

Gets the publicNetworkAccess property: Whether requests from Public Network are allowed.
abstract Workspace refresh()

Refreshes the resource to sync with Azure.
abstract Workspace refresh(Context context)

Refreshes the resource to sync with Azure.
abstract Region region()

Gets the region of the resource.
abstract String regionName()

Gets the name of the resource region.
abstract String resourceGroupName()

Gets the name of the resource group.
abstract void resyncKeys()

Resync all the keys associated with this workspace.
abstract void resyncKeys(Context context)

Resync all the keys associated with this workspace.
abstract ServerlessComputeSettings serverlessComputeSettings()

Gets the serverlessComputeSettings property: Settings for serverless compute created in the workspace.
abstract ServiceManagedResourcesSettings serviceManagedResourcesSettings()

Gets the serviceManagedResourcesSettings property: The service managed resource settings.
abstract String serviceProvisionedResourceGroup()

Gets the serviceProvisionedResourceGroup property: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace.
abstract List<SharedPrivateLinkResource> sharedPrivateLinkResources()

Gets the sharedPrivateLinkResources property: The list of shared private link resources in this workspace.
abstract Sku sku()

Gets the sku property: The sku of the workspace.
abstract String storageAccount()

Gets the storageAccount property: ARM id of the storage account associated with this workspace.
abstract Boolean storageHnsEnabled()

Gets the storageHnsEnabled property: If the storage associated with the workspace has hierarchical namespace(HNS) enabled.
abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract Map<String,String> tags()

Gets the tags property: Contains resource tags defined as key/value pairs.
abstract String tenantId()

Gets the tenantId property: The tenant id associated with this workspace.
abstract String type()

Gets the type property: The type of the resource.
abstract Update update()

Begins update for the Workspace resource.
abstract Boolean v1LegacyMode()

Gets the v1LegacyMode property: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.
abstract WorkspaceHubConfig workspaceHubConfig()

Gets the workspaceHubConfig property: WorkspaceHub's configuration object.
abstract String workspaceId()

Gets the workspaceId property: The immutable id associated with this workspace.

Method Details

allowPublicAccessWhenBehindVnet

public abstract Boolean allowPublicAccessWhenBehindVnet()

Gets the allowPublicAccessWhenBehindVnet property: The flag to indicate whether to allow public access when behind VNet.

Returns:

the allowPublicAccessWhenBehindVnet value.

applicationInsights

public abstract String applicationInsights()

Gets the applicationInsights property: ARM id of the application insights associated with this workspace.

Returns:

the applicationInsights value.

associatedWorkspaces

public abstract List<String> associatedWorkspaces()

Gets the associatedWorkspaces property: The associatedWorkspaces property.

Returns:

the associatedWorkspaces value.

containerRegistry

public abstract String containerRegistry()

Gets the containerRegistry property: ARM id of the container registry associated with this workspace.

Returns:

the containerRegistry value.

description

public abstract String description()

Gets the description property: The description of this workspace.

Returns:

the description value.

diagnose

public abstract DiagnoseResponseResult diagnose()

Diagnose workspace setup issue.

Returns:

the response.

diagnose

public abstract DiagnoseResponseResult diagnose(DiagnoseWorkspaceParameters parameters, Context context)

Diagnose workspace setup issue.

Parameters:

parameters - The parameter of diagnosing workspace health.
context - The context to associate with this operation.

Returns:

the response.

discoveryUrl

public abstract String discoveryUrl()

Gets the discoveryUrl property: Url for the discovery service to identify regional endpoints for machine learning experimentation services.

Returns:

the discoveryUrl value.

enableDataIsolation

public abstract Boolean enableDataIsolation()

Gets the enableDataIsolation property: The enableDataIsolation property.

Returns:

the enableDataIsolation value.

encryption

public abstract EncryptionProperty encryption()

Gets the encryption property: The encryption settings of Azure ML workspace.

Returns:

the encryption value.

featureStoreSettings

public abstract FeatureStoreSettings featureStoreSettings()

Gets the featureStoreSettings property: Settings for feature store type workspace.

Returns:

the featureStoreSettings value.

friendlyName

public abstract String friendlyName()

Gets the friendlyName property: The friendly name for this workspace. This name in mutable.

Returns:

the friendlyName value.

hbiWorkspace

public abstract Boolean hbiWorkspace()

Gets the hbiWorkspace property: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service.

Returns:

the hbiWorkspace value.

hubResourceId

public abstract String hubResourceId()

Gets the hubResourceId property: The hubResourceId property.

Returns:

the hubResourceId value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

identity

public abstract ManagedServiceIdentity identity()

Gets the identity property: The identity of the resource.

Returns:

the identity value.

imageBuildCompute

public abstract String imageBuildCompute()

Gets the imageBuildCompute property: The compute name for image build.

Returns:

the imageBuildCompute value.

innerModel

public abstract WorkspaceInner innerModel()

Gets the inner com.azure.resourcemanager.machinelearning.fluent.models.WorkspaceInner object.

Returns:

the inner object.

keyVault

public abstract String keyVault()

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

Returns:

the keyVault value.

kind

public abstract String kind()

Gets the kind property: The kind property.

Returns:

the kind value.

listKeys

public abstract ListWorkspaceKeysResult listKeys()

Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

Returns:

the response.

listKeysWithResponse

public abstract Response<ListWorkspaceKeysResult> listKeysWithResponse(Context context)

Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

Parameters:

context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

listNotebookAccessToken

public abstract NotebookAccessTokenResult listNotebookAccessToken()

return notebook access token and refresh token.

Returns:

the response.

listNotebookAccessTokenWithResponse

public abstract Response<NotebookAccessTokenResult> listNotebookAccessTokenWithResponse(Context context)

return notebook access token and refresh token.

Parameters:

context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

listNotebookKeys

public abstract ListNotebookKeysResult listNotebookKeys()

List keys of a notebook.

Returns:

the response.

listNotebookKeysWithResponse

public abstract Response<ListNotebookKeysResult> listNotebookKeysWithResponse(Context context)

List keys of a notebook.

Parameters:

context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

listStorageAccountKeys

public abstract ListStorageAccountKeysResult listStorageAccountKeys()

List storage account keys of a workspace.

Returns:

the response.

listStorageAccountKeysWithResponse

public abstract Response<ListStorageAccountKeysResult> listStorageAccountKeysWithResponse(Context context)

List storage account keys of a workspace.

Parameters:

context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

location

public abstract String location()

Gets the location property: Specifies the location of the resource.

Returns:

the location value.

managedNetwork

public abstract ManagedNetworkSettings managedNetwork()

Gets the managedNetwork property: Managed Network settings for a machine learning workspace.

Returns:

the managedNetwork value.

mlFlowTrackingUri

public abstract String mlFlowTrackingUri()

Gets the mlFlowTrackingUri property: The URI associated with this workspace that machine learning flow must point at to set up tracking.

Returns:

the mlFlowTrackingUri value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

notebookInfo

public abstract NotebookResourceInfo notebookInfo()

Gets the notebookInfo property: The notebook info of Azure ML workspace.

Returns:

the notebookInfo value.

prepareNotebook

public abstract NotebookResourceInfo prepareNotebook()

Prepare a notebook.

Returns:

the response.

prepareNotebook

public abstract NotebookResourceInfo prepareNotebook(Context context)

Prepare a notebook.

Parameters:

context - The context to associate with this operation.

Returns:

the response.

primaryUserAssignedIdentity

public abstract String primaryUserAssignedIdentity()

Gets the primaryUserAssignedIdentity property: The user assigned identity resource id that represents the workspace identity.

Returns:

the primaryUserAssignedIdentity value.

privateEndpointConnections

public abstract List<PrivateEndpointConnection> privateEndpointConnections()

Gets the privateEndpointConnections property: The list of private endpoint connections in the workspace.

Returns:

the privateEndpointConnections value.

privateLinkCount

public abstract Integer privateLinkCount()

Gets the privateLinkCount property: Count of private connections in the workspace.

Returns:

the privateLinkCount value.

provisioningState

public abstract ProvisioningState provisioningState()

Gets the provisioningState property: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.

Returns:

the provisioningState value.

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Gets the publicNetworkAccess property: Whether requests from Public Network are allowed.

Returns:

the publicNetworkAccess value.

refresh

public abstract Workspace refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Workspace refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

resyncKeys

public abstract void resyncKeys()

Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

resyncKeys

public abstract void resyncKeys(Context context)

Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.

Parameters:

context - The context to associate with this operation.

serverlessComputeSettings

public abstract ServerlessComputeSettings serverlessComputeSettings()

Gets the serverlessComputeSettings property: Settings for serverless compute created in the workspace.

Returns:

the serverlessComputeSettings value.

serviceManagedResourcesSettings

public abstract ServiceManagedResourcesSettings serviceManagedResourcesSettings()

Gets the serviceManagedResourcesSettings property: The service managed resource settings.

Returns:

the serviceManagedResourcesSettings value.

serviceProvisionedResourceGroup

public abstract String serviceProvisionedResourceGroup()

Gets the serviceProvisionedResourceGroup property: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace.

Returns:

the serviceProvisionedResourceGroup value.

sharedPrivateLinkResources

public abstract List<SharedPrivateLinkResource> sharedPrivateLinkResources()

Gets the sharedPrivateLinkResources property: The list of shared private link resources in this workspace.

Returns:

the sharedPrivateLinkResources value.

sku

public abstract Sku sku()

Gets the sku property: The sku of the workspace.

Returns:

the sku value.

storageAccount

public abstract String storageAccount()

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

Returns:

the storageAccount value.

storageHnsEnabled

public abstract Boolean storageHnsEnabled()

Gets the storageHnsEnabled property: If the storage associated with the workspace has hierarchical namespace(HNS) enabled.

Returns:

the storageHnsEnabled value.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Contains resource tags defined as key/value pairs.

Returns:

the tags value.

tenantId

public abstract String tenantId()

Gets the tenantId property: The tenant id associated with this workspace.

Returns:

the tenantId value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Workspace.Update update()

Begins update for the Workspace resource.

Returns:

the stage of resource update.

v1LegacyMode

public abstract Boolean v1LegacyMode()

Gets the v1LegacyMode property: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.

Returns:

the v1LegacyMode value.

workspaceHubConfig

public abstract WorkspaceHubConfig workspaceHubConfig()

Gets the workspaceHubConfig property: WorkspaceHub's configuration object.

Returns:

the workspaceHubConfig value.

workspaceId

public abstract String workspaceId()

Gets the workspaceId property: The immutable id associated with this workspace.

Returns:

the workspaceId value.

Applies to