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

        String location()
        Gets the location property: The geo-location where the resource lives.
        Returns:
        the location value.
      • tags

        Map<String,​String> tags()
        Gets the tags property: Resource tags.
        Returns:
        the tags value.
      • identity

        ManagedIdentity identity()
        Gets the identity property: Identity of the workspace.
        Returns:
        the identity value.
      • defaultDataLakeStorage

        DataLakeStorageAccountDetails defaultDataLakeStorage()
        Gets the defaultDataLakeStorage property: Workspace default data lake storage account details.
        Returns:
        the defaultDataLakeStorage value.
      • sqlAdministratorLoginPassword

        String sqlAdministratorLoginPassword()
        Gets the sqlAdministratorLoginPassword property: SQL administrator login password.
        Returns:
        the sqlAdministratorLoginPassword value.
      • managedResourceGroupName

        String managedResourceGroupName()
        Gets the managedResourceGroupName property: Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and '-', '_', '(', ')' and'.'. Note that the name cannot end with '.'.
        Returns:
        the managedResourceGroupName value.
      • provisioningState

        String provisioningState()
        Gets the provisioningState property: Resource provisioning state.
        Returns:
        the provisioningState value.
      • sqlAdministratorLogin

        String sqlAdministratorLogin()
        Gets the sqlAdministratorLogin property: Login for workspace SQL active directory administrator.
        Returns:
        the sqlAdministratorLogin value.
      • virtualNetworkProfile

        VirtualNetworkProfile virtualNetworkProfile()
        Gets the virtualNetworkProfile property: Virtual Network profile.
        Returns:
        the virtualNetworkProfile value.
      • connectivityEndpoints

        Map<String,​String> connectivityEndpoints()
        Gets the connectivityEndpoints property: Connectivity endpoints.
        Returns:
        the connectivityEndpoints value.
      • managedVirtualNetwork

        String managedVirtualNetwork()
        Gets the managedVirtualNetwork property: Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
        Returns:
        the managedVirtualNetwork value.
      • privateEndpointConnections

        List<PrivateEndpointConnection> privateEndpointConnections()
        Gets the privateEndpointConnections property: Private endpoint connections to the workspace.
        Returns:
        the privateEndpointConnections value.
      • encryption

        EncryptionDetails encryption()
        Gets the encryption property: The encryption details of the workspace.
        Returns:
        the encryption value.
      • workspaceUid

        UUID workspaceUid()
        Gets the workspaceUid property: The workspace unique identifier.
        Returns:
        the workspaceUid value.
      • extraProperties

        Map<String,​Object> extraProperties()
        Gets the extraProperties property: Workspace level configs and feature flags.
        Returns:
        the extraProperties value.
      • managedVirtualNetworkSettings

        ManagedVirtualNetworkSettings managedVirtualNetworkSettings()
        Gets the managedVirtualNetworkSettings property: Managed Virtual Network Settings.
        Returns:
        the managedVirtualNetworkSettings value.
      • workspaceRepositoryConfiguration

        WorkspaceRepositoryConfiguration workspaceRepositoryConfiguration()
        Gets the workspaceRepositoryConfiguration property: Git integration settings.
        Returns:
        the workspaceRepositoryConfiguration value.
      • purviewConfiguration

        PurviewConfiguration purviewConfiguration()
        Gets the purviewConfiguration property: Purview Configuration.
        Returns:
        the purviewConfiguration value.
      • adlaResourceId

        String adlaResourceId()
        Gets the adlaResourceId property: The ADLA resource ID.
        Returns:
        the adlaResourceId value.
      • publicNetworkAccess

        WorkspacePublicNetworkAccess publicNetworkAccess()
        Gets the publicNetworkAccess property: Enable or Disable public network access to workspace.
        Returns:
        the publicNetworkAccess value.
      • cspWorkspaceAdminProperties

        CspWorkspaceAdminProperties cspWorkspaceAdminProperties()
        Gets the cspWorkspaceAdminProperties property: Initial workspace AAD admin properties for a CSP subscription.
        Returns:
        the cspWorkspaceAdminProperties value.
      • settings

        Map<String,​Object> settings()
        Gets the settings property: Workspace settings.
        Returns:
        the settings value.
      • azureADOnlyAuthentication

        Boolean azureADOnlyAuthentication()
        Gets the azureADOnlyAuthentication property: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource.
        Returns:
        the azureADOnlyAuthentication value.
      • trustedServiceBypassEnabled

        Boolean trustedServiceBypassEnabled()
        Gets the trustedServiceBypassEnabled property: Is trustedServiceBypassEnabled for the workspace.
        Returns:
        the trustedServiceBypassEnabled 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.
      • innerModel

        WorkspaceInner innerModel()
        Gets the inner com.azure.resourcemanager.synapse.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.