Use Pulumi's new import command to generate code from existing cloud resources. Learn More

GetWorkspace

Using GetWorkspace

function getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
def get_workspace(resource_group_name: Optional[str] = None, workspace_name: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)

Note: This function is named LookupWorkspace in the Go SDK.

public static class GetWorkspace {
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ResourceGroupName string
The name of the resource group. The name is case insensitive.
WorkspaceName string
The name of the workspace
ResourceGroupName string
The name of the resource group. The name is case insensitive.
WorkspaceName string
The name of the workspace
resourceGroupName string
The name of the resource group. The name is case insensitive.
workspaceName string
The name of the workspace
resource_group_name str
The name of the resource group. The name is case insensitive.
workspace_name str
The name of the workspace

GetWorkspace Result

The following output properties are available:

ExtraProperties Dictionary<string, object>
Workspace level configs and feature flags
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Resource provisioning state
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
WorkspaceUID string
The workspace unique identifier
ConnectivityEndpoints Dictionary<string, string>
Connectivity endpoints
DefaultDataLakeStorage Pulumi.AzureNextGen.Synapse.Outputs.DataLakeStorageAccountDetailsResponse
Workspace default data lake storage account details
Encryption Pulumi.AzureNextGen.Synapse.Outputs.EncryptionDetailsResponse
The encryption details of the workspace
Identity Pulumi.AzureNextGen.Synapse.Outputs.ManagedIdentityResponse
Identity of the workspace
ManagedResourceGroupName string
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 ‘.’
ManagedVirtualNetwork string
Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
ManagedVirtualNetworkSettings Pulumi.AzureNextGen.Synapse.Outputs.ManagedVirtualNetworkSettingsResponse
Managed Virtual Network Settings
PrivateEndpointConnections List<Pulumi.AzureNextGen.Synapse.Outputs.PrivateEndpointConnectionResponse>
Private endpoint connections to the workspace
PurviewConfiguration Pulumi.AzureNextGen.Synapse.Outputs.PurviewConfigurationResponse
Purview Configuration
SqlAdministratorLogin string
Login for workspace SQL active directory administrator
SqlAdministratorLoginPassword string
SQL administrator login password
Tags Dictionary<string, string>
Resource tags.
VirtualNetworkProfile Pulumi.AzureNextGen.Synapse.Outputs.VirtualNetworkProfileResponse
Virtual Network profile
WorkspaceRepositoryConfiguration Pulumi.AzureNextGen.Synapse.Outputs.WorkspaceRepositoryConfigurationResponse
Git integration settings
ExtraProperties map[string]interface{}
Workspace level configs and feature flags
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Resource provisioning state
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
WorkspaceUID string
The workspace unique identifier
ConnectivityEndpoints map[string]string
Connectivity endpoints
DefaultDataLakeStorage DataLakeStorageAccountDetailsResponse
Workspace default data lake storage account details
Encryption EncryptionDetailsResponse
The encryption details of the workspace
Identity ManagedIdentityResponse
Identity of the workspace
ManagedResourceGroupName string
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 ‘.’
ManagedVirtualNetwork string
Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
ManagedVirtualNetworkSettings ManagedVirtualNetworkSettingsResponse
Managed Virtual Network Settings
PrivateEndpointConnections []PrivateEndpointConnectionResponse
Private endpoint connections to the workspace
PurviewConfiguration PurviewConfigurationResponse
Purview Configuration
SqlAdministratorLogin string
Login for workspace SQL active directory administrator
SqlAdministratorLoginPassword string
SQL administrator login password
Tags map[string]string
Resource tags.
VirtualNetworkProfile VirtualNetworkProfileResponse
Virtual Network profile
WorkspaceRepositoryConfiguration WorkspaceRepositoryConfigurationResponse
Git integration settings
extraProperties {[key: string]: any}
Workspace level configs and feature flags
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
Resource provisioning state
type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
workspaceUID string
The workspace unique identifier
connectivityEndpoints {[key: string]: string}
Connectivity endpoints
defaultDataLakeStorage DataLakeStorageAccountDetailsResponse
Workspace default data lake storage account details
encryption EncryptionDetailsResponse
The encryption details of the workspace
identity ManagedIdentityResponse
Identity of the workspace
managedResourceGroupName string
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 ‘.’
managedVirtualNetwork string
Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
managedVirtualNetworkSettings ManagedVirtualNetworkSettingsResponse
Managed Virtual Network Settings
privateEndpointConnections PrivateEndpointConnectionResponse[]
Private endpoint connections to the workspace
purviewConfiguration PurviewConfigurationResponse
Purview Configuration
sqlAdministratorLogin string
Login for workspace SQL active directory administrator
sqlAdministratorLoginPassword string
SQL administrator login password
tags {[key: string]: string}
Resource tags.
virtualNetworkProfile VirtualNetworkProfileResponse
Virtual Network profile
workspaceRepositoryConfiguration WorkspaceRepositoryConfigurationResponse
Git integration settings
extra_properties Mapping[str, Any]
Workspace level configs and feature flags
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
Resource provisioning state
type str
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
workspace_uid str
The workspace unique identifier
connectivity_endpoints Mapping[str, str]
Connectivity endpoints
default_data_lake_storage DataLakeStorageAccountDetailsResponse
Workspace default data lake storage account details
encryption EncryptionDetailsResponse
The encryption details of the workspace
identity ManagedIdentityResponse
Identity of the workspace
managed_resource_group_name str
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 ‘.’
managed_virtual_network str
Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
managed_virtual_network_settings ManagedVirtualNetworkSettingsResponse
Managed Virtual Network Settings
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
Private endpoint connections to the workspace
purview_configuration PurviewConfigurationResponse
Purview Configuration
sql_administrator_login str
Login for workspace SQL active directory administrator
sql_administrator_login_password str
SQL administrator login password
tags Mapping[str, str]
Resource tags.
virtual_network_profile VirtualNetworkProfileResponse
Virtual Network profile
workspace_repository_configuration WorkspaceRepositoryConfigurationResponse
Git integration settings

Supporting Types

CustomerManagedKeyDetailsResponse

Status string
The customer managed key status on the workspace
Key Pulumi.AzureNextGen.Synapse.Inputs.WorkspaceKeyDetailsResponseArgs
The key object of the workspace
Status string
The customer managed key status on the workspace
Key WorkspaceKeyDetailsResponse
The key object of the workspace
status string
The customer managed key status on the workspace
key WorkspaceKeyDetailsResponse
The key object of the workspace
status str
The customer managed key status on the workspace
key WorkspaceKeyDetailsResponseArgs
The key object of the workspace

DataLakeStorageAccountDetailsResponse

AccountUrl string
Account URL
Filesystem string
Filesystem name
AccountUrl string
Account URL
Filesystem string
Filesystem name
accountUrl string
Account URL
filesystem string
Filesystem name
account_url str
Account URL
filesystem str
Filesystem name

EncryptionDetailsResponse

DoubleEncryptionEnabled bool
Double Encryption enabled
Cmk Pulumi.AzureNextGen.Synapse.Inputs.CustomerManagedKeyDetailsResponseArgs
Customer Managed Key Details
DoubleEncryptionEnabled bool
Double Encryption enabled
Cmk CustomerManagedKeyDetailsResponse
Customer Managed Key Details
doubleEncryptionEnabled boolean
Double Encryption enabled
cmk CustomerManagedKeyDetailsResponse
Customer Managed Key Details
double_encryption_enabled bool
Double Encryption enabled
cmk CustomerManagedKeyDetailsResponseArgs
Customer Managed Key Details

ManagedIdentityResponse

PrincipalId string
The principal ID of the workspace managed identity
TenantId string
The tenant ID of the workspace managed identity
Type string
The type of managed identity for the workspace
PrincipalId string
The principal ID of the workspace managed identity
TenantId string
The tenant ID of the workspace managed identity
Type string
The type of managed identity for the workspace
principalId string
The principal ID of the workspace managed identity
tenantId string
The tenant ID of the workspace managed identity
type string
The type of managed identity for the workspace
principal_id str
The principal ID of the workspace managed identity
tenant_id str
The tenant ID of the workspace managed identity
type str
The type of managed identity for the workspace

ManagedVirtualNetworkSettingsResponse

AllowedAadTenantIdsForLinking List<string>
Allowed Aad Tenant Ids For Linking
LinkedAccessCheckOnTargetResource bool
Linked Access Check On Target Resource
PreventDataExfiltration bool
Prevent Data Exfiltration
AllowedAadTenantIdsForLinking []string
Allowed Aad Tenant Ids For Linking
LinkedAccessCheckOnTargetResource bool
Linked Access Check On Target Resource
PreventDataExfiltration bool
Prevent Data Exfiltration
allowedAadTenantIdsForLinking string[]
Allowed Aad Tenant Ids For Linking
linkedAccessCheckOnTargetResource boolean
Linked Access Check On Target Resource
preventDataExfiltration boolean
Prevent Data Exfiltration
allowed_aad_tenant_ids_for_linking Sequence[str]
Allowed Aad Tenant Ids For Linking
linked_access_check_on_target_resource bool
Linked Access Check On Target Resource
prevent_data_exfiltration bool
Prevent Data Exfiltration

PrivateEndpointConnectionResponse

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
Provisioning state of the private endpoint connection.
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
PrivateEndpoint Pulumi.AzureNextGen.Synapse.Inputs.PrivateEndpointResponseArgs
The private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNextGen.Synapse.Inputs.PrivateLinkServiceConnectionStateResponseArgs
Connection state of the private endpoint connection.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
Provisioning state of the private endpoint connection.
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
PrivateEndpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
provisioningState string
Provisioning state of the private endpoint connection.
type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
privateEndpoint PrivateEndpointResponse
The private endpoint which the connection belongs to.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
Connection state of the private endpoint connection.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
provisioning_state str
Provisioning state of the private endpoint connection.
type str
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
private_endpoint PrivateEndpointResponseArgs
The private endpoint which the connection belongs to.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponseArgs
Connection state of the private endpoint connection.

PrivateEndpointResponse

Id string
Resource id of the private endpoint.
Id string
Resource id of the private endpoint.
id string
Resource id of the private endpoint.
id str
Resource id of the private endpoint.

PrivateLinkServiceConnectionStateResponse

ActionsRequired string
The actions required for private link service connection.
Description string
The private link service connection description.
Status string
The private link service connection status.
ActionsRequired string
The actions required for private link service connection.
Description string
The private link service connection description.
Status string
The private link service connection status.
actionsRequired string
The actions required for private link service connection.
description string
The private link service connection description.
status string
The private link service connection status.
actions_required str
The actions required for private link service connection.
description str
The private link service connection description.
status str
The private link service connection status.

PurviewConfigurationResponse

PurviewResourceId string
Purview Resource ID
PurviewResourceId string
Purview Resource ID
purviewResourceId string
Purview Resource ID
purview_resource_id str
Purview Resource ID

VirtualNetworkProfileResponse

ComputeSubnetId string
Subnet ID used for computes in workspace
ComputeSubnetId string
Subnet ID used for computes in workspace
computeSubnetId string
Subnet ID used for computes in workspace
compute_subnet_id str
Subnet ID used for computes in workspace

WorkspaceKeyDetailsResponse

KeyVaultUrl string
Workspace Key sub-resource key vault url
Name string
Workspace Key sub-resource name
KeyVaultUrl string
Workspace Key sub-resource key vault url
Name string
Workspace Key sub-resource name
keyVaultUrl string
Workspace Key sub-resource key vault url
name string
Workspace Key sub-resource name
key_vault_url str
Workspace Key sub-resource key vault url
name str
Workspace Key sub-resource name

WorkspaceRepositoryConfigurationResponse

AccountName string
Account name
CollaborationBranch string
Collaboration branch
HostName string
GitHub Enterprise host name. For example: https://github.mydomain.com
ProjectName string
VSTS project name
RepositoryName string
Repository name
RootFolder string
Root folder to use in the repository
Type string
Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration
AccountName string
Account name
CollaborationBranch string
Collaboration branch
HostName string
GitHub Enterprise host name. For example: https://github.mydomain.com
ProjectName string
VSTS project name
RepositoryName string
Repository name
RootFolder string
Root folder to use in the repository
Type string
Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration
accountName string
Account name
collaborationBranch string
Collaboration branch
hostName string
GitHub Enterprise host name. For example: https://github.mydomain.com
projectName string
VSTS project name
repositoryName string
Repository name
rootFolder string
Root folder to use in the repository
type string
Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration
account_name str
Account name
collaboration_branch str
Collaboration branch
host_name str
GitHub Enterprise host name. For example: https://github.mydomain.com
project_name str
VSTS project name
repository_name str
Repository name
root_folder str
Root folder to use in the repository
type str
Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration

Package Details

Repository
https://github.com/pulumi/pulumi-azure-nextgen
License
Apache-2.0