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

az synapse workspace key

参考

管理工作区的密钥。

命令

名称	说明	类型	Status
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 key create

编辑

创建工作区的密钥。

az synapse workspace key create --key-identifier
                                --name
                                --resource-group
                                --workspace-name
                                [--no-wait]

示例

创建工作区的密钥。

az synapse workspace key create --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}。

--name -n

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

--resource-group -g

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

--workspace-name

工作区名称。

可选参数

--no-wait

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

默认值: 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 key delete

编辑

删除工作区的密钥。无法删除处于活动状态的密钥。

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

示例

删除工作区的密钥。

az synapse workspace key delete --name newkey --workspace-name testsynapseworkspace \
--resource-group rg

可选参数

--ids

一个或多个资源 ID（空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 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

工作区名称。

--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 key list

编辑

列出指定工作区下的密钥。

az synapse workspace key list --resource-group
                              --workspace-name

示例

列出指定工作区下的密钥。

az synapse workspace key list --workspace-name testsynapseworkspace --resource-group rg

必需参数

--resource-group -g

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

--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 key show

编辑

按名称显示工作区的密钥。

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

示例

显示工作区的密钥。

az synapse workspace key show --name newkey --workspace-name testsynapseworkspace \
--resource-group rg

可选参数

--ids

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

--name -n

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

--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 key wait

编辑

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

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

必需参数

--key-name

工作区密钥的名称。

可选参数

--created

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

默认值: False

--custom

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

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

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

--interval

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

默认值: 30

--resource-group -g

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

--subscription

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

--timeout

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

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

--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 key

命令

az synapse workspace key create

示例

必需参数

可选参数

az synapse workspace key delete

示例

可选参数

az synapse workspace key list

示例

必需参数

az synapse workspace key show

示例

可选参数

az synapse workspace key wait

必需参数

可选参数

其他资源