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

Microsoft.KeyVault 保管库/机密 2019-09-01

• 最新
• 2023-07-01
• 2023-02-01
• 2022-11-01
• 2022-07-01
• 2022-02-01-preview
• 2021-11-01-preview
• 2021-10-01
• 2021-06-01-preview
• 2021-04-01-preview
• 2020-04-01-preview
• 2019-09-01
• 2018-02-14
• 2018-02-14-preview
• 2016-10-01

Bicep 资源定义

可以使用目标操作部署保管库/机密资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

言论

有关使用密钥保管库获取安全值的指南，请参阅 使用 Bicep管理机密。

有关创建机密的快速入门，请参阅 快速入门：使用 ARM 模板设置和检索 Azure Key Vault 中的机密。

有关创建密钥的快速入门，请参阅 快速入门：使用 ARM 模板创建 Azure 密钥保管库和密钥。

资源格式

若要创建 Microsoft.KeyVault/vaults/secrets 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2019-09-01' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    contentType: 'string'
    value: 'string'
  }
}

属性值

vaults/secrets

名字	描述	价值
名字	资源名称 了解如何在 Bicep中设置子资源的名称和类型。	string （必需） 字符限制：1-127 有效字符： 字母数字和连字符。
标签	将分配给机密的标记。	标记名称和值的字典。 请参阅模板 中的 标记
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：保管库
性能	机密的属性	SecretProperties（必需）

SecretProperties

名字	描述	价值
属性	机密的属性。	SecretAttributes
contentType	机密的内容类型。	字符串
价值	机密的值。 注意：“value”永远不会从服务返回，因为使用此模型的 API 用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密交互。	字符串

SecretAttributes

名字	描述	价值
启用	确定是否启用对象。	bool
exp	自 1970-01-01T00：00：00Z 起的到期日期（以秒为单位）。	int
nbf	自 1970-01-01T00：00：00Z 以来的日期不早于秒。	int

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
从 KeyVault 使用 SSL 创建 API 管理服务	此模板部署配置有用户分配标识的 API 管理服务。 它使用此标识从 KeyVault 提取 SSL 证书，并通过每隔 4 小时检查一次来更新它。
创建 Azure Stack HCI 23H2 群集	此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。
创建 Azure Stack HCI 23H2 群集	此模板使用 ARM 模板（使用自定义存储 IP）创建 Azure Stack HCI 23H2 群集
在无交换机-双链路网络模式下创建 Azure Stack HCI 23H2 群集	此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。
在 Switchless-SingleLink 网络模式下创建 Azure Stack HCI 23H2 群集	此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。
创建 Azure Key Vault 和机密	此模板创建 Azure Key Vault 和机密。
使用 RBAC 和机密 创建 Azure Key Vault	此模板创建 Azure Key Vault 和机密。 它利用 Azure RBAC 管理对机密的授权，而不是依赖于访问策略
通过专用终结点连接到 Key Vault	此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问 Key Vault。
创建 Key Vault 和机密列表	此模板创建 Key Vault 和密钥保管库中的机密列表（随参数一起传递）
创建存储在 Azure Key Vault 中的 Azure Maps SAS 令牌	此模板部署和 Azure Maps 帐户，并根据提供的要存储在 Azure Key Vault 机密中的用户分配标识列出 Sas 令牌。
使用 Key Vault 创建应用程序网关 V2	此模板在虚拟网络、用户定义的标识、Key Vault、机密（证书数据）和 Key Vault 和应用程序网关上的访问策略中部署应用程序网关 V2。
Azure 防火墙高级版 的 测试环境	此模板创建具有高级功能（例如入侵检查检测（IDPS）、TLS 检查和 Web 类别筛选等高级功能的 Azure 防火墙高级和防火墙策略
创建 ssh 密钥并将其存储在 KeyVault	此模板使用 deploymentScript 资源生成 ssh 密钥，并将私钥存储在 keyVault 中。
Azure 函数应用和 HTTP 触发的函数	此示例在模板中部署 Azure 函数应用和 HTTP 触发的函数内联。 它还部署 Key Vault，并使用函数应用的主机密钥填充机密。
使用内部 API 管理和 Web 应用 应用程序网关	应用程序网关将 Internet 流量路由到虚拟网络（内部模式）API 管理实例，该实例服务 Azure Web 应用中托管的 Web API。

ARM 模板资源定义

可以使用目标操作部署保管库/机密资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

言论

有关使用密钥保管库获取安全值的指南，请参阅 使用 Bicep管理机密。

有关创建机密的快速入门，请参阅 快速入门：使用 ARM 模板设置和检索 Azure Key Vault 中的机密。

有关创建密钥的快速入门，请参阅 快速入门：使用 ARM 模板创建 Azure 密钥保管库和密钥。

资源格式

若要创建 Microsoft.KeyVault/vaults/secrets 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.KeyVault/vaults/secrets",
  "apiVersion": "2019-09-01",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "contentType": "string",
    "value": "string"
  }
}

属性值

vaults/secrets

名字	描述	价值
类型	资源类型	“Microsoft.KeyVault/vaults/secrets”
apiVersion	资源 API 版本	'2019-09-01'
名字	资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。	string （必需） 字符限制：1-127 有效字符： 字母数字和连字符。
标签	将分配给机密的标记。	标记名称和值的字典。 请参阅模板 中的 标记
性能	机密的属性	SecretProperties（必需）

SecretProperties

名字	描述	价值
属性	机密的属性。	SecretAttributes
contentType	机密的内容类型。	字符串
价值	机密的值。 注意：“value”永远不会从服务返回，因为使用此模型的 API 用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密交互。	字符串

SecretAttributes

名字	描述	价值
启用	确定是否启用对象。	bool
exp	自 1970-01-01T00：00：00Z 起的到期日期（以秒为单位）。	int
nbf	自 1970-01-01T00：00：00Z 以来的日期不早于秒。	int

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
从 KeyVault 使用 SSL 创建 API 管理服务	此模板部署配置有用户分配标识的 API 管理服务。 它使用此标识从 KeyVault 提取 SSL 证书，并通过每隔 4 小时检查一次来更新它。
创建 Azure Stack HCI 23H2 群集	此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。
创建 Azure Stack HCI 23H2 群集	此模板使用 ARM 模板（使用自定义存储 IP）创建 Azure Stack HCI 23H2 群集
在无交换机-双链路网络模式下创建 Azure Stack HCI 23H2 群集	此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。
在 Switchless-SingleLink 网络模式下创建 Azure Stack HCI 23H2 群集	此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。
创建 Azure Key Vault 和机密	此模板创建 Azure Key Vault 和机密。
使用 RBAC 和机密 创建 Azure Key Vault	此模板创建 Azure Key Vault 和机密。 它利用 Azure RBAC 管理对机密的授权，而不是依赖于访问策略
通过专用终结点连接到 Key Vault	此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问 Key Vault。
创建 Key Vault 和机密列表	此模板创建 Key Vault 和密钥保管库中的机密列表（随参数一起传递）
创建存储在 Azure Key Vault 中的 Azure Maps SAS 令牌	此模板部署和 Azure Maps 帐户，并根据提供的要存储在 Azure Key Vault 机密中的用户分配标识列出 Sas 令牌。
使用 Key Vault 创建应用程序网关 V2	此模板在虚拟网络、用户定义的标识、Key Vault、机密（证书数据）和 Key Vault 和应用程序网关上的访问策略中部署应用程序网关 V2。
Azure 防火墙高级版 的 测试环境	此模板创建具有高级功能（例如入侵检查检测（IDPS）、TLS 检查和 Web 类别筛选等高级功能的 Azure 防火墙高级和防火墙策略
创建 ssh 密钥并将其存储在 KeyVault	此模板使用 deploymentScript 资源生成 ssh 密钥，并将私钥存储在 keyVault 中。
Azure 函数应用和 HTTP 触发的函数	此示例在模板中部署 Azure 函数应用和 HTTP 触发的函数内联。 它还部署 Key Vault，并使用函数应用的主机密钥填充机密。
使用内部 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@2019-09-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

名字	描述	价值
类型	资源类型	“Microsoft.KeyVault/vaults/secrets@2019-09-01”
名字	资源名称	string （必需） 字符限制：1-127 有效字符： 字母数字和连字符。
parent_id	此资源的父资源的 ID。	类型资源的 ID：保管库
标签	将分配给机密的标记。	标记名称和值的字典。
性能	机密的属性	SecretProperties（必需）

SecretProperties

名字	描述	价值
属性	机密的属性。	SecretAttributes
contentType	机密的内容类型。	字符串
价值	机密的值。 注意：“value”永远不会从服务返回，因为使用此模型的 API 用于 ARM 部署的内部使用。 用户应使用数据平面 REST 服务与保管库机密交互。	字符串

SecretAttributes

名字	描述	价值
启用	确定是否启用对象。	bool
exp	自 1970-01-01T00：00：00Z 起的到期日期（以秒为单位）。	int
nbf	自 1970-01-01T00：00：00Z 以来的日期不早于秒。	int