Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2023-09-15
Bicep リソース定義
databaseAccounts/sqlDatabases/clientEncryptionKeys リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15' = {
name: 'string'
parent: resourceSymbolicName
properties: {
resource: {
encryptionAlgorithm: 'string'
id: 'string'
keyWrapMetadata: {
algorithm: 'string'
name: 'string'
type: 'string'
value: 'string'
}
wrappedDataEncryptionKey: any()
}
}
}
プロパティ値
databaseAccounts/sqlDatabases/clientEncryptionKeys
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
型のリソースのシンボル名: sqlDatabases |
| properties | ClientEncryptionKey を作成および更新するためのプロパティ。 | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (必須) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| 名前 | 説明 | 値 |
|---|---|---|
| resource | ClientEncryptionKey の標準 JSON 形式 | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (必須) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| 名前 | 説明 | 値 |
|---|---|---|
| encryptionAlgorithm | このクライアント暗号化キーと共に使用される暗号化アルゴリズムを使用して、データの暗号化と暗号化解除を行います。 | string |
| id | ClientEncryptionKey の名前 | string |
| keyWrapMetadata | ラップされたクライアント暗号化キーのラップ解除に使用できるラッピング プロバイダーのメタデータ。 | KeyWrapMetadata |
| wrappedDataEncryptionKey | バイト配列として表されるキーのラップ (暗号化) 形式。 | Bicep の場合は、 any() 関数を使用できます。 |
KeyWrapMetadata
| 名前 | 説明 | 値 |
|---|---|---|
| アルゴリズム | データ暗号化キーのラップとラップ解除に使用されるアルゴリズム。 | string |
| name | 関連付けられている KeyEncryptionKey の名前 (CustomerManagedKey とも呼ばれます)。 | string |
| type | KeyStoreProvider の ProviderName。 | string |
| value | KeyEncryptionKey への参照/リンク。 | string |
ARM テンプレート リソース定義
databaseAccounts/sqlDatabases/clientEncryptionKeys リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys リソースを作成するには、テンプレートに次の JSON を追加します。
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
"apiVersion": "2023-09-15",
"name": "string",
"properties": {
"resource": {
"encryptionAlgorithm": "string",
"id": "string",
"keyWrapMetadata": {
"algorithm": "string",
"name": "string",
"type": "string",
"value": "string"
},
"wrappedDataEncryptionKey": {}
}
}
}
プロパティ値
databaseAccounts/sqlDatabases/clientEncryptionKeys
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys' |
| apiVersion | リソース API のバージョン | '2023-09-15' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| properties | ClientEncryptionKey を作成および更新するためのプロパティ。 | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (必須) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| 名前 | 説明 | 値 |
|---|---|---|
| resource | ClientEncryptionKey の標準 JSON 形式 | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (必須) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| 名前 | 説明 | 値 |
|---|---|---|
| encryptionAlgorithm | このクライアント暗号化キーと共に使用される暗号化アルゴリズムを使用して、データの暗号化と暗号化解除を行います。 | string |
| id | ClientEncryptionKey の名前 | string |
| keyWrapMetadata | ラップされたクライアント暗号化キーのラップ解除に使用できるラッピング プロバイダーのメタデータ。 | KeyWrapMetadata |
| wrappedDataEncryptionKey | バイト配列として表されるキーのラップ (暗号化) 形式。 |
KeyWrapMetadata
| 名前 | 説明 | 値 |
|---|---|---|
| アルゴリズム | データ暗号化キーのラップとラップ解除に使用されるアルゴリズム。 | string |
| name | 関連付けられている KeyEncryptionKey の名前 (CustomerManagedKey とも呼ばれます)。 | string |
| type | KeyStoreProvider の ProviderName。 | string |
| value | KeyEncryptionKey への参照/リンク。 | string |
Terraform (AzAPI プロバイダー) リソース定義
databaseAccounts/sqlDatabases/clientEncryptionKeys リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
resource = {
encryptionAlgorithm = "string"
id = "string"
keyWrapMetadata = {
algorithm = "string"
name = "string"
type = "string"
value = "string"
}
}
}
})
}
プロパティ値
databaseAccounts/sqlDatabases/clientEncryptionKeys
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15" |
| name | リソース名 | string (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: sqlDatabases |
| properties | ClientEncryptionKey を作成および更新するためのプロパティ。 | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (必須) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| 名前 | 説明 | 値 |
|---|---|---|
| resource | ClientEncryptionKey の標準 JSON 形式 | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (必須) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| 名前 | 説明 | 値 |
|---|---|---|
| encryptionAlgorithm | このクライアント暗号化キーと共に使用される暗号化アルゴリズムを使用して、データの暗号化と暗号化解除を行います。 | string |
| id | ClientEncryptionKey の名前 | string |
| keyWrapMetadata | ラップされたクライアント暗号化キーのラップ解除に使用できるラッピング プロバイダーのメタデータ。 | KeyWrapMetadata |
| wrappedDataEncryptionKey | バイト配列として表されるキーのラップ (暗号化) 形式。 |
KeyWrapMetadata
| 名前 | 説明 | 値 |
|---|---|---|
| アルゴリズム | データ暗号化キーのラップとラップ解除に使用されるアルゴリズム。 | string |
| name | 関連付けられている KeyEncryptionKey の名前 (CustomerManagedKey とも呼ばれます)。 | string |
| type | KeyStoreProvider の ProviderName。 | string |
| value | KeyEncryptionKey への参照/リンク。 | string |