你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Workspace - Get

服务:: Synapse

API 版本:: 2020-12-01

获取工作区

GET {endpoint}/workspace?api-version=2020-12-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	工作区开发终结点，例如 `https://myworkspace.dev.azuresynapse.net`。
api-version	query	True	string	Synapse 客户端 API 版本。

响应

名称	类型	说明
200 OK	Workspace	成功响应。
Other Status Codes	ErrorContract	描述作失败的原因的错误响应。

示例

Get Workspace Information

示例请求

HTTP

GET exampleWorkspace.dev.azuresynapse.net/workspace?api-version=2020-12-01

示例响应

状态代码:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace",
  "location": "southeastasia",
  "name": "exampleWorkspace",
  "type": "Microsoft.Synapse/workspaces",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "tags": {},
  "properties": {
    "connectivityEndpoints": {
      "web": "https://web.azuresynapse.net?workspace=%2fsubscriptions%2f00000000-0000-0000-0000-000000000000%2fresourceGroups%2frg%2fproviders%2fMicrosoft.Synapse%2fworkspaces%2fexampleWorkspace",
      "sql": "exampleWorkspace.sql.azuresynapse.net",
      "dev": "https://exampleWorkspace.dev.azuresynapse.net",
      "sqlOnDemand": "exampleWorkspace-ondemand.sql.azuresynapse.net"
    },
    "managedResourceGroupName": "workspacemanagedrg-1a992746-f580-4fce-a696-b0373bc6959a",
    "defaultDataLakeStorage": {
      "accountUrl": "https://exampleWorkspacedfs.dfs.core.windows.net",
      "filesystem": "synapse"
    },
    "sqlAdministratorLogin": "sqladminuser",
    "privateEndpointConnections": [],
    "workspaceRepositoryConfiguration": {
      "type": "FactoryGitHubConfiguration",
      "hostName": "",
      "accountName": "myGithubAccount",
      "projectName": "myProject",
      "repositoryName": "myRepository",
      "collaborationBranch": "master",
      "rootFolder": "/"
    },
    "provisioningState": "Succeeded"
  }
}

状态代码:: default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

定义

名称	说明
CustomerManagedKeyDetails	与工作区关联的客户托管密钥的详细信息
DataLakeStorageAccountDetails	与工作区关联的 Data Lake 存储帐户的详细信息
EncryptionDetails	与工作区关联的加密的详细信息
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorContract	错误详细信息。
ErrorResponse	错误响应
GitHubClientSecret	工厂自带应用存储库配置的客户端机密信息
ManagedIdentity	工作区托管标识
ManagedVirtualNetworkSettings	托管虚拟网络设置
PrivateEndpoint	专用终结点详细信息
PrivateEndpointConnection	专用终结点连接
PrivateLinkServiceConnectionState	专用终结点的连接状态详细信息
PurviewConfiguration	Purview 配置
ResourceIdentityType	工作区的托管标识类型
VirtualNetworkProfile	虚拟网络配置文件
Workspace	工作区
WorkspaceKeyDetails	与工作区关联的客户托管密钥的详细信息
WorkspaceRepositoryConfiguration	Git 集成设置

CustomerManagedKeyDetails

Object

与工作区关联的客户托管密钥的详细信息

名称	类型	说明
key	WorkspaceKeyDetails	工作区的键对象
status	string	工作区上的客户托管密钥状态

DataLakeStorageAccountDetails

Object

与工作区关联的 Data Lake 存储帐户的详细信息

名称	类型	说明
accountUrl	string	帐户 URL
filesystem	string	文件系统名称

EncryptionDetails

Object

与工作区关联的加密的详细信息

名称	类型	说明
cmk	CustomerManagedKeyDetails	客户管理的密钥详细信息
doubleEncryptionEnabled	boolean	已启用双重加密

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorContract

Object

错误详细信息。

名称	类型	说明
error	ErrorResponse	错误响应错误详细信息。

ErrorResponse

Object

错误响应

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorResponse[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

GitHubClientSecret

Object

工厂自带应用存储库配置的客户端机密信息

名称	类型	说明
byoaSecretAkvUrl	string	自带应用客户端密码 AKV URL
byoaSecretName	string	在 AKV 中自带应用客户端密码名称

ManagedIdentity

Object

工作区托管标识

名称	类型	说明
principalId	string	工作区托管标识的主体 ID
tenantId	string (uuid)	工作区托管标识的租户 ID
type	ResourceIdentityType	工作区的托管标识类型

ManagedVirtualNetworkSettings

Object

托管虚拟网络设置

名称	类型	说明
allowedAadTenantIdsForLinking	string[]	允许链接的 Aad 租户 ID
linkedAccessCheckOnTargetResource	boolean	目标资源上的链接访问检查
preventDataExfiltration	boolean	防止数据外泄

PrivateEndpoint

Object

专用终结点详细信息

名称	类型	说明
id	string	专用终结点的资源 ID。

PrivateEndpointConnection

Object

专用终结点连接

名称	类型	说明
id	string	资源的完全限定资源 ID。示例 - /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

专用终结点的连接状态详细信息

名称	类型	说明
actionsRequired	string	专用链接服务连接所需的作。
description	string	专用链接服务连接说明。
status	string	专用链接服务连接状态。

PurviewConfiguration

Object

Purview 配置

名称	类型	说明
purviewResourceId	string	Purview 资源 ID

ResourceIdentityType

枚举

工作区的托管标识类型

值	说明
None
SystemAssigned

VirtualNetworkProfile

Object

虚拟网络配置文件

名称	类型	说明
computeSubnetId	string	用于工作区中计算的子网 ID

Workspace

Object

工作区

名称	类型	说明
id	string	资源的完全限定资源 ID。示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedIdentity	工作区的标识
location	string	资源所在的地理位置
name	string	资源的名称
properties.adlaResourceId	string	ADLA 资源 ID。
properties.connectivityEndpoints	object	连接终结点
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.purviewConfiguration	PurviewConfiguration	Purview 配置
properties.sqlAdministratorLogin	string	工作区 SQL Active Directory 管理员登录
properties.sqlAdministratorLoginPassword	string	SQL 管理员登录密码
properties.virtualNetworkProfile	VirtualNetworkProfile	虚拟网络配置文件
properties.workspaceRepositoryConfiguration	WorkspaceRepositoryConfiguration	Git 集成设置
properties.workspaceUID	string (uuid)	工作区唯一标识符
tags	object	资源标记。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

WorkspaceKeyDetails

Object

与工作区关联的客户托管密钥的详细信息

名称	类型	说明
keyVaultUrl	string	工作区密钥子资源密钥保管库 URL
name	string	工作区密钥子资源名称

WorkspaceRepositoryConfiguration

Object

Git 集成设置

名称	类型	说明
accountName	string	帐户名称
clientId	string	GitHub 自带应用客户端 ID
clientSecret	GitHubClientSecret	GitHub 自带应用客户端机密信息。
collaborationBranch	string	协作分支
hostName	string	GitHub Enterprise 主机名。例如：`https://github.mydomain.com`
lastCommitId	string	上次提交 ID
projectName	string	VSTS 项目名称
repositoryName	string	存储库名称
rootFolder	string	要用于存储库的根文件夹
tenantId	string (uuid)	VSTS 租户 ID
type	string	工作区 repositoryID 配置的类型。示例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration

通过

Workspace - Get

URI 参数

响应

示例

Get Workspace Information

示例请求

示例响应

定义

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

EncryptionDetails

ErrorAdditionalInfo

ErrorContract

ErrorResponse

GitHubClientSecret

ManagedIdentity

ManagedVirtualNetworkSettings

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkServiceConnectionState

PurviewConfiguration

ResourceIdentityType

VirtualNetworkProfile

Workspace

WorkspaceKeyDetails

WorkspaceRepositoryConfiguration