Microsoft.KeyVault vaults/keys 2021-11-01-preview

發行項
04/20/2024

Bicep 資源定義

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

資源群組 - 請參閱資源群組部署命令

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

備註

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

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

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

資源格式

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

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2021-11-01-preview' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    attributes: {
      enabled: bool
      exp: int
      exportable: bool
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
    release_policy: {
      contentType: 'string'
      data: 'string'
    }
    rotationPolicy: {
      attributes: {
        expiryTime: 'string'
      }
      lifetimeActions: [
        {
          action: {
            type: 'string'
          }
          trigger: {
            timeAfterCreate: 'string'
            timeBeforeExpiry: 'string'
          }
        }
      ]
    }
  }
}

屬性值

保存庫/金鑰

名稱	描述	值
NAME	資源名稱瞭解如何在 Bicep 中設定子資源的名稱和類型。	字串 (必要)
tags	將指派給索引鍵的標記。	標記名稱和值的字典。請參閱範本中的標記
父系 (parent)	在 Bicep 中，您可以指定子資源的父資源。只有在父資源之外宣告子資源時，才需要新增這個屬性。如需詳細資訊，請參閱父資源外部的子資源。	類型資源的符號名稱：保存庫
properties	要建立之索引鍵的屬性。	需要 KeyProperties ()

KeyProperties

名稱	描述	值
屬性	索引鍵的屬性。	KeyAttributes
curveName	橢圓曲線名稱。如需有效值，請參閱 JsonWebKeyCurveName。	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		包含任何項目的字串數組： 'decrypt' 'encrypt' 'import' 'release' 'sign' 'unwrapKey' 'verify' 'wrapKey'
keySize	金鑰的大小 (以位元為單位)。例如：RSA 的 2048、3072 或 4096。	int
kty	索引鍵的類型。如需有效值，請參閱 JsonWebKeyType。	'EC' 'EC-HSM' 'RSA' 'RSA-HSM'
release_policy	回應中的金鑰發行原則。它將會用於輸出和輸入。如果空白，則省略	KeyReleasePolicy
rotationPolicy	回應中的金鑰輪替原則。它將會用於輸出和輸入。如果空白，則省略	RotationPolicy

KeyAttributes

名稱	描述	值
已啟用	判斷是否啟用物件。	bool
exp	自 1970-01-01T00：00：00Z 起的秒數到期日。	int
出口	指出是否可以匯出私鑰。	bool
nbf	自 1970-01-01T00：00：00Z 以來的日期不是在秒內。	int

KeyReleasePolicy

名稱	描述	值
ContentType	金鑰發行原則的內容類型和版本	字串
資料	Blob 編碼可釋放密鑰的原則規則。	字串

RotationPolicy

名稱	描述	值
屬性	密鑰輪替原則的屬性。	KeyRotationPolicyAttributes
lifetimeActions	密鑰輪替動作的 lifetimeActions。	LifetimeAction[]

KeyRotationPolicyAttributes

名稱	描述	值
expiryTime	新金鑰版本的到期時間。其格式應為 ISO8601。例如：『P90D』、『P1Y』。	字串

LifetimeAction

名稱	描述	值
動作	金鑰輪替原則存留期動作的動作。	動作
觸發程序 (trigger)	金鑰輪替原則存留期動作的觸發程式。	觸發程序

動作

名稱	描述	值
類型	動作的類型。此值應該不區分大小寫比較。	'Notify' 'Rotate'

觸發程序

名稱	描述	值
timeAfterCreate	金鑰建立後要輪替金鑰的時間持續時間。它只適用於旋轉。其格式為 ISO 8601。例如：『P90D』、『P1Y』。	字串
timeBeforeExpiry	密鑰到期前的時間持續時間，以輪替或通知。其格式為 ISO 8601。例如：『P90D』、『P1Y』。	字串

快速入門範本

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

範本	描述
在 Azure KeyVault 中建立金鑰	此課程模組可讓您在現有的 KeyVault 中建立金鑰。
使用客戶管理的金鑰進行 Azure 記憶體帳戶加密	此範本會部署具有客戶管理密鑰的記憶體帳戶，以進行產生的加密，並放在金鑰保存庫內。

