Class WorkspaceProperties


  • public final class WorkspaceProperties
    extends Object
    Workspace properties.
    • Constructor Detail

      • WorkspaceProperties

        public WorkspaceProperties()
    • Method Detail

      • defaultDataLakeStorage

        public DataLakeStorageAccountDetails defaultDataLakeStorage()
        Get the defaultDataLakeStorage property: Workspace default data lake storage account details.
        Returns:
        the defaultDataLakeStorage value.
      • withDefaultDataLakeStorage

        public WorkspaceProperties withDefaultDataLakeStorage​(DataLakeStorageAccountDetails defaultDataLakeStorage)
        Set the defaultDataLakeStorage property: Workspace default data lake storage account details.
        Parameters:
        defaultDataLakeStorage - the defaultDataLakeStorage value to set.
        Returns:
        the WorkspaceProperties object itself.
      • sqlAdministratorLoginPassword

        public String sqlAdministratorLoginPassword()
        Get the sqlAdministratorLoginPassword property: SQL administrator login password.
        Returns:
        the sqlAdministratorLoginPassword value.
      • withSqlAdministratorLoginPassword

        public WorkspaceProperties withSqlAdministratorLoginPassword​(String sqlAdministratorLoginPassword)
        Set the sqlAdministratorLoginPassword property: SQL administrator login password.
        Parameters:
        sqlAdministratorLoginPassword - the sqlAdministratorLoginPassword value to set.
        Returns:
        the WorkspaceProperties object itself.
      • managedResourceGroupName

        public String managedResourceGroupName()
        Get 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.
      • withManagedResourceGroupName

        public WorkspaceProperties withManagedResourceGroupName​(String managedResourceGroupName)
        Set 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 '.'.
        Parameters:
        managedResourceGroupName - the managedResourceGroupName value to set.
        Returns:
        the WorkspaceProperties object itself.
      • provisioningState

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

        public String sqlAdministratorLogin()
        Get the sqlAdministratorLogin property: Login for workspace SQL active directory administrator.
        Returns:
        the sqlAdministratorLogin value.
      • withSqlAdministratorLogin

        public WorkspaceProperties withSqlAdministratorLogin​(String sqlAdministratorLogin)
        Set the sqlAdministratorLogin property: Login for workspace SQL active directory administrator.
        Parameters:
        sqlAdministratorLogin - the sqlAdministratorLogin value to set.
        Returns:
        the WorkspaceProperties object itself.
      • virtualNetworkProfile

        public VirtualNetworkProfile virtualNetworkProfile()
        Get the virtualNetworkProfile property: Virtual Network profile.
        Returns:
        the virtualNetworkProfile value.
      • withVirtualNetworkProfile

        public WorkspaceProperties withVirtualNetworkProfile​(VirtualNetworkProfile virtualNetworkProfile)
        Set the virtualNetworkProfile property: Virtual Network profile.
        Parameters:
        virtualNetworkProfile - the virtualNetworkProfile value to set.
        Returns:
        the WorkspaceProperties object itself.
      • connectivityEndpoints

        public Map<String,​String> connectivityEndpoints()
        Get the connectivityEndpoints property: Connectivity endpoints.
        Returns:
        the connectivityEndpoints value.
      • withConnectivityEndpoints

        public WorkspaceProperties withConnectivityEndpoints​(Map<String,​String> connectivityEndpoints)
        Set the connectivityEndpoints property: Connectivity endpoints.
        Parameters:
        connectivityEndpoints - the connectivityEndpoints value to set.
        Returns:
        the WorkspaceProperties object itself.
      • managedVirtualNetwork

        public String managedVirtualNetwork()
        Get 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.
      • withManagedVirtualNetwork

        public WorkspaceProperties withManagedVirtualNetwork​(String managedVirtualNetwork)
        Set 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.
        Parameters:
        managedVirtualNetwork - the managedVirtualNetwork value to set.
        Returns:
        the WorkspaceProperties object itself.
      • privateEndpointConnections

        public List<PrivateEndpointConnectionInner> privateEndpointConnections()
        Get the privateEndpointConnections property: Private endpoint connections to the workspace.
        Returns:
        the privateEndpointConnections value.
      • withPrivateEndpointConnections

        public WorkspaceProperties withPrivateEndpointConnections​(List<PrivateEndpointConnectionInner> privateEndpointConnections)
        Set the privateEndpointConnections property: Private endpoint connections to the workspace.
        Parameters:
        privateEndpointConnections - the privateEndpointConnections value to set.
        Returns:
        the WorkspaceProperties object itself.
      • encryption

        public EncryptionDetails encryption()
        Get the encryption property: The encryption details of the workspace.
        Returns:
        the encryption value.
      • withEncryption

        public WorkspaceProperties withEncryption​(EncryptionDetails encryption)
        Set the encryption property: The encryption details of the workspace.
        Parameters:
        encryption - the encryption value to set.
        Returns:
        the WorkspaceProperties object itself.
      • workspaceUid

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

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

        public ManagedVirtualNetworkSettings managedVirtualNetworkSettings()
        Get the managedVirtualNetworkSettings property: Managed Virtual Network Settings.
        Returns:
        the managedVirtualNetworkSettings value.
      • withManagedVirtualNetworkSettings

        public WorkspaceProperties withManagedVirtualNetworkSettings​(ManagedVirtualNetworkSettings managedVirtualNetworkSettings)
        Set the managedVirtualNetworkSettings property: Managed Virtual Network Settings.
        Parameters:
        managedVirtualNetworkSettings - the managedVirtualNetworkSettings value to set.
        Returns:
        the WorkspaceProperties object itself.
      • workspaceRepositoryConfiguration

        public WorkspaceRepositoryConfiguration workspaceRepositoryConfiguration()
        Get the workspaceRepositoryConfiguration property: Git integration settings.
        Returns:
        the workspaceRepositoryConfiguration value.
      • withWorkspaceRepositoryConfiguration

        public WorkspaceProperties withWorkspaceRepositoryConfiguration​(WorkspaceRepositoryConfiguration workspaceRepositoryConfiguration)
        Set the workspaceRepositoryConfiguration property: Git integration settings.
        Parameters:
        workspaceRepositoryConfiguration - the workspaceRepositoryConfiguration value to set.
        Returns:
        the WorkspaceProperties object itself.
      • purviewConfiguration

        public PurviewConfiguration purviewConfiguration()
        Get the purviewConfiguration property: Purview Configuration.
        Returns:
        the purviewConfiguration value.
      • withPurviewConfiguration

        public WorkspaceProperties withPurviewConfiguration​(PurviewConfiguration purviewConfiguration)
        Set the purviewConfiguration property: Purview Configuration.
        Parameters:
        purviewConfiguration - the purviewConfiguration value to set.
        Returns:
        the WorkspaceProperties object itself.
      • adlaResourceId

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

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

        public WorkspaceProperties withPublicNetworkAccess​(WorkspacePublicNetworkAccess publicNetworkAccess)
        Set the publicNetworkAccess property: Enable or Disable public network access to workspace.
        Parameters:
        publicNetworkAccess - the publicNetworkAccess value to set.
        Returns:
        the WorkspaceProperties object itself.
      • cspWorkspaceAdminProperties

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

        public WorkspaceProperties withCspWorkspaceAdminProperties​(CspWorkspaceAdminProperties cspWorkspaceAdminProperties)
        Set the cspWorkspaceAdminProperties property: Initial workspace AAD admin properties for a CSP subscription.
        Parameters:
        cspWorkspaceAdminProperties - the cspWorkspaceAdminProperties value to set.
        Returns:
        the WorkspaceProperties object itself.
      • settings

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

        public Boolean azureADOnlyAuthentication()
        Get the azureADOnlyAuthentication property: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource.
        Returns:
        the azureADOnlyAuthentication value.
      • withAzureADOnlyAuthentication

        public WorkspaceProperties withAzureADOnlyAuthentication​(Boolean azureADOnlyAuthentication)
        Set the azureADOnlyAuthentication property: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource.
        Parameters:
        azureADOnlyAuthentication - the azureADOnlyAuthentication value to set.
        Returns:
        the WorkspaceProperties object itself.
      • trustedServiceBypassEnabled

        public Boolean trustedServiceBypassEnabled()
        Get the trustedServiceBypassEnabled property: Is trustedServiceBypassEnabled for the workspace.
        Returns:
        the trustedServiceBypassEnabled value.
      • withTrustedServiceBypassEnabled

        public WorkspaceProperties withTrustedServiceBypassEnabled​(Boolean trustedServiceBypassEnabled)
        Set the trustedServiceBypassEnabled property: Is trustedServiceBypassEnabled for the workspace.
        Parameters:
        trustedServiceBypassEnabled - the trustedServiceBypassEnabled value to set.
        Returns:
        the WorkspaceProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.