共用方式為

Microsoft.KeyVault 保存庫/金鑰 2019-09-01

  • 發行項

言論

如需針對安全值使用密鑰保存庫的指引，請參閱 使用 Bicep管理秘密。

如需建立秘密的快速入門，請參閱 快速入門：使用ARM樣本從 Azure Key Vault 設定和擷取秘密。

如需建立金鑰的快速入門，請參閱 快速入門：使用 ARM 範本建立 Azure 金鑰保存庫和金鑰。

Bicep 資源定義

儲存庫/金鑰資源類型可以使用目標作業來部署：

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

資源格式

若要建立 Microsoft.KeyVault/vaults/keys 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2019-09-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

KeyAttributes

名字 描述 價值
啟用 判斷是否啟用物件。 bool
exp 自 1970-01-01T00：00：00Z 起的秒數到期日期。 int
nbf 不是自 1970-01-01T00：00：00Z 起的秒數。 int

KeyCreateParametersTags

名字 描述 價值

KeyProperties

名字 描述 價值
屬性 索引鍵的屬性。 KeyAttributes
curveName 橢圓曲線名稱。 如需有效值，請參閱 JsonWebKeyCurveName。 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps 包含任何的字串數組：
'decrypt'
'encrypt'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize 位中的金鑰大小。 例如：RSA 的 2048、3072 或 4096。 int
kty 索引鍵的類型。 如需有效值，請參閱 JsonWebKeyType。 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'

Microsoft.KeyVault/vaults/keys

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

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

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱：保存庫
性能 要建立之索引鍵的屬性。 KeyProperties （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案 描述
使用客戶管理的金鑰 Azure 記憶體帳戶加密 此範本會部署具有客戶自控密鑰的記憶體帳戶，以用於產生並放置在 Key Vault 內的加密。

ARM 樣本資源定義

儲存庫/金鑰資源類型可以使用目標作業來部署：

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

資源格式

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

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2019-09-01",
  "name": "string",
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

KeyAttributes

名字 描述 價值
啟用 判斷是否啟用物件。 bool
exp 自 1970-01-01T00：00：00Z 起的秒數到期日期。 int
nbf 不是自 1970-01-01T00：00：00Z 起的秒數。 int

KeyCreateParametersTags

名字 描述 價值

KeyProperties

名字 描述 價值
屬性 索引鍵的屬性。 KeyAttributes
curveName 橢圓曲線名稱。 如需有效值，請參閱 JsonWebKeyCurveName。 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps 包含任何的字串數組：
'decrypt'
'encrypt'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize 位中的金鑰大小。 例如：RSA 的 2048、3072 或 4096。 int
kty 索引鍵的類型。 如需有效值，請參閱 JsonWebKeyType。 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'

Microsoft.KeyVault/vaults/keys

名字 描述 價值
apiVersion API 版本 '2019-09-01'
名字 資源名稱 字串

約束：
模式 = ^[a-zA-Z0-9-]{1,127}$ （必要）
性能 要建立之索引鍵的屬性。 KeyProperties （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.KeyVault/vaults/keys'

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用客戶管理的金鑰 Azure 記憶體帳戶加密

部署至 Azure 		此範本會部署具有客戶自控密鑰的記憶體帳戶，以用於產生並放置在 Key Vault 內的加密。
在 Azure KeyVault 中建立密鑰

部署至 Azure 		本課程模組可讓您在現有的 KeyVault 中建立金鑰。

Terraform （AzAPI 提供者） 資源定義

儲存庫/金鑰資源類型可以使用目標作業來部署：

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2019-09-01"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
    }
  })
}

屬性值

KeyAttributes

名字 描述 價值
啟用 判斷是否啟用物件。 bool
exp 自 1970-01-01T00：00：00Z 起的秒數到期日期。 int
nbf 不是自 1970-01-01T00：00：00Z 起的秒數。 int

KeyCreateParametersTags

名字 描述 價值

KeyProperties

名字 描述 價值
屬性 索引鍵的屬性。 KeyAttributes
curveName 橢圓曲線名稱。 如需有效值，請參閱 JsonWebKeyCurveName。 'P-256'
'P-256K'
'P-384'
'P-521'
keyOps 包含任何的字串數組：
'decrypt'
'encrypt'
'import'
'sign'
'unwrapKey'
'verify'
'wrapKey'
keySize 位中的金鑰大小。 例如：RSA 的 2048、3072 或 4096。 int
kty 索引鍵的類型。 如需有效值，請參閱 JsonWebKeyType。 'EC'
'EC-HSM'
'RSA'
'RSA-HSM'

Microsoft.KeyVault/vaults/keys

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

約束：
模式 = ^[a-zA-Z0-9-]{1,127}$ （必要）
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼：保存庫
性能 要建立之索引鍵的屬性。 KeyProperties （必要）
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.KeyVault/vaults/keys@2019-09-01”