Microsoft.KeyVault コンテナー/キー 2022-02-01-preview

[アーティクル]
04/20/2024

Bicep リソース定義

コンテナー/キーリソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

注釈

セキュリティで保護された値にキーコンテナーを使用する方法については、「 Bicep を使用してシークレットを管理する」を参照してください。

シークレットの作成に関するクイックスタートについては、「クイックスタート: ARM テンプレートを使用して Azure Key Vaultからシークレットを設定して取得する」を参照してください。

キーの作成に関するクイックスタートについては、「クイックスタート: ARM テンプレートを使用して Azure キーコンテナーとキーを作成する」を参照してください。

リソース形式

Microsoft.KeyVault/vaults/keys リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2022-02-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'
          }
        }
      ]
    }
  }
}

プロパティ値

vaults/keys

名前	説明	値
name	リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。	string (必須)
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

名前	説明	値
enabled	オブジェクトが有効かどうかを判断します。	[bool]
exp	1970-01-01T00:00:00Z 以降の有効期限 (秒)。	INT
エクスポート	秘密キーをエクスポートできるかどうかを示します。	[bool]
nbf	1970-01-01T00:00:00Z 以降の日付 (秒単位)。	INT

KeyReleasePolicy

名前	説明	値
contentType	コンテンツタイプとキーリリースポリシーのバージョン	string
[データ]	キーを解放できるポリシー規則をエンコードする BLOB。	string

RotationPolicy

名前	説明	値
属性	キーローテーションポリシーの属性。	KeyRotationPolicyAttributes
lifetimeActions	キーローテーションアクションの lifetimeActions。	LifetimeAction[]

KeyRotationPolicyAttributes

名前	説明	値
expiryTime	新しいキーバージョンの有効期限。 ISO8601形式である必要があります。例: 'P90D'、'P1Y'。	string

LifetimeAction

名前	説明	値
action	キーローテーションポリシーの lifetimeAction のアクション。	操作
トリガー (trigger)	キーローテーションポリシーの lifetimeAction のトリガー。	トリガー

アクション

名前	説明	値
type	アクションの種類。値は大文字と小文字を区別せずに比較する必要があります。	'Notify' 'Rotate'

トリガー

名前	説明	値
timeAfterCreate	キーを回転させるキーの作成後の時間。回転にのみ適用されます。 ISO 8601 の期間形式になります。例: 'P90D'、'P1Y'。	string
timeBeforeExpiry	ローテーションまたは通知するキーの有効期限が切れるまでの期間。 ISO 8601 の期間形式になります。例: 'P90D'、'P1Y'。	string

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
Azure KeyVault でキーを作成する	このモジュールでは、既存の KeyVault にキーを作成できます。
カスタマーマネージドキーを使用した Azure Storage アカウントの暗号化	このテンプレートは、Key Vault内に生成および配置される暗号化用のカスタマーマネージドキーを持つストレージアカウントをデプロイします。

ARM テンプレートリソース定義

コンテナー/キーリソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

注釈

セキュリティで保護された値にキーコンテナーを使用する方法については、「 Bicep を使用してシークレットを管理する」を参照してください。

リソース形式

Microsoft.KeyVault/vaults/keys リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2022-02-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"
          }
        }
      ]
    }
  }
}

プロパティ値

vaults/keys

名前	説明	値
type	リソースの種類	'Microsoft.KeyVault/vaults/keys'
apiVersion	リソース API のバージョン	'2022-02-01-preview'
name	リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。	string (必須)
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

名前	説明	値
enabled	オブジェクトが有効かどうかを判断します。	[bool]
exp	1970-01-01T00:00:00Z 以降の有効期限 (秒単位)。	INT
エクスポート	秘密キーをエクスポートできるかどうかを示します。	[bool]
nbf	1970-01-01T00:00:00Z 以降の日付 (秒単位)。	INT

KeyReleasePolicy

名前	説明	値
contentType	コンテンツタイプとキーリリースポリシーのバージョン	string
[データ]	キーを解放できるポリシー規則をエンコードする BLOB。	string

RotationPolicy

