您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

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 update

更新工作区的键。

az synapse workspace key wait

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

az synapse workspace key create

创建工作区的键。

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

示例

创建工作区的键。

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

必需参数

--key-identifier

工作区加密密钥的 Key Vault Url。 的格式应为: https://{keyvaultname/keys/{keyname}。

--name -n

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

--resource-group -g

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

--workspace-name

工作区名称。

可选参数

--no-wait

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

--subscription

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

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

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

--resource-group -g

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

--subscription

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

--workspace-name

工作区名称。

--yes -y

不提示确认。

az synapse workspace key list

列出指定工作区下的键。

az synapse workspace key list --resource-group
                              --workspace-name
                              [--query-examples]
                              [--subscription]

示例

列出指定工作区下的键。

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

必需参数

--resource-group -g

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

--workspace-name

工作区名称。

可选参数

--query-examples

建议 JMESPath 字符串。 可以复制其中一个查询,然后将其粘贴在双引号内,以查看结果。 您可以添加一个或多个位置关键字,以便我们可以根据这些关键字提供建议。

--subscription

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

az synapse workspace key show

按名称显示工作区的键。

az synapse workspace key show [--ids]
                              [--name]
                              [--query-examples]
                              [--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 找到所有现有密钥。

--query-examples

建议 JMESPath 字符串。 可以复制其中一个查询,然后将其粘贴在双引号内,以查看结果。 您可以添加一个或多个位置关键字,以便我们可以根据这些关键字提供建议。

--resource-group -g

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

--subscription

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

--workspace-name

工作区名称。

az synapse workspace key update

更新工作区的键。

激活工作区,并将其状态从 "挂起" 更改为 "成功"。 若要在激活工作区之后切换到另一个 CMK,则需改为执行 "az synapse workspace update"。

az synapse workspace key update --key-identifier
                                [--ids]
                                [--is-active {false, true}]
                                [--name]
                                [--no-wait]
                                [--resource-group]
                                [--subscription]
                                [--workspace-name]

示例

更新工作区的键。

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

必需参数

--key-identifier

工作区加密密钥的 Key Vault Url。 的格式应为: https://{keyvaultname/keys/{keyname}。

可选参数

--ids

一个或多个资源 Id (以空格分隔) 。 它应该是包含 "资源 Id" 参数的所有信息的完整资源 ID。 应提供--id 或其他 "资源 Id" 参数。

--is-active

设置为 True 可将工作区状态从 "挂起" 更改为 "成功" 状态。

接受的值: false, true
--name -n

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

--no-wait

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

--resource-group -g

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

--subscription

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

--workspace-name

工作区名称。

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

等待 "provisioningState" 在 "Succeeded" 处创建。

--custom

等到条件满足自定义 JMESPath 查询。 例如 provisioningState! = "InProgress",instanceView [? code = = ' PowerState/正在运行 ']。

--deleted

等待,直到被删除。

--exists

等待该资源存在。

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

请等待,直到在 "Succeeded" 中更新 provisioningState。

--workspace-name

工作区名称。