Microsoft.KeyVault 保存庫/秘密 2021-04-01-preview

言論

關於如何使用金鑰保險庫來取得安全值的指引,請參見 使用 Bicep。

關於建立祕密的快速入門,請參見 快速入門:使用 ARM 模板 設定並從 Azure Key Vault 取出祕密。

關於建立金鑰的快速入門,請參見 Quickstart: 使用 ARM 模板。

Bicep 資源定義

儲存庫/秘密資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

使用範例

Bicep 範例

部署 金鑰保存庫 Secrets 的基本範例。

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource vault 'Microsoft.KeyVault/vaults@2023-02-01' = {
  name: resourceName
  location: location
  properties: {
    sku: {
      family: 'A'
      name: 'standard'
    }
    accessPolicies: []
    enableSoftDelete: true
    tenantId: tenant().tenantId
  }
}

resource putSecret 'Microsoft.KeyVault/vaults/secrets@2023-02-01' = {
  name: resourceName
  parent: vault
  properties: {
    value: 'szechuan'
  }
}

Azure 已驗證的模組

以下的 Azure 已驗證模組 可用於部署此資源類型。

模組 描述
金鑰保存庫 - 秘密 金鑰保存庫 的 AVM 子模組 - 秘密

Azure 快速入門範例

以下的 Azure 快速啟動範本包含部署此資源類型的Bicep範例。

Bicep檔案 描述
Application Gateway 內建 API 管理與網頁應用程式 應用閘道將網際網路流量路由至虛擬網路(內部模式)API 管理實例,該實例服務於託管於 Azure 網頁應用程式中的網頁 API。
Azure函式應用程式及 HTTP 觸發函式 此範例在模板中內嵌部署 Azure 函式應用程式與 HTTP 觸發函式。 它也會部署 金鑰保存庫,並以函式應用程式的主機金鑰填充一個秘密。
建立一個金鑰保存庫和秘密清單 此範本建立一個啟用 RBAC 授權的 金鑰保存庫,並列出 key vault 內的秘密清單,並傳遞參數
從 KeyVault 建立 SSL 的 API 管理服務 此範本會部署使用使用者指派身分識別設定的 API 管理服務。 它會使用此身分識別從 KeyVault 擷取 SSL 憑證,並每隔 4 小時檢查一次來保持更新。
建立一個Azure Key Vault和一個秘密 此範本建立一個啟用 RBAC 授權並設定秘密的 Azure Key Vault。
FinOps 中樞 此範本建立了新的 FinOps 樞紐實例,包含 Data Explorer、資料湖 儲存與 Data Factory。
Azure 防火牆 Premium 此範本建立 Azure 防火牆 Premium 與防火牆政策,具備入侵檢查偵測(IDPS)、TLS 檢查及網頁分類過濾等高級功能

資源格式

要建立 Microsoft.KeyVault/vaults/secrets 資源,請將以下 Bicep 加入範本。

resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2021-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    contentType: 'string'
    value: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

Microsoft.KeyVault/保管庫/機密

名字 描述 價值
名字 資源名稱 字串

約束:
模式 = ^[a-zA-Z0-9-]{1,127}$ (必要)
父代 在 Bicep 中,你可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。

如需詳細資訊,請參閱 父資源外部的子資源。
類型資源的符號名稱:保存庫
性能 秘密的屬性 SecretProperties (必要)
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

SecretAttributes

名字 描述 價值
啟用 判斷物件是否已啟用。 布爾 (bool)
exp (英文) 自 1970-01-01T00:00:00Z 起的秒數到期日期。 整數 (int)
NBF 不是自 1970-01-01T00:00:00Z 起的秒數。 整數 (int)

SecretCreateOrUpdateParameters標籤

名字 描述 價值

SecretProperties

名字 描述 價值
屬性 秘密的屬性。 SecretAttributes
內容類型 秘密的內容類型。 字串
價值 秘密的值。 注意: 'value' 永遠不會從服務傳回,因為使用此模型的 API 是供 ARM 部署內部使用。 用戶應該使用數據平面 REST 服務來與保存庫秘密互動。 字串

ARM 樣本資源定義

儲存庫/秘密資源類型可以使用目標作業來部署:

使用範例

Azure Quickstart templates

以下的 Azure 快速起始範本部署此資源類型。

範本 描述
Application Gateway 內建 API 管理與網頁應用程式

部署至Azure
應用閘道將網際網路流量路由至虛擬網路(內部模式)API 管理實例,該實例服務於託管於 Azure 網頁應用程式中的網頁 API。
Azure函式應用程式及 HTTP 觸發函式

部署至Azure
此範例在模板中內嵌部署 Azure 函式應用程式與 HTTP 觸發函式。 它也會部署 金鑰保存庫,並以函式應用程式的主機金鑰填充一個秘密。
透過私有端點

部署至Azure
這個範例展示了如何透過配置虛擬網路和私人 DNS 區域,透過私人端點存取 金鑰保存庫。
建立一個金鑰保存庫和秘密清單

部署至Azure
此範本建立一個啟用 RBAC 授權的 金鑰保存庫,並列出 key vault 內的秘密清單,並傳遞參數
從 KeyVault 建立 SSL 的 API 管理服務

部署至Azure
此範本會部署使用使用者指派身分識別設定的 API 管理服務。 它會使用此身分識別從 KeyVault 擷取 SSL 憑證,並每隔 4 小時檢查一次來保持更新。
建立一個包含 金鑰保存庫

部署至Azure
此範本在 虛擬網路 部署應用閘道 V2、使用者定義的身份、金鑰保存庫、一個秘密(憑證資料)以及 金鑰保存庫 與應用閘道上的存取政策。
建立一個Azure Key Vault和一個秘密

部署至Azure
此範本建立一個啟用 RBAC 授權並設定秘密的 Azure Key Vault。
建立儲存在 Azure Key Vault

部署至Azure
此範本部署 Azure 地圖服務 帳號,並根據提供的使用者指派身份列出一個 Sas 令牌,儲存在 Azure Key Vault 秘密中。
建立 ssh 金鑰並儲存在 KeyVault

部署至Azure
此範本會使用 deploymentScript 資源來產生 ssh 金鑰,並將私鑰儲存在 keyVault 中。
FinOps 中樞

部署至Azure
此範本建立了新的 FinOps 樞紐實例,包含 Data Explorer、資料湖 儲存與 Data Factory。
Azure 防火牆 Premium

部署至Azure
此範本建立 Azure 防火牆 Premium 與防火牆政策,具備入侵檢查偵測(IDPS)、TLS 檢查及網頁分類過濾等高級功能

資源格式

若要建立 Microsoft.KeyVault/vaults/secrets 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.KeyVault/vaults/secrets",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "contentType": "string",
    "value": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

Microsoft.KeyVault/保管庫/機密

名字 描述 價值
apiVersion API 版本 “2021-04-01-預覽”
名字 資源名稱 字串

約束:
模式 = ^[a-zA-Z0-9-]{1,127}$ (必要)
性能 秘密的屬性 SecretProperties (必要)
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
型別 資源類型 “Microsoft.KeyVault/保管庫/機密”

SecretAttributes

名字 描述 價值
啟用 判斷物件是否已啟用。 布爾 (bool)
exp (英文) 自 1970-01-01T00:00:00Z 起的秒數到期日期。 整數 (int)
NBF 不是自 1970-01-01T00:00:00Z 起的秒數。 整數 (int)

SecretCreateOrUpdateParameters標籤

名字 描述 價值

SecretProperties

名字 描述 價值
屬性 秘密的屬性。 SecretAttributes
內容類型 秘密的內容類型。 字串
價值 秘密的值。 注意: 'value' 永遠不會從服務傳回,因為使用此模型的 API 是供 ARM 部署內部使用。 用戶應該使用數據平面 REST 服務來與保存庫秘密互動。 字串

Terraform (AzAPI 提供者) 資源定義

儲存庫/秘密資源類型可以使用目標作業來部署:

  • 資源團體 關於每個 API 版本變更屬性的清單,請參見 變更日誌。

使用範例

Terraform 範例

部署 金鑰保存庫 Secrets 的基本範例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

data "azurerm_client_config" "current" {
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "vault" {
  type      = "Microsoft.KeyVault/vaults@2023-02-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      sku = {
        family = "A"
        name   = "standard"
      }
      accessPolicies   = []
      enableSoftDelete = true
      tenantId         = data.azurerm_client_config.current.tenant_id
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.accessPolicies]
  }
}

data "azapi_resource_id" "secret" {
  type      = "Microsoft.KeyVault/vaults/secrets@2023-02-01"
  parent_id = azapi_resource.vault.id
  name      = var.resource_name
}

resource "azapi_resource_action" "put_secret" {
  type        = "Microsoft.KeyVault/vaults/secrets@2023-02-01"
  resource_id = data.azapi_resource_id.secret.id
  method      = "PUT"
  body = {
    properties = {
      value = "szechuan"
    }
  }
  response_export_values = ["*"]
}

資源格式

若要建立 Microsoft.KeyVault/vaults/secrets 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/secrets@2021-04-01-preview"
  name = "string"
  parent_id = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      attributes = {
        enabled = bool
        exp = int
        nbf = int
      }
      contentType = "string"
      value = "string"
    }
  }
}

屬性值

Microsoft.KeyVault/保管庫/機密

名字 描述 價值
名字 資源名稱 字串

約束:
模式 = ^[a-zA-Z0-9-]{1,127}$ (必要)
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼:保存庫
性能 秘密的屬性 SecretProperties (必要)
標籤 資源標籤 標記名稱和值的字典。
型別 資源類型 “Microsoft.KeyVault/vaults/secrets@2021-04-01-preview”

SecretAttributes

名字 描述 價值
啟用 判斷物件是否已啟用。 布爾 (bool)
exp (英文) 自 1970-01-01T00:00:00Z 起的秒數到期日期。 整數 (int)
NBF 不是自 1970-01-01T00:00:00Z 起的秒數。 整數 (int)

SecretCreateOrUpdateParameters標籤

名字 描述 價值

SecretProperties

名字 描述 價值
屬性 秘密的屬性。 SecretAttributes
內容類型 秘密的內容類型。 字串
價值 秘密的值。 注意: 'value' 永遠不會從服務傳回,因為使用此模型的 API 是供 ARM 部署內部使用。 用戶應該使用數據平面 REST 服務來與保存庫秘密互動。 字串