Workspaces - List

Servizio:

Synapse

Versione API:

2021-06-01

Restituisce un elenco di aree di lavoro in una sottoscrizione

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	WorkspaceInfoListResult
Other Status Codes	ErrorResponse

Esempio

List workspaces in subscription

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CspWorkspaceAdminProperties	Proprietà di amministratore AAD iniziali dell'area di lavoro per una sottoscrizione CSP
CustomerManagedKeyDetails	Dettagli della chiave gestita dal cliente associata all'area di lavoro
DataLakeStorageAccountDetails	Dettagli dell'account di archiviazione data lake associato all'area di lavoro
EncryptionDetails	Dettagli della crittografia associata all'area di lavoro
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
KekIdentityProperties	Proprietà della chiave di crittografia delle chiavi
ManagedIdentity	Identità gestita dell'area di lavoro
ManagedVirtualNetworkSettings	Impostazioni della rete virtuale gestita
PrivateEndpoint	Dettagli dell'endpoint privato
PrivateEndpointConnection	Una connessione endpoint privato
PrivateLinkServiceConnectionState	Dettagli dello stato della connessione dell'endpoint privato
PurviewConfiguration	Configurazione di Purview
ResourceIdentityType	Tipo di identità gestita per l'area di lavoro
UserAssignedManagedIdentity	Identità gestita assegnata dall'utente
VirtualNetworkProfile	Profilo di rete virtuale
Workspace	Un'area di lavoro
WorkspaceInfoListResult	Elenco di aree di lavoro
WorkspaceKeyDetails	Dettagli della chiave gestita dal cliente associata all'area di lavoro
WorkspacePublicNetworkAccess	Abilitare o disabilitare l'accesso alla rete pubblica all'area di lavoro
WorkspaceRepositoryConfiguration	Impostazioni di integrazione git

CspWorkspaceAdminProperties

Object

Proprietà di amministratore AAD iniziali dell'area di lavoro per una sottoscrizione CSP

Nome	Tipo	Descrizione
initialWorkspaceAdminObjectId	string	ID oggetto AAD dell'amministratore dell'area di lavoro iniziale

CustomerManagedKeyDetails

Object

Dettagli della chiave gestita dal cliente associata all'area di lavoro

Nome	Tipo	Descrizione
kekIdentity	KekIdentityProperties	Chiave di crittografia della chiave
key	WorkspaceKeyDetails	Oggetto chiave dell'area di lavoro
status	string	Stato della chiave gestita dal cliente nell'area di lavoro

DataLakeStorageAccountDetails

Object

Dettagli dell'account di archiviazione data lake associato all'area di lavoro

Nome	Tipo	Descrizione
accountUrl	string	URL dell'account
createManagedPrivateEndpoint	boolean	Creare o meno un endpoint privato gestito in questo account di archiviazione
filesystem	string	Nome file system
resourceId	string	ID risorsa ARM di questo account di archiviazione

EncryptionDetails

Object

Dettagli della crittografia associata all'area di lavoro

Nome	Tipo	Descrizione
cmk	CustomerManagedKeyDetails	Dettagli chiave gestita dal cliente
doubleEncryptionEnabled	boolean	Doppia crittografia abilitata

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

KekIdentityProperties

Object

Proprietà della chiave di crittografia delle chiavi

Nome	Tipo	Descrizione
useSystemAssignedIdentity		Valore booleano che specifica se usare o meno l'identità assegnata dal sistema
userAssignedIdentity	string	ID risorsa identità assegnata dall'utente

ManagedIdentity

Object

Identità gestita dell'area di lavoro

Nome	Tipo	Descrizione
principalId	string	ID entità dell'identità gestita dell'area di lavoro
tenantId	string (uuid)	ID tenant dell'identità gestita dell'area di lavoro
type	ResourceIdentityType	Tipo di identità gestita per l'area di lavoro
userAssignedIdentities	<string,  UserAssignedManagedIdentity>	Identità gestite assegnate dall'utente.

ManagedVirtualNetworkSettings

Object

Impostazioni della rete virtuale gestita

Nome	Tipo	Descrizione
allowedAadTenantIdsForLinking	string[]	ID tenant Aad consentiti per il collegamento
linkedAccessCheckOnTargetResource	boolean	Controllo di accesso collegato nella risorsa di destinazione
preventDataExfiltration	boolean	Impedire l'esfiltrazione di dati

PrivateEndpoint

Object

Dettagli dell'endpoint privato

Nome	Tipo	Descrizione
id	string	ID risorsa dell'endpoint privato.

PrivateEndpointConnection

Object

Una connessione endpoint privato

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.privateEndpoint	PrivateEndpoint	Endpoint privato a cui appartiene la connessione.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stato della connessione dell'endpoint privato.
properties.provisioningState	string	Stato di provisioning della connessione dell'endpoint privato.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Object

Dettagli dello stato della connessione dell'endpoint privato

Nome	Tipo	Descrizione
actionsRequired	string	Azioni necessarie per la connessione al servizio di collegamento privato.
description	string	Descrizione della connessione al servizio di collegamento privato.
status	string	Stato della connessione al servizio collegamento privato.

