Workspaces - List

Service:

Synapse

API Version:

2021-06-01

Returns a list of workspaces in a subscription

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Synapse/workspaces?api-version=2021-06-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	WorkspaceInfoListResult
Other Status Codes	ErrorResponse

Examples

List workspaces in subscription

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces?api-version=2021-06-01

Java

/**
 * Samples for Workspaces List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspacesInSubscription.
     * json
     */
    /**
     * Sample code: List workspaces in subscription.
     * 
     * @param manager Entry point to SynapseManager.
     */
    public static void listWorkspacesInSubscription(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager.workspaces().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python list_workspaces_in_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.workspaces.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspacesInSubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspacesInSubscription.json
func ExampleWorkspacesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkspacesClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.WorkspaceInfoListResult = armsynapse.WorkspaceInfoListResult{
		// 	Value: []*armsynapse.Workspace{
		// 		{
		// 			Name: to.Ptr("workspace1"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armsynapse.WorkspaceProperties{
		// 				ConnectivityEndpoints: map[string]*string{
		// 					"dev": to.Ptr("workspace1.dev.projectarcadia.net"),
		// 					"sql": to.Ptr("workspace1.sql.projectarcadia.net"),
		// 				},
		// 				DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
		// 					AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
		// 					Filesystem: to.Ptr("default"),
		// 				},
		// 				ManagedResourceGroupName: to.Ptr("resourceGroup2"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SQLAdministratorLogin: to.Ptr("login"),
		// 				WorkspaceUID: to.Ptr("00000000-1111-2222-3333-444444444444"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("workspace2"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace2"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 				"key": to.Ptr("value"),
		// 			},
		// 			Properties: &armsynapse.WorkspaceProperties{
		// 				ConnectivityEndpoints: map[string]*string{
		// 					"dev": to.Ptr("workspace2.dev.projectarcadia.net"),
		// 					"sql": to.Ptr("workspace2.sql.projectarcadia.net"),
		// 				},
		// 				DefaultDataLakeStorage: &armsynapse.DataLakeStorageAccountDetails{
		// 					AccountURL: to.Ptr("https://accountname.dfs.core.windows.net"),
		// 					Filesystem: to.Ptr("default"),
		// 				},
		// 				ManagedResourceGroupName: to.Ptr("resourceGroup2"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				SQLAdministratorLogin: to.Ptr("login"),
		// 				WorkspaceUID: to.Ptr("00000000-1111-2222-3333-444444444444"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns a list of workspaces in a subscription
 *
 * @summary Returns a list of workspaces in a subscription
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspacesInSubscription.json
 */
async function listWorkspacesInSubscription() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.workspaces.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Synapse.Models;
using Azure.ResourceManager.Synapse;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListWorkspacesInSubscription.json
// this example is just showing the usage of "Workspaces_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (SynapseWorkspaceResource item in subscriptionResource.GetSynapseWorkspacesAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SynapseWorkspaceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1",
      "name": "workspace1",
      "type": "Microsoft.Synapse/workspaces",
      "location": "East US",
      "properties": {
        "defaultDataLakeStorage": {
          "accountUrl": "https://accountname.dfs.core.windows.net",
          "filesystem": "default"
        },
        "connectivityEndpoints": {
          "dev": "workspace1.dev.projectarcadia.net",
          "sql": "workspace1.sql.projectarcadia.net"
        },
        "sqlAdministratorLogin": "login",
        "managedResourceGroupName": "resourceGroup2",
        "provisioningState": "Succeeded",
        "workspaceUID": "00000000-1111-2222-3333-444444444444"
      },
      "tags": {
        "key": "value"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace2",
      "name": "workspace2",
      "type": "Microsoft.Synapse/workspaces",
      "location": "East US",
      "properties": {
        "defaultDataLakeStorage": {
          "accountUrl": "https://accountname.dfs.core.windows.net",
          "filesystem": "default"
        },
        "connectivityEndpoints": {
          "dev": "workspace2.dev.projectarcadia.net",
          "sql": "workspace2.sql.projectarcadia.net"
        },
        "sqlAdministratorLogin": "login",
        "managedResourceGroupName": "resourceGroup2",
        "provisioningState": "Succeeded",
        "workspaceUID": "00000000-1111-2222-3333-444444444444"
      },
      "tags": {
        "key": "value"
      }
    }
  ]
}

Definitions

Name	Description
CspWorkspaceAdminProperties	Initial workspace AAD admin properties for a CSP subscription
CustomerManagedKeyDetails	Details of the customer managed key associated with the workspace
DataLakeStorageAccountDetails	Details of the data lake storage account associated with the workspace
EncryptionDetails	Details of the encryption associated with the workspace
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
KekIdentityProperties	Key encryption key properties
ManagedIdentity	The workspace managed identity
ManagedVirtualNetworkSettings	Managed Virtual Network Settings
PrivateEndpoint	Private endpoint details
PrivateEndpointConnection	A private endpoint connection
PrivateLinkServiceConnectionState	Connection state details of the private endpoint
PurviewConfiguration	Purview Configuration
ResourceIdentityType	The type of managed identity for the workspace
UserAssignedManagedIdentity	User Assigned Managed Identity
VirtualNetworkProfile	Virtual Network Profile
Workspace	A workspace
WorkspaceInfoListResult	List of workspaces
WorkspaceKeyDetails	Details of the customer managed key associated with the workspace
WorkspacePublicNetworkAccess	Enable or Disable public network access to workspace
WorkspaceRepositoryConfiguration	Git integration settings

CspWorkspaceAdminProperties

Object

Initial workspace AAD admin properties for a CSP subscription

