Package com.azure.resourcemanager.machinelearning.models

Interface Workspace

  • public interface Workspace
    An immutable client-side representation of Workspace.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • identity

        ManagedServiceIdentity identity()
        Gets the identity property: The identity of the resource.
        Returns:
        the identity value.

      • location

        String location()
        Gets the location property: Specifies the location of the resource.
        Returns:
        the location value.

      • tags

        Map<String,​String> tags()
        Gets the tags property: Contains resource tags defined as key/value pairs.
        Returns:
        the tags value.

      • sku

        Sku sku()
        Gets the sku property: The sku of the workspace.
        Returns:
        the sku value.

      • systemData

        com.azure.core.management.SystemData systemData()
        Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
        Returns:
        the systemData value.

      • workspaceId

        String workspaceId()
        Gets the workspaceId property: The immutable id associated with this workspace.
        Returns:
        the workspaceId value.

      • description

        String description()
        Gets the description property: The description of this workspace.
        Returns:
        the description value.

      • friendlyName

        String friendlyName()
        Gets the friendlyName property: The friendly name for this workspace. This name in mutable.
        Returns:
        the friendlyName value.

      • keyVault

        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.

      • applicationInsights

        String applicationInsights()
        Gets the applicationInsights property: ARM id of the application insights associated with this workspace.
        Returns:
        the applicationInsights value.

      • containerRegistry

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

      • storageAccount

        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.

      • discoveryUrl

        String discoveryUrl()
        Gets the discoveryUrl property: Url for the discovery service to identify regional endpoints for machine learning experimentation services.
        Returns:
        the discoveryUrl value.

      • provisioningState

        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.

      • encryption

        EncryptionProperty encryption()
        Gets the encryption property: The encryption settings of Azure ML workspace.
        Returns:
        the encryption value.

      • hbiWorkspace

        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.

      • serviceProvisionedResourceGroup

        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.

      • privateLinkCount

        Integer privateLinkCount()
        Gets the privateLinkCount property: Count of private connections in the workspace.
        Returns:
        the privateLinkCount value.

      • imageBuildCompute

        String imageBuildCompute()
        Gets the imageBuildCompute property: The compute name for image build.
        Returns:
        the imageBuildCompute value.

      • allowPublicAccessWhenBehindVnet

        Boolean allowPublicAccessWhenBehindVnet()
        Gets the allowPublicAccessWhenBehindVnet property: The flag to indicate whether to allow public access when behind VNet.
        Returns:
        the allowPublicAccessWhenBehindVnet value.

      • publicNetworkAccess

        PublicNetworkAccess publicNetworkAccess()
        Gets the publicNetworkAccess property: Whether requests from Public Network are allowed.
        Returns:
        the publicNetworkAccess value.

      • privateEndpointConnections

        List<PrivateEndpointConnection> privateEndpointConnections()
        Gets the privateEndpointConnections property: The list of private endpoint connections in the workspace.
        Returns:
        the privateEndpointConnections value.

      • sharedPrivateLinkResources

        List<SharedPrivateLinkResource> sharedPrivateLinkResources()
        Gets the sharedPrivateLinkResources property: The list of shared private link resources in this workspace.
        Returns:
        the sharedPrivateLinkResources value.

      • notebookInfo

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

      • serviceManagedResourcesSettings

        ServiceManagedResourcesSettings serviceManagedResourcesSettings()
        Gets the serviceManagedResourcesSettings property: The service managed resource settings.
        Returns:
        the serviceManagedResourcesSettings value.

      • primaryUserAssignedIdentity

        String primaryUserAssignedIdentity()
        Gets the primaryUserAssignedIdentity property: The user assigned identity resource id that represents the workspace identity.
        Returns:
        the primaryUserAssignedIdentity value.

      • tenantId

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

      • storageHnsEnabled

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

      • mlFlowTrackingUri

        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.

      • region

        com.azure.core.management.Region region()
        Gets the region of the resource.
        Returns:
        the region of the resource.

      • regionName

        String regionName()
        Gets the name of the resource region.
        Returns:
        the name of the resource region.

      • resourceGroupName

        String resourceGroupName()
        Gets the name of the resource group.
        Returns:
        the name of the resource group.

      • innerModel

        WorkspaceInner innerModel()
        Gets the inner com.azure.resourcemanager.machinelearning.fluent.models.WorkspaceInner object.
        Returns:
        the inner object.

      • update

        Workspace.Update update()
        Begins update for the Workspace resource.
        Returns:
        the stage of resource update.

      • refresh

        Workspace refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        Workspace refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • diagnose

        DiagnoseResponseResult diagnose​(DiagnoseWorkspaceParameters parameters)
        Diagnose workspace setup issue.
        Parameters:
        parameters - The parameter of diagnosing workspace health.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • diagnose

        DiagnoseResponseResult diagnose()
        Diagnose workspace setup issue.
        Returns:
        the response.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • diagnose

        DiagnoseResponseResult diagnose​(DiagnoseWorkspaceParameters parameters,
                                com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listKeys

        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.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listKeysWithResponse

        com.azure.core.http.rest.Response<ListWorkspaceKeysResult> listKeysWithResponse​(com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • resyncKeys

        void resyncKeys()
        Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • resyncKeys

        void resyncKeys​(com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listNotebookAccessToken

        NotebookAccessTokenResult listNotebookAccessToken()
        return notebook access token and refresh token.
        Returns:
        the response.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listNotebookAccessTokenWithResponse

        com.azure.core.http.rest.Response<NotebookAccessTokenResult> listNotebookAccessTokenWithResponse​(com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • prepareNotebook

        NotebookResourceInfo prepareNotebook()
        Prepare a notebook.
        Returns:
        the response.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • prepareNotebook

        NotebookResourceInfo prepareNotebook​(com.azure.core.util.Context context)
        Prepare a notebook.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listStorageAccountKeys

        ListStorageAccountKeysResult listStorageAccountKeys()
        List storage account keys of a workspace.
        Returns:
        the response.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listStorageAccountKeysWithResponse

        com.azure.core.http.rest.Response<ListStorageAccountKeysResult> listStorageAccountKeysWithResponse​(com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listNotebookKeys

        ListNotebookKeysResult listNotebookKeys()
        List keys of a notebook.
        Returns:
        the response.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listNotebookKeysWithResponse

        com.azure.core.http.rest.Response<ListNotebookKeysResult> listNotebookKeysWithResponse​(com.azure.core.util.Context context)
        List keys of a notebook.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the response body along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.