Microsoft.KeyVault コンテナー/キー

[アーティクル]
12/21/2024

備考

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

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

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

Bicep リソース定義

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

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2024-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  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'
          }
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

アクション

名前	形容	価値
種類	アクションの種類。	'notify' 'rotate'

KeyAttributes

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

KeyCreateParametersTags

名前	形容	価値

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

KeyReleasePolicy

名前	形容	価値
contentType	キーリリースポリシーのコンテンツタイプとバージョン	糸
データ	キーを解放できるポリシールールをエンコードする BLOB。	糸

KeyRotationPolicyAttributes

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

LifetimeAction

名前	形容	価値
アクション	キーローテーションポリシーの lifetimeAction のアクション。	アクションの
トリガー	キーローテーションポリシーの lifetimeAction のトリガー。	トリガーの

Microsoft.KeyVault/vaults/keys

名前	形容	価値
名前	リソース名	糸制約：パターン = `^[a-zA-Z0-9-]{1,127}$` (必須)
親	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部子リソース」を参照してください。	種類のリソースのシンボリック名: コンテナー
プロパティ	作成するキーのプロパティ。	KeyProperties (必須)
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください

RotationPolicy

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

トリガー

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

クイックスタートのサンプル

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

Bicep ファイル	形容
カスタマーマネージドキーを使用して Azure Storage アカウント暗号化をする	このテンプレートは、Key Vault 内で生成および配置される暗号化用のカスタマーマネージドキーを持つストレージアカウントをデプロイします。

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

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

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2024-04-01-preview",
  "name": "string",
  "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"
          }
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

アクション

名前	形容	価値
種類	アクションの種類。	'notify' 'rotate'

KeyAttributes

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

KeyCreateParametersTags

名前	形容	価値

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

KeyReleasePolicy

名前	形容	価値
contentType	キーリリースポリシーのコンテンツタイプとバージョン	糸
データ	キーを解放できるポリシールールをエンコードする BLOB。	糸

KeyRotationPolicyAttributes

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

LifetimeAction

名前	形容	価値
アクション	キーローテーションポリシーの lifetimeAction のアクション。	アクションの
トリガー	キーローテーションポリシーの lifetimeAction のトリガー。	トリガーの

Microsoft.KeyVault/vaults/keys

名前	形容	価値
apiVersion	API のバージョン	'2024-04-01-preview'
名前	リソース名	糸制約：パターン = `^[a-zA-Z0-9-]{1,127}$` (必須)
プロパティ	作成するキーのプロパティ。	KeyProperties (必須)
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
種類	リソースの種類	'Microsoft.KeyVault/vaults/keys'

RotationPolicy

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

トリガー

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

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

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

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

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

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

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2024-04-01-preview"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  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"
            }
          }
        ]
      }
    }
  })
}

プロパティ値

アクション

名前	形容	価値
種類	アクションの種類。	'notify' 'rotate'

KeyAttributes

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

KeyCreateParametersTags

名前	形容	価値

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

KeyReleasePolicy

名前	形容	価値
contentType	キーリリースポリシーのコンテンツタイプとバージョン	糸
データ	キーを解放できるポリシールールをエンコードする BLOB。	糸

KeyRotationPolicyAttributes

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

LifetimeAction

名前	形容	価値
アクション	キーローテーションポリシーの lifetimeAction のアクション。	アクションの
トリガー	キーローテーションポリシーの lifetimeAction のトリガー。	トリガーの

Microsoft.KeyVault/vaults/keys

名前	形容	価値
名前	リソース名	糸制約：パターン = `^[a-zA-Z0-9-]{1,127}$` (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: コンテナー
プロパティ	作成するキーのプロパティ。	KeyProperties (必須)
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.KeyVault/vaults/keys@2024-04-01-preview"

RotationPolicy

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

トリガー

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

次の方法で共有

Microsoft.KeyVault コンテナー/キー

備考

Bicep リソース定義

リソースの形式

プロパティ値

アクション

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

トリガー

クイック スタートのサンプル

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

リソースの形式

プロパティ値

アクション

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

トリガー

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

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

リソースの形式

プロパティ値

アクション

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

トリガー

フィードバック

その他のリソース

クイックスタートのサンプル

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

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