Name	Type	Description
initialWorkspaceAdminObjectId	string	AAD object ID of initial workspace admin

CustomerManagedKeyDetails

Object

Details of the customer managed key associated with the workspace

Name	Type	Description
kekIdentity	KekIdentityProperties	Key encryption key
key	WorkspaceKeyDetails	The key object of the workspace
status	string	The customer managed key status on the workspace

DataLakeStorageAccountDetails

Object

Details of the data lake storage account associated with the workspace

Name	Type	Description
accountUrl	string	Account URL
createManagedPrivateEndpoint	boolean	Create managed private endpoint to this storage account or not
filesystem	string	Filesystem name
resourceId	string	ARM resource Id of this storage account

EncryptionDetails

Object

Details of the encryption associated with the workspace

Name	Type	Description
cmk	CustomerManagedKeyDetails	Customer Managed Key Details
doubleEncryptionEnabled	boolean	Double Encryption enabled

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

KekIdentityProperties

Object

Key encryption key properties

Name	Type	Description
useSystemAssignedIdentity		Boolean specifying whether to use system assigned identity or not
userAssignedIdentity	string	User assigned identity resource Id

ManagedIdentity

Object

The workspace managed identity

Name	Type	Description
principalId	string	The principal ID of the workspace managed identity
tenantId	string (uuid)	The tenant ID of the workspace managed identity
type	ResourceIdentityType	The type of managed identity for the workspace
userAssignedIdentities	<string,  UserAssignedManagedIdentity>	The user assigned managed identities.

ManagedVirtualNetworkSettings

Object

Managed Virtual Network Settings

Name	Type	Description
allowedAadTenantIdsForLinking	string[]	Allowed Aad Tenant Ids For Linking
linkedAccessCheckOnTargetResource	boolean	Linked Access Check On Target Resource
preventDataExfiltration	boolean	Prevent Data Exfiltration

PrivateEndpoint

Object

Private endpoint details

Name	Type	Description
id	string	Resource id of the private endpoint.

PrivateEndpointConnection

Object

A private endpoint connection

Name	Type	Description
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
properties.privateEndpoint	PrivateEndpoint	The private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Connection state of the private endpoint connection.
properties.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"

PrivateLinkServiceConnectionState

Object

Connection state details of the private endpoint

Name	Type	Description
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.

PurviewConfiguration

Object

Purview Configuration

Name	Type	Description
purviewResourceId	string	Purview Resource ID

ResourceIdentityType

Enumeration

The type of managed identity for the workspace

Value	Description
None
SystemAssigned
SystemAssigned,UserAssigned

UserAssignedManagedIdentity

Object

User Assigned Managed Identity

Name	Type	Description
clientId	string (uuid)	The client ID.
principalId	string (uuid)	The principal ID.

VirtualNetworkProfile

Object

Virtual Network Profile

Name	Type	Description
computeSubnetId	string	Subnet ID used for computes in workspace

Workspace

Object

A workspace

Name	Type	Default value	Description
id	string		Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedIdentity		Identity of the workspace
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.adlaResourceId	string		The ADLA resource ID.
properties.azureADOnlyAuthentication	boolean		Enable or Disable AzureADOnlyAuthentication on All Workspace subresource
properties.connectivityEndpoints	object		Connectivity endpoints
properties.cspWorkspaceAdminProperties	CspWorkspaceAdminProperties		Initial workspace AAD admin properties for a CSP subscription
properties.defaultDataLakeStorage	DataLakeStorageAccountDetails		Workspace default data lake storage account details
properties.encryption	EncryptionDetails		The encryption details of the workspace
properties.extraProperties	object		Workspace level configs and feature flags
properties.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 '.'
properties.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.
properties.managedVirtualNetworkSettings	ManagedVirtualNetworkSettings		Managed Virtual Network Settings
properties.privateEndpointConnections	PrivateEndpointConnection[]		Private endpoint connections to the workspace
properties.provisioningState	string		Resource provisioning state
properties.publicNetworkAccess	WorkspacePublicNetworkAccess	Enabled	Enable or Disable public network access to workspace
properties.purviewConfiguration	PurviewConfiguration		Purview Configuration
properties.settings	object		Workspace settings
properties.sqlAdministratorLogin	string		Login for workspace SQL active directory administrator
properties.sqlAdministratorLoginPassword	string		SQL administrator login password
properties.trustedServiceBypassEnabled	boolean	False	Is trustedServiceBypassEnabled for the workspace
properties.virtualNetworkProfile	VirtualNetworkProfile		Virtual Network profile
properties.workspaceRepositoryConfiguration	WorkspaceRepositoryConfiguration		Git integration settings
properties.workspaceUID	string (uuid)		The workspace unique identifier
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

WorkspaceInfoListResult

Object

List of workspaces

Name	Type	Description
nextLink	string	Link to the next page of results
value	Workspace[]	List of workspaces

WorkspaceKeyDetails

Object

Details of the customer managed key associated with the workspace

Name	Type	Description
keyVaultUrl	string	Workspace Key sub-resource key vault url
name	string	Workspace Key sub-resource name

WorkspacePublicNetworkAccess

Enumeration

Enable or Disable public network access to workspace

Value	Description
Enabled
Disabled

WorkspaceRepositoryConfiguration

Object

Git integration settings

Name	Type	Description
accountName	string	Account name
collaborationBranch	string	Collaboration branch
hostName	string	GitHub Enterprise host name. For example: https://github.mydomain.com
lastCommitId	string	The last commit ID
projectName	string	VSTS project name
repositoryName	string	Repository name
rootFolder	string	Root folder to use in the repository
tenantId	string (uuid)	The VSTS tenant ID
type	string	Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration