Workspaces - List

服務:: Synapse

API 版本:: 2021-06-01

傳回訂用帳戶中的工作區清單

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

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	WorkspaceInfoListResult
Other Status Codes	ErrorResponse

範例

List workspaces in subscription

範例要求

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


/**
 * 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

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

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

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

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

範例回覆

狀態碼:: 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"
      }
    }
  ]
}

定義

名稱	Description
CspWorkspaceAdminProperties	CSP 訂用帳戶的初始工作區 AAD 管理員屬性
CustomerManagedKeyDetails	與工作區相關聯的客戶管理金鑰詳細數據
DataLakeStorageAccountDetails	與工作區相關聯的 Data Lake Storage 帳戶詳細數據
EncryptionDetails	與工作區相關聯的加密詳細數據
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
KekIdentityProperties	金鑰加密金鑰屬性
ManagedIdentity	工作區受控識別
ManagedVirtualNetworkSettings	受控虛擬網路設定
PrivateEndpoint	私人端點詳細數據
PrivateEndpointConnection	私人端點連線
PrivateLinkServiceConnectionState	私人端點的連線狀態詳細數據
PurviewConfiguration	Purview 組態
ResourceIdentityType	工作區的受控識別類型
UserAssignedManagedIdentity	使用者指派的受控識別
VirtualNetworkProfile	虛擬網路配置檔
Workspace	工作區
WorkspaceInfoListResult	工作區清單
WorkspaceKeyDetails	與工作區相關聯的客戶管理金鑰詳細數據
WorkspacePublicNetworkAccess	啟用或停用工作區的公用網路存取
WorkspaceRepositoryConfiguration	Git 整合設定

CspWorkspaceAdminProperties

Object

CSP 訂用帳戶的初始工作區 AAD 管理員屬性

名稱	類型	Description
initialWorkspaceAdminObjectId	string	初始工作區管理員的 AAD 物件識別碼

CustomerManagedKeyDetails

Object

與工作區相關聯的客戶管理金鑰詳細數據

名稱	類型	Description
kekIdentity	KekIdentityProperties	金鑰加密金鑰
key	WorkspaceKeyDetails	工作區的索引鍵物件
status	string	工作區上的客戶管理金鑰狀態

DataLakeStorageAccountDetails

Object

與工作區相關聯的 Data Lake Storage 帳戶詳細數據

名稱	類型	Description
accountUrl	string	帳戶 URL
createManagedPrivateEndpoint	boolean	建立此記憶體帳戶的受控私人端點
filesystem	string	檔案系統名稱
resourceId	string	此記憶體帳戶的 ARM 資源識別碼

EncryptionDetails

Object

與工作區相關聯的加密詳細數據

名稱	類型	Description
cmk	CustomerManagedKeyDetails	客戶管理的金鑰詳細數據
doubleEncryptionEnabled	boolean	已啟用雙重加密

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

KekIdentityProperties

Object

金鑰加密金鑰屬性

名稱	類型	Description
useSystemAssignedIdentity		布爾值，指定是否要使用系統指派的身分識別
userAssignedIdentity	string	使用者指派的身分識別資源標識碼

ManagedIdentity

Object

工作區受控識別

名稱	類型	Description
principalId	string	工作區受控識別的主要標識碼
tenantId	string (uuid)	工作區受控識別的租用戶標識碼
type	ResourceIdentityType	工作區的受控識別類型
userAssignedIdentities	<string, UserAssignedManagedIdentity>	使用者指派的受控識別。

ManagedVirtualNetworkSettings

Object

受控虛擬網路設定

名稱	類型	Description
allowedAadTenantIdsForLinking	string[]	允許連結的 Aad 租使用者識別碼
linkedAccessCheckOnTargetResource	boolean	目標資源的連結存取檢查
preventDataExfiltration	boolean	防止數據外流

PrivateEndpoint

Object

私人端點詳細數據

名稱	類型	Description
id	string	私人端點的資源標識碼。

PrivateEndpointConnection

Object

私人端點連線

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.privateEndpoint	PrivateEndpoint	線上所屬的私人端點。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	私人端點連線的連接狀態。
properties.provisioningState	string	布建私人端點連線的狀態。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateLinkServiceConnectionState

Object

私人端點的連線狀態詳細數據

名稱	類型	Description
actionsRequired	string	私人鏈接服務連線所需的動作。
description	string	私人鏈接服務連線描述。
status	string	私人鏈接服務連線狀態。

PurviewConfiguration

Object

Purview 組態

名稱	類型	Description
purviewResourceId	string	Purview 資源標識碼

ResourceIdentityType

列舉型別

工作區的受控識別類型

值	Description
None
SystemAssigned
SystemAssigned,UserAssigned

UserAssignedManagedIdentity

Object

使用者指派的受控識別

名稱	類型	Description
clientId	string (uuid)	用戶端識別碼。
principalId	string (uuid)	主體標識碼。

VirtualNetworkProfile

Object

虛擬網路配置檔

名稱	類型	Description
computeSubnetId	string	工作區中用於計算的子網標識碼

Workspace

Object

工作區

名稱	類型	預設值	Description
id	string		資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedIdentity		工作區的身分識別
location	string		資源所在的地理位置
name	string		資源的名稱
properties.adlaResourceId	string		ADLA 資源標識碼。
properties.azureADOnlyAuthentication	boolean		在所有工作區子資源上啟用或停用 AzureADOnlyAuthentication
properties.connectivityEndpoints	object		線上端點
properties.cspWorkspaceAdminProperties	CspWorkspaceAdminProperties		CSP 訂用帳戶的初始工作區 AAD 管理員屬性
properties.defaultDataLakeStorage	DataLakeStorageAccountDetails		工作區預設 Data Lake 記憶體帳戶詳細數據
properties.encryption	EncryptionDetails		工作區的加密詳細數據
properties.extraProperties	object		工作區層級設定和功能旗標
properties.managedResourceGroupName	string		工作區受控資源群組。資源組名會唯一識別使用者 subscriptionId 內的資源群組。資源組名長度不得超過 90 個字元，而且必須是英數位元（Char.IsLetterOrDigit（））和 '-'、'_'、'（'、'）' 和'。'。請注意，名稱不能以『.』結尾。
properties.managedVirtualNetwork	string		將此設定為『default』可確保此工作區的所有計算都代表使用者管理虛擬網路中。
properties.managedVirtualNetworkSettings	ManagedVirtualNetworkSettings		受控虛擬網路設定
properties.privateEndpointConnections	PrivateEndpointConnection[]		工作區的私人端點連線
properties.provisioningState	string		資源布建狀態
properties.publicNetworkAccess	WorkspacePublicNetworkAccess	Enabled	啟用或停用工作區的公用網路存取
properties.purviewConfiguration	PurviewConfiguration		Purview 組態
properties.settings	object		工作區設定
properties.sqlAdministratorLogin	string		工作區 SQL Active Directory 系統管理員的登入
properties.sqlAdministratorLoginPassword	string		SQL 系統管理員登入密碼
properties.trustedServiceBypassEnabled	boolean	False	是工作區的 trustedServiceBypassEnabled
properties.virtualNetworkProfile	VirtualNetworkProfile		虛擬網路配置檔
properties.workspaceRepositoryConfiguration	WorkspaceRepositoryConfiguration		Git 整合設定
properties.workspaceUID	string (uuid)		工作區唯一標識碼
tags	object		資源標籤。
type	string		資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

WorkspaceInfoListResult

Object

工作區清單

名稱	類型	Description
nextLink	string	連結到結果的下一頁
value	Workspace[]	工作區清單

WorkspaceKeyDetails

Object

與工作區相關聯的客戶管理金鑰詳細數據

名稱	類型	Description
keyVaultUrl	string	工作區金鑰子資源金鑰保存庫 URL
name	string	工作區金鑰子資源名稱

WorkspacePublicNetworkAccess

列舉型別

啟用或停用工作區的公用網路存取

值	Description
Enabled
Disabled

WorkspaceRepositoryConfiguration

Object

Git 整合設定

名稱	類型	Description
accountName	string	帳戶名稱
collaborationBranch	string	共同作業分支
hostName	string	GitHub Enterprise 主機名。例如：`https://github.mydomain.com`
lastCommitId	string	最後一個認可標識碼
projectName	string	VSTS 項目名稱
repositoryName	string	存放庫名稱
rootFolder	string	存放庫中要使用的根資料夾
tenantId	string (uuid)	VSTS 租使用者標識碼
type	string	工作區存放庫標識碼組態的類型。範例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration