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

az synapse workspace

管理 Synapse 工作区。

命令

名称	说明	类型	Status
az synapse workspace activate	激活工作区，并在首次预配工作区并启用双重加密时将其状态从挂起更改为成功状态。	核心	GA
az synapse workspace check-name	检查 Synapse 工作区名称是否可用。	核心	GA
az synapse workspace create	创建 Synapse 工作区中的步骤创建一个新工作区。	核心	GA
az synapse workspace delete	删除 Synapse 工作区。	核心	GA
az synapse workspace firewall-rule	管理工作区的防火墙规则。	核心	GA
az synapse workspace firewall-rule create	创建防火墙规则。	核心	GA
az synapse workspace firewall-rule delete	删除防火墙规则。	核心	GA
az synapse workspace firewall-rule list	列出所有防火墙规则。	核心	GA
az synapse workspace firewall-rule show	获取防火墙规则。	核心	GA
az synapse workspace firewall-rule update	更新防火墙规则。	核心	GA
az synapse workspace firewall-rule wait	将 CLI 置于等待状态，直到满足防火墙规则的条件。	核心	GA
az synapse workspace key	管理工作区的密钥。	核心	GA
az synapse workspace key create	创建工作区的密钥。	核心	GA
az synapse workspace key delete	删除工作区的密钥。 无法删除处于活动状态的密钥。	核心	GA
az synapse workspace key list	列出指定工作区下的密钥。	核心	GA
az synapse workspace key show	按名称显示工作区的密钥。	核心	GA
az synapse workspace key wait	将 CLI 置于等待状态，直到满足工作区密钥的条件。	核心	GA
az synapse workspace list	列出所有 Synapse 工作区。	核心	GA
az synapse workspace managed-identity	管理工作区的托管标识。	核心	GA
az synapse workspace managed-identity grant-sql-access	授予工作区对托管标识的 sql 访问权限。	核心	GA
az synapse workspace managed-identity revoke-sql-access	撤销工作区对托管标识的 sql 访问权限。	核心	GA
az synapse workspace managed-identity show-sql-access	显示工作区对托管标识的 sql 访问状态。	核心	GA
az synapse workspace managed-identity wait	将 CLI 置于等待状态，直到满足托管标识的 sql 访问状态。	核心	GA
az synapse workspace show	获取 Synapse 工作区。	核心	GA
az synapse workspace update	更新 Synapse 工作区。	核心	GA
az synapse workspace wait	将 CLI 置于等待状态，直到满足工作区的条件。	核心	GA

az synapse workspace activate

激活工作区，并在首次预配工作区并启用双重加密时将其状态从挂起更改为成功状态。

创建 Azure Synapse Analytics 工作区时，可以选择使用客户管理的密钥加密工作区中的所有静态数据，该密钥将为工作区提供双重加密。可能需要首先设置加密环境，例如创建启用了清除保护的密钥保管库，并指定密钥保管库的访问策略。 然后，使用此 cmdlet 激活使用客户管理的密钥启用双重加密的新 Azure Synapse Analytics 工作区。

az synapse workspace activate --key-identifier
                              [--ids]
                              [--name]
                              [--no-wait]
                              [--resource-group]
                              [--subscription]
                              [--workspace-name]

示例

激活工作区。

az synapse workspace activate --name newkey --workspace-name testsynapseworkspace \
--resource-group rg --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname}

必需参数

--key-identifier

工作区加密密钥的密钥库 URL。 应采用以下格式：https://{keyvaultname}.vault.azure.net/keys/{keyname}。

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--name -n

工作区客户管理的密钥显示名称。 可以使用 /“az synapse workspace key list/” cmdlet 找到所有现有密钥。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--workspace-name

工作区名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse workspace check-name

检查 Synapse 工作区名称是否可用。

az synapse workspace check-name --name

示例

检查 Synapse 工作区名称是否可用。

az synapse workspace check-name --name testsynapseworkspace

必需参数

--name -n

要检查的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse workspace create

创建 Synapse 工作区中的步骤创建一个新工作区。

az synapse workspace create --file-system
                            --name
                            --resource-group
                            --sql-admin-login-password
                            --sql-admin-login-user
                            --storage-account
                            [--account-name]
                            [--allowed-tenant-ids]
                            [--cmk]
                            [--collaboration-branch]
                            [--enable-managed-virtual-network {false, true}]
                            [--host-name]
                            [--key-name]
                            [--last-commit-id]
                            [--location]
                            [--managed-rg-name]
                            [--no-wait]
                            [--prevent-data-exfiltration {false, true}]
                            [--project-name]
                            [--repository-name]
                            [--repository-type {AzureDevOpsGit, GitHub}]
                            [--root-folder]
                            [--tags]
                            [--tenant-id]
                            [--uami-id]
                            [--uami-id-in-encrypt]
                            [--use-sami-in-encrypt]

示例

创建 Synapse 工作区

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

创建包含存储资源 ID 的 Synapse 工作区

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

使用客户管理的密钥创建 Synapse 工作区

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname} --key-name testcmk \
  --use-sami-in-encrypt True

创建连接到 Azure devops 的 Synapse 工作区

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --repository-type AzureDevOpsGit --account-name testuser --project-name testprj \
  --repository-name testrepo --collaboration-branch main --last-commit-id 000000

使用托管资源组创建 Synapse 工作区

az synapse workspace create --name testworkspace --resource-group rg \
  --managed-rg-name managedrg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

使用用户分配的托管标识创建 Synapse 工作区

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

必需参数

--file-system

Data Lake 存储帐户的文件系统。

--name -n

工作区名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--sql-admin-login-password -p

sql 管理员登录密码。

--sql-admin-login-user -u

sql 管理员登录用户名。

--storage-account

Data Lake 存储帐户名称或资源 ID。

可选参数

--account-name

用于存储库或 Azure devops 组织名称的 GitHub 帐户名称。

--allowed-tenant-ids

允许出站数据流量到的已批准的 Azure AD 租户。 默认情况下，将包含当前用户的 Azure AD 租户。 在 PowerShell 中使用“”或“'”禁用所有允许的租户 ID。

--cmk --key-identifier

用于加密工作区中所有数据的客户管理的密钥。 密钥标识符的格式应为：https://{keyvaultname}.vault.azure.net/keys/{keyname}。

--collaboration-branch

将在其中与其他人协作以及从中发布分支名称。

--enable-managed-virtual-network --enable-managed-vnet

该标志指示是否启用托管虚拟网络。

接受的值: false, true

--host-name

如果使用 github Enterprise Server，请提供服务器 URL。 不要将此选项用于 GitHub Enterprise Cloud。

--key-name

工作区客户管理的密钥显示名称。 可以使用“az synapse workspace key list”cmdlet 找到所有现有密钥。

默认值: default

--last-commit-id

最后一个提交 ID。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--managed-rg-name

工作区托管资源组。 资源组名称唯一标识用户 subscriptionId 中的资源组。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--prevent-data-exfiltration --prevent-exfiltration

该标志指示是否启用数据外泄。

接受的值: false, true

--project-name

要连接到的项目名称。

--repository-name

要连接到的存储库的名称。

--repository-type

存储库配置类型。

接受的值: AzureDevOpsGit, GitHub

--root-folder

将文件夹的名称导入到 Azure synapse JSON 资源的位置。 默认值为 /。

默认值: /

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--tenant-id

用于连接 Azure devops 的租户 ID。

--uami-id

工作区的用户分配的托管标识 ID 列表。

--uami-id-in-encrypt

用户在工作区加密中使用的标识资源 ID。

--use-sami-in-encrypt

是否在工作区加密中使用系统分配的标识。 如果使用 uami，请设置 True。如果没有，请设置 False。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse workspace delete

删除 Synapse 工作区。

az synapse workspace delete [--ids]
                            [--name]
                            [--no-wait]
                            [--resource-group]
                            [--subscription]
                            [--yes]

示例

删除 Synapse 工作区。

az synapse workspace delete --name testsynapseworkspace --resource-group rg

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--name -n

工作区名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse workspace list

列出所有 Synapse 工作区。

az synapse workspace list [--resource-group]

示例

列出订阅下的所有 Synapse 工作区

az synapse workspace list

列出特定资源组下的所有 Synapse 工作区

az synapse workspace list --resource-group rg

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse workspace show

获取 Synapse 工作区。

az synapse workspace show [--ids]
                          [--name]
                          [--resource-group]
                          [--subscription]

示例

获取 Synapse 工作区。

az synapse workspace show --name testsynapseworkspace --resource-group rg

可选参数

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--name -n

工作区名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse workspace update

更新 Synapse 工作区。

az synapse workspace update [--account-name]
                            [--allowed-tenant-ids]
                            [--collaboration-branch]
                            [--host-name]
                            [--ids]
                            [--key-name]
                            [--last-commit-id]
                            [--name]
                            [--no-wait]
                            [--project-name]
                            [--repository-name]
                            [--repository-type {AzureDevOpsGit, GitHub}]
                            [--resource-group]
                            [--root-folder]
                            [--sql-admin-login-password]
                            [--subscription]
                            [--tags]
                            [--tenant-id]
                            [--uami-action {Add, Remove, Set}]
                            [--uami-id]
                            [--uami-id-in-encrypt]
                            [--use-sami-in-encrypt]

示例

更新 Synapse 工作区

az synapse workspace update --name fromcli4 --resource-group rg \
  --tags key1=value1

更新 Synapse 工作区，添加用户分配的托管标识

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Add --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

更新 Synapse 工作区，删除用户分配的托管标识

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Remove --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

更新 Synapse 工作区，重写用户分配的托管标识

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Set --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

更新 Synapse 工作区，设置工作区加密 uami

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-id-in-encrypt "{your-encrytion-uami-resourceid}" --use-sami-in-encrypt False

可选参数

--account-name

用于存储库或 Azure devops 组织名称的 GitHub 帐户名称。

--allowed-tenant-ids

允许出站数据流量到的已批准的 Azure AD 租户。 默认情况下，将包含当前用户的 Azure AD 租户。 在 PowerShell 中使用“”或“'”禁用所有允许的租户 ID。

--collaboration-branch

将在其中与其他人协作以及从中发布分支名称。

--host-name

如果使用 github Enterprise Server，请提供服务器 URL。 不要将此选项用于 GitHub Enterprise Cloud。

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--key-name

工作区客户管理的密钥显示名称。 可以使用“az synapse workspace key list”cmdlet 找到所有现有密钥。

--last-commit-id

最后一个提交 ID。

--name -n

工作区名称。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--project-name

要连接到的项目名称。

--repository-name

要连接到的存储库的名称。

--repository-type

存储库配置类型。

接受的值: AzureDevOpsGit, GitHub

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--root-folder

将文件夹的名称导入到 Azure synapse JSON 资源的位置。 默认值为 /。

--sql-admin-login-password -p

sql 管理员登录密码。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--tenant-id

用于连接 Azure devops 的租户 ID。

--uami-action

在为工作区添加/删除/设置用户分配的托管标识时，必须指定操作。支持的操作包括：Add、Remove、Set.Add 表示为工作区添加用户分配的托管标识、删除从工作区中删除用户分配的托管标识的方法，当想要添加和删除用户分配的托管标识时，可以使用 Set 同时添加和删除用户分配的托管标识，当前标识将由指定标识覆盖。

接受的值: Add, Remove, Set

--uami-id

工作区的用户分配的托管标识 ID 列表。

--uami-id-in-encrypt

用户在工作区加密中使用的标识资源 ID。

--use-sami-in-encrypt

是否在工作区加密中使用系统分配的标识。 如果使用 uami，请设置 True。如果没有，请设置 False。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az synapse workspace wait

将 CLI 置于等待状态，直到满足工作区的条件。

az synapse workspace wait --resource-group
                          --workspace-name
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--interval]
                          [--timeout]
                          [--updated]

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--workspace-name

工作区的名称。

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--interval

轮询间隔（以秒为单位）。

默认值: 30

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。