ARM 範本資源定義

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

資源群組 - 請參閱資源群組部署命令

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

備註

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

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

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

資源格式

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

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2021-11-01-preview",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "exportable": "bool",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string",
    "release_policy": {
      "contentType": "string",
      "data": "string"
    },
    "rotationPolicy": {
      "attributes": {
        "expiryTime": "string"
      },
      "lifetimeActions": [
        {
          "action": {
            "type": "string"
          },
          "trigger": {
            "timeAfterCreate": "string",
            "timeBeforeExpiry": "string"
          }
        }
      ]
    }
  }
}

屬性值

保存庫/金鑰

名稱	描述	值
類型	資源類型	'Microsoft.KeyVault/vaults/keys'
apiVersion	資源 API 版本	'2021-11-01-preview'
NAME	資源名稱請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。	字串 (必要)
tags	將指派給索引鍵的標記。	標記名稱和值的字典。請參閱範本中的標記
properties	要建立之索引鍵的屬性。	需要 KeyProperties ()

KeyProperties

名稱	描述	值
屬性	索引鍵的屬性。	KeyAttributes
curveName	橢圓曲線名稱。如需有效值，請參閱 JsonWebKeyCurveName。	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		包含任何項目的字串數組： 'decrypt' 'encrypt' 'import' 'release' 'sign' 'unwrapKey' 'verify' 'wrapKey'
keySize	金鑰的大小 (以位元為單位)。例如：RSA 的 2048、3072 或 4096。	int
kty	索引鍵的類型。如需有效值，請參閱 JsonWebKeyType。	'EC' 'EC-HSM' 'RSA' 'RSA-HSM'
release_policy	回應中的金鑰發行原則。它將會用於輸出和輸入。如果空白，則省略	KeyReleasePolicy
rotationPolicy	回應中的金鑰輪替原則。它將會用於輸出和輸入。如果空白，則省略	RotationPolicy

KeyAttributes

名稱	描述	值
已啟用	判斷是否啟用物件。	bool
exp	自 1970-01-01T00：00：00Z 起的秒數到期日。	int
出口	指出是否可以匯出私鑰。	bool
nbf	自 1970-01-01T00：00：00Z 以來的日期不是在秒內。	int

KeyReleasePolicy

名稱	描述	值
ContentType	金鑰發行原則的內容類型和版本	字串
資料	Blob 編碼可釋放密鑰的原則規則。	字串

RotationPolicy

名稱	描述	值
屬性	密鑰輪替原則的屬性。	KeyRotationPolicyAttributes
lifetimeActions	密鑰輪替動作的 lifetimeActions。	LifetimeAction[]

KeyRotationPolicyAttributes

名稱	描述	值
expiryTime	新金鑰版本的到期時間。其格式應為 ISO8601。例如：『P90D』、『P1Y』。	字串

LifetimeAction

名稱	描述	值
動作	密鑰輪替原則 lifetimeAction 的動作。	動作
觸發程序 (trigger)	密鑰輪替原則 lifetimeAction 的觸發程式。	觸發程序

動作

名稱	描述	值
類型	動作的類型。此值應該不區分大小寫地進行比較。	'Notify' 'Rotate'

觸發程序

名稱	描述	值
timeAfterCreate	金鑰建立後要輪替金鑰的時間持續時間。它只適用於旋轉。其格式為 ISO 8601。例如：『P90D』、『P1Y』。	字串
timeBeforeExpiry	密鑰到期前的時間持續時間，要輪替或通知。其格式為 ISO 8601。例如：『P90D』、『P1Y』。	字串

快速入門範本

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

範本	描述
在 Azure KeyVault 中建立金鑰	此課程模組可讓您在現有的 KeyVault 中建立金鑰。
使用客戶管理的金鑰進行 Azure 記憶體帳戶加密	此範本會使用客戶管理的密鑰來部署記憶體帳戶，以進行產生的加密，並將其放在金鑰保存庫內。

Terraform (AzAPI 提供者) 資源定義

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

資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2021-11-01-preview"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        exportable = bool
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
      release_policy = {
        contentType = "string"
        data = "string"
      }
      rotationPolicy = {
        attributes = {
          expiryTime = "string"
        }
        lifetimeActions = [
          {
            action = {
              type = "string"
            }
            trigger = {
              timeAfterCreate = "string"
              timeBeforeExpiry = "string"
            }
          }
        ]
      }
    }
  })
}

屬性值

保存庫/金鑰

名稱	描述	值
類型	資源類型	“Microsoft.KeyVault/vaults/keys@2021-11-01-preview”
NAME	資源名稱	需要字串 ()
parent_id	此資源父系之資源的標識碼。	類型資源的識別碼：保存庫
tags	將指派給金鑰的標記。	標記名稱和值的字典。
properties	要建立之索引鍵的屬性。	需要 KeyProperties ()

KeyProperties

名稱	描述	值
屬性	索引鍵的屬性。	KeyAttributes
curveName	橢圓曲線名稱。如需有效值，請參閱 JsonWebKeyCurveName。	“P-256” “P-256K” “P-384” “P-521”
keyOps		包含任何項目的字串數組： “decrypt” “encrypt” “import” “release” “sign” “unwrapKey” “verify” “wrapKey”
keySize	金鑰的大小 (以位元為單位)。例如：RSA 2048、3072 或 4096。	int
kty	索引鍵的類型。如需有效值，請參閱 JsonWebKeyType。	“EC” “EC-HSM” “RSA” “RSA-HSM”
release_policy	回應中的金鑰發行原則。它將會用於輸出和輸入。如果空白，則省略	KeyReleasePolicy
rotationPolicy	回應中的金鑰輪替原則。它將會用於輸出和輸入。如果空白，則省略	RotationPolicy

KeyAttributes

名稱	描述	值
已啟用	判斷是否啟用物件。	bool
exp	自 1970-01-01T00：00：00Z 起的秒數到期日。	int
出口	指出是否可以匯出私鑰。	bool
nbf	自 1970-01-01T00：00：00Z 以來的日期不是在秒內。	int

KeyReleasePolicy

名稱	描述	值
ContentType	金鑰發行原則的內容類型和版本	字串
資料	Blob 編碼可釋放密鑰的原則規則。	字串

RotationPolicy

名稱	描述	值
屬性	密鑰輪替原則的屬性。	KeyRotationPolicyAttributes
lifetimeActions	密鑰輪替動作的 lifetimeActions。	LifetimeAction[]

KeyRotationPolicyAttributes

名稱	描述	值
expiryTime	新金鑰版本的到期時間。其格式應為 ISO8601。例如：『P90D』、『P1Y』。	字串

LifetimeAction

名稱	描述	值
動作	金鑰輪替原則存留期動作的動作。	動作
觸發程序 (trigger)	金鑰輪替原則存留期動作的觸發程式。	觸發程序

動作

名稱	描述	值
類型	動作的類型。此值應該不區分大小寫比較。	“Notify” “Rotate”

觸發程序

名稱	描述	值
timeAfterCreate	金鑰建立後要輪替金鑰的時間持續時間。它只適用於旋轉。其格式為 ISO 8601。例如：『P90D』、『P1Y』。	字串
timeBeforeExpiry	密鑰到期前的時間持續時間，以輪替或通知。其格式為 ISO 8601。例如：『P90D』、『P1Y』。	字串

共用方式為

Microsoft.KeyVault vaults/keys 2021-11-01-preview

Bicep 資源定義

備註

資源格式

屬性值

保存庫/金鑰

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

動作

觸發程序

快速入門範本

ARM 範本資源定義

備註

資源格式

屬性值

保存庫/金鑰

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

動作

觸發程序

快速入門範本

Terraform (AzAPI 提供者) 資源定義

資源格式

屬性值

保存庫/金鑰

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

動作

觸發程序

意見反應

其他資源