你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.KeyVault 保管库/机密
Bicep 资源定义
保管库/机密资源类型可以通过针对以下操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
注解
有关使用密钥保管库获取安全值的指南，请参阅 使用 Bicep 管理机密。
有关创建机密的快速入门，请参阅快速入门：使用 ARM 模板从 Azure 密钥保管库设置和检索机密。
有关创建密钥的快速入门，请参阅 快速入门：使用 ARM 模板创建 Azure 密钥保管库和密钥。
资源格式
若要创建 Microsoft.KeyVault/vaults/secrets 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2023-07-01' = {
name: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
attributes: {
enabled: bool
exp: int
nbf: int
}
contentType: 'string'
value: 'string'
}
}
属性值
vaults/secrets
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中为子资源设置名称和类型。 |
字符串 (必需) 字符限制：1-127 有效字符： 字母数字和连字符。 |
| 标记 | 将分配给机密的标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为资源的符号名称： 保管库 |
| properties | 机密的属性 | SecretProperties (必需) |
SecretProperties
| 名称 | 说明 | 值 |
|---|---|---|
| attributes | 机密的属性。 | SecretAttributes |
| contentType | 机密的内容类型。 | string |
| value | 机密的值。 注意：永远不会从服务返回“value”，因为使用此模型的 API 用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。 | 字符串 |
SecretAttributes
| 名称 | 说明 | 值 |
|---|---|---|
| enabled | 确定是否启用对象。 | bool |
| exp | 自 1970-01-01T00：00：00Z 以来的到期日期（以秒为单位）。 | int |
| nbf | 自 1970-01-01T00：00：00Z 以来，不早于日期（以秒为单位）。 | int |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
适用于 Azure 的 SAS 9.4 和 Viya 快速入门模板 |
适用于 Azure 的 SAS® 9.4 和 Viya 快速入门模板在云中部署这些产品：SAS® Enterprise BI Server 9.4、SAS® Enterprise Miner 15.1 和 Linux 上的 SAS® Visual Analytics 8.5，以及 Linux for Viya 上的 SAS® Visual Data Mining and Machine Learning 8.5。 本快速入门是一个参考体系结构，适用于想要使用云友好技术在 Azure 上部署 SAS® 9.4 和 Viya 组合的用户。 通过在 Azure 上部署 SAS® 平台，可以获得 SAS® 9.4 和 Viya 环境的集成环境，以便可以同时利用这两种环境。 SAS® Viya 是一个支持云的内存中分析引擎。 它使用弹性、可缩放和容错处理来解决复杂的分析挑战。 SAS® Viya 通过使用支持 SAS®、Python、R、Java 和 Lua 编程的标准化代码库，为分析提供更快的处理。 它还支持云、本地或混合环境，并无缝部署到任何基础结构或应用程序生态系统。 |
| 使用 KeyVault 中的 SSL 创建API 管理服务 |
此模板部署使用用户分配的标识配置的API 管理服务。 它使用此标识从 KeyVault 提取 SSL 证书，并通过每 4 小时检查一次来保持更新。 |
| 创建 Azure Stack HCI 23H2 群集 |
此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。 |
| 创建 Azure Key Vault 和机密 |
此模板创建 Azure 密钥保管库和机密。 |
| 使用 RBAC 和机密创建 Azure 密钥保管库 |
此模板创建 Azure 密钥保管库和机密。 它不依赖于访问策略，而是利用 Azure RBAC 来管理机密上的授权 |
| 通过专用终结点连接到密钥保管库 |
此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问密钥保管库。 |
| 创建 Key Vault 和机密列表 |
此模板在密钥保管库中创建与参数一起传递的密钥保管库和机密列表 |
| 创建存储在 Azure 密钥保管库中的Azure Maps SAS 令牌 |
此模板部署和Azure Maps帐户，并根据提供的要存储在 Azure 密钥保管库机密中的用户分配标识列出 Sas 令牌。 |
| 使用 密钥保管库 创建应用程序网关 V2 |
此模板在虚拟网络中部署应用程序网关 V2、用户定义的标识、密钥保管库、机密 (证书数据) ，以及密钥保管库和应用程序网关上的访问策略。 |
| Azure 防火墙 Premium 的测试环境 |
此模板创建具有高级功能的Azure 防火墙高级和防火墙策略，例如入侵检查 (IDPS) 、TLS 检查和 Web 类别筛选 |
| 在 KeyVault 中创建 ssh 密钥和存储 |
此模板使用 deploymentScript 资源生成 ssh 密钥，并将私钥存储在 keyVault 中。 |
| Azure 函数应用和 HTTP 触发的函数 |
此示例在模板中部署 Azure 函数应用和 HTTP 触发的函数。 它还部署密钥保管库并使用函数应用的主机密钥填充机密。 |
| 使用内部API 管理和 Web 应用应用程序网关 |
应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例，该实例为 Azure Web 应用中托管的 Web API 提供服务。 |
ARM 模板资源定义
保管库/机密资源类型可以通过针对以下操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
注解
有关使用密钥保管库获取安全值的指南，请参阅 使用 Bicep 管理机密。
有关创建机密的快速入门，请参阅快速入门：使用 ARM 模板从 Azure 密钥保管库设置和检索机密。
有关创建密钥的快速入门，请参阅 快速入门：使用 ARM 模板创建 Azure 密钥保管库和密钥。
资源格式
若要创建 Microsoft.KeyVault/vaults/secrets 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.KeyVault/vaults/secrets",
"apiVersion": "2023-07-01",
"name": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"attributes": {
"enabled": "bool",
"exp": "int",
"nbf": "int"
},
"contentType": "string",
"value": "string"
}
}
属性值
vaults/secrets
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.KeyVault/vaults/secrets” |
| apiVersion | 资源 API 版本 | '2023-07-01' |
| name | 资源名称 了解如何在 JSON ARM 模板中为子资源设置名称和类型。 |
字符串 (必需) 字符限制：1-127 有效字符： 字母数字和连字符。 |
| 标记 | 将分配给机密的标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| properties | 机密的属性 | SecretProperties (必需) |
SecretProperties
| 名称 | 说明 | 值 |
|---|---|---|
| attributes | 机密的属性。 | SecretAttributes |
| contentType | 机密的内容类型。 | string |
| value | 机密的值。 注意：永远不会从服务返回“value”，因为使用此模型的 API 用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。 | 字符串 |
SecretAttributes
| 名称 | 说明 | 值 |
|---|---|---|
| enabled | 确定是否启用对象。 | bool |
| exp | 自 1970-01-01T00：00：00Z 以来的到期日期（以秒为单位）。 | int |
| nbf | 自 1970-01-01T00：00：00Z 以来，不早于日期（以秒为单位）。 | int |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
| 适用于 Azure 的 SAS 9.4 和 Viya 快速入门模板 |
适用于 Azure 的 SAS® 9.4 和 Viya 快速入门模板在云中部署这些产品：SAS® Enterprise BI Server 9.4、SAS® Enterprise Miner 15.1 和 Linux 上的 SAS® Visual Analytics 8.5，以及 Linux for Viya 上的 SAS® Visual Data Mining and Machine Learning 8.5。 本快速入门是一个参考体系结构，适用于想要使用云友好技术在 Azure 上部署 SAS® 9.4 和 Viya 组合的用户。 通过在 Azure 上部署 SAS® 平台，可以获得 SAS® 9.4 和 Viya 环境的集成环境，以便可以同时利用这两种环境。 SAS® Viya 是一个支持云的内存中分析引擎。 它使用弹性、可缩放和容错处理来解决复杂的分析挑战。 SAS® Viya 通过使用支持 SAS®、Python、R、Java 和 Lua 编程的标准化代码库，为分析提供更快的处理。 它还支持云、本地或混合环境，并无缝部署到任何基础结构或应用程序生态系统。 |
| 使用 KeyVault 中的 SSL 创建API 管理服务 |
此模板部署使用用户分配的标识配置的API 管理服务。 它使用此标识从 KeyVault 提取 SSL 证书，并通过每 4 小时检查一次来保持更新。 |
| 创建 Azure Stack HCI 23H2 群集 |
此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。 |
| 创建 Azure Key Vault 和机密 |
此模板创建 Azure 密钥保管库和机密。 |
| 使用 RBAC 和机密创建 Azure 密钥保管库 |
此模板创建 Azure 密钥保管库和机密。 它不依赖于访问策略，而是利用 Azure RBAC 来管理机密上的授权 |
| 通过专用终结点连接到密钥保管库 |
此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问密钥保管库。 |
| 创建 Key Vault 和机密列表 |
此模板在密钥保管库中创建与参数一起传递的密钥保管库和机密列表 |
| 创建存储在 Azure 密钥保管库中的Azure Maps SAS 令牌 |
此模板部署和Azure Maps帐户，并根据提供的要存储在 Azure 密钥保管库机密中的用户分配标识列出 Sas 令牌。 |
| 使用 密钥保管库 创建应用程序网关 V2 |
此模板在虚拟网络中部署应用程序网关 V2、用户定义的标识、密钥保管库、机密 (证书数据) ，以及密钥保管库和应用程序网关上的访问策略。 |
| Azure 防火墙 Premium 的测试环境 |
此模板创建具有高级功能的Azure 防火墙高级和防火墙策略，例如入侵检查 (IDPS) 、TLS 检查和 Web 类别筛选 |
| 在 KeyVault 中创建 ssh 密钥和存储 |
此模板使用 deploymentScript 资源生成 ssh 密钥，并将私钥存储在 keyVault 中。 |
| Azure 函数应用和 HTTP 触发的函数 |
此示例在模板中部署 Azure 函数应用和 HTTP 触发的函数。 它还部署密钥保管库并使用函数应用的主机密钥填充机密。 |
| 使用内部API 管理和 Web 应用应用程序网关 |
应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例，该实例为 Azure Web 应用中托管的 Web API 提供服务。 |
Terraform (AzAPI 提供程序) 资源定义
保管库/机密资源类型可以通过针对以下操作进行部署：
- 资源组
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.KeyVault/vaults/secrets 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/secrets@2023-07-01"
name = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
attributes = {
enabled = bool
exp = int
nbf = int
}
contentType = "string"
value = "string"
}
})
}
属性值
vaults/secrets
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.KeyVault/vaults/secrets@2023-07-01” |
| name | 资源名称 | 字符串 (必需) 字符限制：1-127 有效字符： 字母数字和连字符。 |
| parent_id | 此资源的父资源 ID。 | 类型为“保管库”的资源的 ID |
| 标记 | 将分配给机密的标记。 | 标记名称和值的字典。 |
| properties | 机密的属性 | SecretProperties (必需) |
SecretProperties
| 名称 | 说明 | 值 |
|---|---|---|
| attributes | 机密的属性。 | SecretAttributes |
| contentType | 机密的内容类型。 | string |
| value | 机密的值。 注意：永远不会从服务返回“value”，因为使用此模型的 API 用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密进行交互。 | 字符串 |
SecretAttributes
| 名称 | 说明 | 值 |
|---|---|---|
| enabled | 确定是否启用对象。 | bool |
| exp | 自 1970-01-01T00：00：00Z 以来的到期日期（以秒为单位）。 | int |
| nbf | 自 1970-01-01T00：00：00Z 以来，不早于日期（以秒为单位）。 | int |
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