Workspace Interface

Reference

Package:: com.azure.resourcemanager.machinelearningservices.models

Maven Artifact:: com.azure.resourcemanager:azure-resourcemanager-machinelearningservices:1.0.0-beta.1

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 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 String	discoveryUrl() Gets the discoveryUrl property: Url for the discovery service to identify regional endpoints for machine learning experimentation services.
abstract EncryptionProperty	encryption() Gets the encryption property: The encryption settings of Azure ML 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	id() Gets the id property: Fully qualified resource Id for the resource.
abstract Identity	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.machinelearningservices.fluent.models.WorkspaceInner object.
abstract String	keyVault() Gets the keyVault property: ARM id of the key vault associated with this workspace.
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 String	location() Gets the location property: The geo-location where the resource lives.
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 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 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 void	resyncKeys() Resync all the keys associated with this workspace.
abstract void	resyncKeys(Context context) Resync all the keys associated with this 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 SystemData	systemData() Gets the systemData property: Read only system data.
abstract Map<String,String>	tags() Gets the tags property: Resource tags.
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 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. This cannot be changed once the workspace has been created.

Returns:

the applicationInsights value.

containerRegistry

public abstract String containerRegistry()

Gets the containerRegistry property: ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created.

Returns:

the containerRegistry value.

description

public abstract String description()

Gets the description property: The description of this workspace.

Returns:

the description value.

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.

encryption

public abstract EncryptionProperty encryption()

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

Returns:

the encryption 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.

id

public abstract String id()

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

Returns:

the id value.

identity

public abstract Identity 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.machinelearningservices.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.

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 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.

listNotebookAccessToken

public abstract NotebookAccessTokenResult listNotebookAccessToken()

return notebook access token and refresh token.

Returns:

the response.

listNotebookAccessTokenWithResponse

public abstract Response listNotebookAccessTokenWithResponse(Context context)

return notebook access token and refresh token.

Parameters:

context - The context to associate with this operation.

Returns:

the response.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location 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.

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 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.

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.

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.

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 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.

systemData

public abstract SystemData systemData()

Gets the systemData property: Read only system data.

Returns:

the systemData 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.

workspaceId

public abstract String workspaceId()

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

Returns:

the workspaceId value.

Workspace Interface

Method Summary

Method Details

allowPublicAccessWhenBehindVnet

applicationInsights

containerRegistry

description

discoveryUrl

encryption

friendlyName

hbiWorkspace

id

identity

imageBuildCompute

innerModel

keyVault

listKeys

listKeysWithResponse

listNotebookAccessToken

listNotebookAccessTokenWithResponse

location

name

notebookInfo

primaryUserAssignedIdentity

privateEndpointConnections

privateLinkCount

provisioningState

refresh

refresh

region

regionName

resyncKeys

resyncKeys

serviceManagedResourcesSettings

serviceProvisionedResourceGroup

sharedPrivateLinkResources

sku

storageAccount

systemData

tags

tenantId

type

update

workspaceId

Applies to

Feedback

Additional resources