Microsoft.KeyVault コンテナー/キー 2020-04-01-preview
Bicep リソース定義
コンテナー/キー リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
注釈
セキュリティで保護された値にキー コンテナーを使用する方法については、「 Bicep を使用してシークレットを管理する」を参照してください。
シークレットの作成に関するクイックスタートについては、「クイックスタート: ARM テンプレートを使用して Azure Key Vaultからシークレットを設定して取得する」を参照してください。
キーの作成に関するクイックスタートについては、「 クイックスタート: ARM テンプレートを使用して Azure キー コンテナーとキーを作成する」を参照してください。
リソース形式
Microsoft.KeyVault/vaults/keys リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.KeyVault/vaults/keys@2020-04-01-preview' = {
name: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
attributes: {
enabled: bool
exp: int
nbf: int
}
curveName: 'string'
keyOps: [
'string'
]
keySize: int
kty: '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' 'sign' 'unwrapKey' 'verify' 'wrapKey' |
|
| keySize | キー サイズ (ビット単位)。 たとえば、RSA の場合は 2048、3072、4096 などです。 | INT |
| kty | キーの型。 有効な値については、「JsonWebKeyType」を参照してください。 | 'EC' 'EC-HSM' 'RSA' 'RSA-HSM' |
KeyAttributes
| 名前 | 説明 | 値 |
|---|---|---|
| enabled | オブジェクトが有効かどうかを判断します。 | [bool] |
| exp | 1970-01-01T00:00:00Z 以降の有効期限 (秒)。 | INT |
| nbf | 1970-01-01T00:00:00Z 以降の日付 (秒単位)。 | INT |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| 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": "2020-04-01-preview",
"name": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"attributes": {
"enabled": "bool",
"exp": "int",
"nbf": "int"
},
"curveName": "string",
"keyOps": [ "string" ],
"keySize": "int",
"kty": "string"
}
}
プロパティ値
vaults/keys
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.KeyVault/vaults/keys' |
| apiVersion | リソース API のバージョン | '2020-04-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' 'sign' 'unwrapKey' 'verify' 'wrapKey' |
|
| keySize | キー サイズ (ビット単位)。 たとえば、RSA の場合は 2048、3072、4096 などです。 | INT |
| kty | キーの型。 有効な値については、「JsonWebKeyType」を参照してください。 | 'EC' 'EC-HSM' 'RSA' 'RSA-HSM' |
KeyAttributes
| 名前 | 説明 | 値 |
|---|---|---|
| enabled | オブジェクトが有効かどうかを判断します。 | [bool] |
| exp | 1970-01-01T00:00:00Z 以降の有効期限 (秒)。 | INT |
| nbf | 1970-01-01T00:00:00Z 以降の日付 (秒単位)。 | INT |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| 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@2020-04-01-preview"
name = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
attributes = {
enabled = bool
exp = int
nbf = int
}
curveName = "string"
keyOps = [
"string"
]
keySize = int
kty = "string"
}
})
}
プロパティ値
vaults/keys
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.KeyVault/vaults/keys@2020-04-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" "sign" "unwrapKey" "verify" "wrapKey" |
|
| keySize | キー サイズ (ビット単位)。 たとえば、RSA の場合は 2048、3072、4096 などです。 | INT |
| kty | キーの型。 有効な値については、「JsonWebKeyType」を参照してください。 | "EC" "EC-HSM" "RSA" "RSA-HSM" |
KeyAttributes
| 名前 | 説明 | 値 |
|---|---|---|
| enabled | オブジェクトが有効かどうかを判断します。 | [bool] |
| exp | 1970-01-01T00:00:00Z 以降の有効期限 (秒)。 | INT |
| nbf | 1970-01-01T00:00:00Z 以降の日付 (秒単位)。 | int |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示