Workspace Interface

public interface Workspace

An immutable client-side representation of Workspace.

Method Summary

Modifier and Type Method and Description
abstract String adlaResourceId()

Gets the adlaResourceId property: The ADLA resource ID.

abstract Boolean azureADOnlyAuthentication()

Gets the azureADOnlyAuthentication property: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource.

abstract Map<String,String> connectivityEndpoints()

Gets the connectivityEndpoints property: Connectivity endpoints.

abstract CspWorkspaceAdminProperties cspWorkspaceAdminProperties()

Gets the cspWorkspaceAdminProperties property: Initial workspace AAD admin properties for a CSP subscription.

abstract DataLakeStorageAccountDetails defaultDataLakeStorage()

Gets the defaultDataLakeStorage property: Workspace default data lake storage account details.

abstract EncryptionDetails encryption()

Gets the encryption property: The encryption details of the workspace.

abstract Object extraProperties()

Gets the extraProperties property: Workspace level configs and feature flags.

abstract String id()

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

abstract ManagedIdentity identity()

Gets the identity property: Identity of the workspace.

abstract WorkspaceInner innerModel()

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

abstract String location()

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

abstract String managedResourceGroupName()

Gets the managedResourceGroupName property: Workspace managed resource group.

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

abstract ManagedVirtualNetworkSettings managedVirtualNetworkSettings()

Gets the managedVirtualNetworkSettings property: Managed Virtual Network Settings.

abstract String name()

Gets the name property: The name of the resource.

abstract List<PrivateEndpointConnection> privateEndpointConnections()

Gets the privateEndpointConnections property: Private endpoint connections to the workspace.

abstract String provisioningState()

Gets the provisioningState property: Resource provisioning state.

abstract WorkspacePublicNetworkAccess publicNetworkAccess()

Gets the publicNetworkAccess property: Enable or Disable public network access to workspace.

abstract PurviewConfiguration purviewConfiguration()

Gets the purviewConfiguration property: Purview Configuration.

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 Map<String,Object> settings()

Gets the settings property: Workspace settings.

abstract String sqlAdministratorLogin()

Gets the sqlAdministratorLogin property: Login for workspace SQL active directory administrator.

abstract String sqlAdministratorLoginPassword()

Gets the sqlAdministratorLoginPassword property: SQL administrator login password.

abstract Map<String,String> tags()

Gets the tags property: Resource tags.

abstract Boolean trustedServiceBypassEnabled()

Gets the trustedServiceBypassEnabled property: Is trustedServiceBypassEnabled for the workspace.

abstract String type()

Gets the type property: The type of the resource.

abstract Update update()

Begins update for the Workspace resource.

abstract VirtualNetworkProfile virtualNetworkProfile()

Gets the virtualNetworkProfile property: Virtual Network profile.

abstract WorkspaceRepositoryConfiguration workspaceRepositoryConfiguration()

Gets the workspaceRepositoryConfiguration property: Git integration settings.

abstract UUID workspaceUid()

Gets the workspaceUid property: The workspace unique identifier.

Method Details

adlaResourceId

public abstract String adlaResourceId()

Gets the adlaResourceId property: The ADLA resource ID.

Returns:

the adlaResourceId value.

azureADOnlyAuthentication

public abstract Boolean azureADOnlyAuthentication()

Gets the azureADOnlyAuthentication property: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource.

Returns:

the azureADOnlyAuthentication value.

connectivityEndpoints

public abstract Map connectivityEndpoints()

Gets the connectivityEndpoints property: Connectivity endpoints.

Returns:

the connectivityEndpoints value.

cspWorkspaceAdminProperties

public abstract CspWorkspaceAdminProperties cspWorkspaceAdminProperties()

Gets the cspWorkspaceAdminProperties property: Initial workspace AAD admin properties for a CSP subscription.

Returns:

the cspWorkspaceAdminProperties value.

defaultDataLakeStorage

public abstract DataLakeStorageAccountDetails defaultDataLakeStorage()

Gets the defaultDataLakeStorage property: Workspace default data lake storage account details.

Returns:

the defaultDataLakeStorage value.

encryption

public abstract EncryptionDetails encryption()

Gets the encryption property: The encryption details of the workspace.

Returns:

the encryption value.

extraProperties

public abstract Object extraProperties()

Gets the extraProperties property: Workspace level configs and feature flags.

Returns:

the extraProperties value.

id

public abstract String id()

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

Returns:

the id value.

identity

public abstract ManagedIdentity identity()

Gets the identity property: Identity of the workspace.

Returns:

the identity value.

innerModel

public abstract WorkspaceInner innerModel()

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

Returns:

the inner object.

location

public abstract String location()

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

Returns:

the location value.

managedResourceGroupName

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

managedVirtualNetwork

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

managedVirtualNetworkSettings

public abstract ManagedVirtualNetworkSettings managedVirtualNetworkSettings()

Gets the managedVirtualNetworkSettings property: Managed Virtual Network Settings.

Returns:

the managedVirtualNetworkSettings value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

privateEndpointConnections

public abstract List privateEndpointConnections()

Gets the privateEndpointConnections property: Private endpoint connections to the workspace.

Returns:

the privateEndpointConnections value.

provisioningState

public abstract String provisioningState()

Gets the provisioningState property: Resource provisioning state.

Returns:

the provisioningState value.

publicNetworkAccess

public abstract WorkspacePublicNetworkAccess publicNetworkAccess()

Gets the publicNetworkAccess property: Enable or Disable public network access to workspace.

Returns:

the publicNetworkAccess value.

purviewConfiguration

public abstract PurviewConfiguration purviewConfiguration()

Gets the purviewConfiguration property: Purview Configuration.

Returns:

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

settings

public abstract Map settings()

Gets the settings property: Workspace settings.

Returns:

the settings value.

sqlAdministratorLogin

public abstract String sqlAdministratorLogin()

Gets the sqlAdministratorLogin property: Login for workspace SQL active directory administrator.

Returns:

the sqlAdministratorLogin value.

sqlAdministratorLoginPassword

public abstract String sqlAdministratorLoginPassword()

Gets the sqlAdministratorLoginPassword property: SQL administrator login password.

Returns:

the sqlAdministratorLoginPassword value.

tags

public abstract Map tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

trustedServiceBypassEnabled

public abstract Boolean trustedServiceBypassEnabled()

Gets the trustedServiceBypassEnabled property: Is trustedServiceBypassEnabled for the workspace.

Returns:

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

virtualNetworkProfile

public abstract VirtualNetworkProfile virtualNetworkProfile()

Gets the virtualNetworkProfile property: Virtual Network profile.

Returns:

the virtualNetworkProfile value.

workspaceRepositoryConfiguration

public abstract WorkspaceRepositoryConfiguration workspaceRepositoryConfiguration()

Gets the workspaceRepositoryConfiguration property: Git integration settings.

Returns:

the workspaceRepositoryConfiguration value.

workspaceUid

public abstract UUID workspaceUid()

Gets the workspaceUid property: The workspace unique identifier.

Returns:

the workspaceUid value.

Applies to