名前	説明	値
属性	キーローテーションポリシーの属性。	KeyRotationPolicyAttributes
lifetimeActions	キーローテーションアクションの lifetimeActions。	LifetimeAction[]

KeyRotationPolicyAttributes

名前	説明	値
expiryTime	新しいキーバージョンの有効期限。 ISO8601形式である必要があります。例: 'P90D'、'P1Y'。	string

LifetimeAction

名前	説明	値
action	キーローテーションポリシーの lifetimeAction のアクション。	操作
トリガー (trigger)	キーローテーションポリシーの lifetimeAction のトリガー。	トリガー

アクション

名前	説明	値
type	アクションの種類。値は大文字と小文字を区別せずに比較する必要があります。	'Notify' 'Rotate'

トリガー

名前	説明	値
timeAfterCreate	キーを回転させるキーの作成後の時間。回転にのみ適用されます。 ISO 8601 の期間形式になります。例: 'P90D'、'P1Y'。	string
timeBeforeExpiry	ローテーションまたは通知するキーの有効期限が切れるまでの期間。 ISO 8601 の期間形式になります。例: 'P90D'、'P1Y'。	string

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
Azure KeyVault でキーを作成する	このモジュールでは、既存の KeyVault にキーを作成できます。
カスタマーマネージドキーを使用した Azure Storage アカウントの暗号化	このテンプレートは、Key Vault内に生成および配置される暗号化用のカスタマーマネージドキーを持つストレージアカウントをデプロイします。

Terraform (AzAPI プロバイダー) リソース定義

コンテナー/キーリソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループ

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.KeyVault/vaults/keys リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2022-02-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"
            }
          }
        ]
      }
    }
  })
}

プロパティ値

vaults/keys

名前	説明	値
type	リソースの種類	"Microsoft.KeyVault/vaults/keys@2022-02-01-preview"
name	リソース名	string (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの 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

名前	説明	値
enabled	オブジェクトが有効かどうかを判断します。	[bool]
exp	1970-01-01T00:00:00Z 以降の有効期限 (秒単位)。	INT
エクスポート	秘密キーをエクスポートできるかどうかを示します。	[bool]
nbf	1970-01-01T00:00:00Z 以降の日付 (秒単位)。	INT

KeyReleasePolicy

名前	説明	値
contentType	コンテンツタイプとキーリリースポリシーのバージョン	string
[データ]	キーを解放できるポリシー規則をエンコードする BLOB。	string

RotationPolicy

名前	説明	値
属性	キーローテーションポリシーの属性。	KeyRotationPolicyAttributes
lifetimeActions	キーローテーションアクションの lifetimeActions。	LifetimeAction[]

KeyRotationPolicyAttributes

名前	説明	値
expiryTime	新しいキーバージョンの有効期限。 ISO8601形式である必要があります。例: 'P90D'、'P1Y'。	string

LifetimeAction

名前	説明	値
action	キーローテーションポリシーの lifetimeAction のアクション。	操作
トリガー (trigger)	キーローテーションポリシー lifetimeAction のトリガー。	トリガー

アクション

名前	説明	値
type	アクションの種類。値は大文字と小文字を区別せずに比較する必要があります。	"通知" "回転"

トリガー

名前	説明	値
timeAfterCreate	キーを回転させるキーの作成後の時間。回転にのみ適用されます。 ISO 8601 の期間形式になります。例: 'P90D'、'P1Y'。	string
timeBeforeExpiry	ローテーションまたは通知するキーの有効期限が切れるまでの期間。 ISO 8601 の期間形式になります。例: 'P90D'、'P1Y'。	string

次の方法で共有

Microsoft.KeyVault コンテナー/キー 2022-02-01-preview

Bicep リソース定義

注釈

リソース形式

プロパティ値

vaults/keys

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

アクション

トリガー

クイック スタート テンプレート

ARM テンプレート リソース定義

注釈

リソース形式

プロパティ値

vaults/keys

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

アクション

トリガー

クイック スタート テンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソース形式

プロパティ値

vaults/keys

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

アクション

トリガー

フィードバック

その他のリソース

クイックスタートテンプレート

ARM テンプレートリソース定義

クイックスタートテンプレート