Microsoft.KeyVault コンテナー/キー
Bicep リソース定義
コンテナー/キー リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
注釈
セキュリティで保護された値にキー コンテナーを使用する方法については、「 Bicep を使用してシークレットを管理する」を参照してください。
シークレットの作成に関するクイックスタートについては、「クイックスタート: ARM テンプレートを使用して Azure Key Vaultからシークレットを設定して取得する」を参照してください。
キーの作成に関するクイックスタートについては、「 クイックスタート: ARM テンプレートを使用して Azure キー コンテナーとキーを作成する」を参照してください。
リソース形式
Microsoft.KeyVault/vaults/keys リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.KeyVault/vaults/keys@2023-07-01' = {
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 を使用してシークレットを管理する」を参照してください。
シークレットの作成に関するクイックスタートについては、「クイックスタート: ARM テンプレートを使用して Azure Key Vaultからシークレットを設定および取得する」を参照してください。
キーの作成に関するクイックスタートについては、「 クイックスタート: ARM テンプレートを使用して Azure キー コンテナーとキーを作成する」を参照してください。
リソース形式
Microsoft.KeyVault/vaults/keys リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.KeyVault/vaults/keys",
"apiVersion": "2023-07-01",
"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 のバージョン | '2023-07-01' |
| 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@2023-07-01"
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@2023-07-01" |
| 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 | アクションの種類。 | "notify" "回転" |
トリガー
| 名前 | 説明 | 値 |
|---|---|---|
| timeAfterCreate | キーを回転させるキーの作成後の時間。 回転にのみ適用されます。 ISO 8601 の期間形式になります。 例: 'P90D'、'P1Y'。 | string |
| timeBeforeExpiry | ローテーションまたは通知するキーの有効期限が切れるまでの期間。 ISO 8601 の期間形式になります。 例: 'P90D'、'P1Y'。 | string |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示