PurviewConfiguration

Object

Configurazione di Purview

Nome	Tipo	Descrizione
purviewResourceId	string	ID risorsa Purview

ResourceIdentityType

Enumerazione

Tipo di identità gestita per l'area di lavoro

Valore	Descrizione
None
SystemAssigned
SystemAssigned,UserAssigned

UserAssignedManagedIdentity

Object

Identità gestita assegnata dall'utente

Nome	Tipo	Descrizione
clientId	string (uuid)	ID client.
principalId	string (uuid)	ID entità.

VirtualNetworkProfile

Object

Profilo di rete virtuale

Nome	Tipo	Descrizione
computeSubnetId	string	ID subnet usato per i calcoli nell'area di lavoro

Workspace

Object

Un'area di lavoro

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedIdentity		Identità dell'area di lavoro
location	string		Posizione geografica in cui risiede la risorsa
name	string		Nome della risorsa
properties.adlaResourceId	string		ID risorsa ADLA.
properties.azureADOnlyAuthentication	boolean		Abilitare o disabilitare AzureADOnlyAuthentication in tutte le sottorisorse dell'area di lavoro
properties.connectivityEndpoints	object		Endpoint di connettività
properties.cspWorkspaceAdminProperties	CspWorkspaceAdminProperties		Proprietà di amministratore AAD iniziali dell'area di lavoro per una sottoscrizione CSP
properties.defaultDataLakeStorage	DataLakeStorageAccountDetails		Dettagli dell'account data lake storage predefinito dell'area di lavoro
properties.encryption	EncryptionDetails		Dettagli della crittografia dell'area di lavoro
properties.extraProperties	object		Configurazioni a livello di area di lavoro e flag di funzionalità
properties.managedResourceGroupName	string		Gruppo di risorse gestite dell'area di lavoro. Il nome del gruppo di risorse identifica in modo univoco il gruppo di risorse all'interno dell'id sottoscrizione utente. Il nome del gruppo di risorse non deve contenere più di 90 caratteri e deve essere composto da caratteri alfanumerici (Char.IsLetterOrDigit()) e '-', '_', '(', ')' e'.'. Si noti che il nome non può terminare con '.'
properties.managedVirtualNetwork	string		L'impostazione di questa opzione su "default" garantisce che tutte le risorse di calcolo per questa area di lavoro si trovano in una rete virtuale gestita per conto dell'utente.
properties.managedVirtualNetworkSettings	ManagedVirtualNetworkSettings		Impostazioni della rete virtuale gestita
properties.privateEndpointConnections	PrivateEndpointConnection[]		Connessioni endpoint privato all'area di lavoro
properties.provisioningState	string		Stato del provisioning delle risorse
properties.publicNetworkAccess	WorkspacePublicNetworkAccess	Enabled	Abilitare o disabilitare l'accesso alla rete pubblica all'area di lavoro
properties.purviewConfiguration	PurviewConfiguration		Configurazione di Purview
properties.settings	object		Impostazioni dell'area di lavoro
properties.sqlAdministratorLogin	string		Account di accesso per l'amministratore di SQL Active Directory dell'area di lavoro
properties.sqlAdministratorLoginPassword	string		Password di accesso dell'amministratore SQL
properties.trustedServiceBypassEnabled	boolean	False	TrustedServiceBypassEnabled per l'area di lavoro
properties.virtualNetworkProfile	VirtualNetworkProfile		Profilo di rete virtuale
properties.workspaceRepositoryConfiguration	WorkspaceRepositoryConfiguration		Impostazioni di integrazione git
properties.workspaceUID	string (uuid)		Identificatore univoco dell'area di lavoro
tags	object		Tag di risorsa.
type	string		Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkspaceInfoListResult

Object

Elenco di aree di lavoro

Nome	Tipo	Descrizione
nextLink	string	Collegamento alla pagina successiva dei risultati
value	Workspace[]	Elenco di aree di lavoro

WorkspaceKeyDetails

Object

Dettagli della chiave gestita dal cliente associata all'area di lavoro

Nome	Tipo	Descrizione
keyVaultUrl	string	URL dell'insieme di credenziali delle chiavi della chiave secondaria dell'area di lavoro
name	string	Nome della sotto-risorsa chiave dell'area di lavoro

WorkspacePublicNetworkAccess

Enumerazione

Abilitare o disabilitare l'accesso alla rete pubblica all'area di lavoro

Valore	Descrizione
Enabled
Disabled

WorkspaceRepositoryConfiguration

Object

Impostazioni di integrazione git

Nome	Tipo	Descrizione
accountName	string	Nome account
collaborationBranch	string	Ramo di collaborazione
hostName	string	Nome host GitHub Enterprise. Ad esempio: https://github.mydomain.com
lastCommitId	string	Ultimo ID commit
projectName	string	Nome del progetto VSTS
repositoryName	string	Nome repository
rootFolder	string	Cartella radice da usare nel repository
tenantId	string (uuid)	L'ID tenant VSTS
type	string	Tipo di configurazione repositoryID dell'area di lavoro. Esempio di WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration