Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2024-05-15-preview
- Senaste
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15-preview
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15-preview
Bicep-resursdefinition
Resurstypen databaseAccounts/sqlDatabases/clientEncryptionKeys kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-05-15-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
resource: {
encryptionAlgorithm: 'string'
id: 'string'
keyWrapMetadata: {
algorithm: 'string'
name: 'string'
type: 'string'
value: 'string'
}
wrappedDataEncryptionKey: any()
}
}
}
Egenskapsvärden
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | Beskrivning | Värde |
|---|---|---|
| name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) |
| parent | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför överordnad resurs. |
Symboliskt namn för resurs av typen: sqlDatabases |
| properties | Egenskaper för att skapa och uppdatera ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (krävs) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | Beskrivning | Värde |
|---|---|---|
| resource | JSON-standardformatet för en ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (krävs) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Name | Beskrivning | Värde |
|---|---|---|
| encryptionAlgorithm | Krypteringsalgoritm som ska användas tillsammans med den här klientkrypteringsnyckeln för att kryptera/dekryptera data. | sträng |
| id | Namnet på ClientEncryptionKey | sträng |
| keyWrapMetadata | Metadata för omslutningsprovidern som kan användas för att packa upp den omslutna klientkrypteringsnyckeln. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Omsluten (krypterad) form av nyckeln som representeras som en bytematris. | För Bicep kan du använda funktionen any(). |
KeyWrapMetadata
| Name | Beskrivning | Värde |
|---|---|---|
| Algoritm | Algoritm som används för omslutning och avskrivning av datakrypteringsnyckeln. | sträng |
| name | Namnet på tillhörande KeyEncryptionKey (även kallat CustomerManagedKey). | sträng |
| typ | ProviderName för KeyStoreProvider. | sträng |
| värde | Referens/länk till KeyEncryptionKey. | sträng |
Resursdefinition för ARM-mall
Resurstypen databaseAccounts/sqlDatabases/clientEncryptionKeys kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
"apiVersion": "2024-05-15-preview",
"name": "string",
"properties": {
"resource": {
"encryptionAlgorithm": "string",
"id": "string",
"keyWrapMetadata": {
"algorithm": "string",
"name": "string",
"type": "string",
"value": "string"
},
"wrappedDataEncryptionKey": {}
}
}
}
Egenskapsvärden
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys" |
| apiVersion | Resurs-API-versionen | "2024-05-15-preview" |
| name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) |
| properties | Egenskaper för att skapa och uppdatera ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (krävs) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | Beskrivning | Värde |
|---|---|---|
| resource | JSON-standardformatet för en ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (krävs) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Name | Beskrivning | Värde |
|---|---|---|
| encryptionAlgorithm | Krypteringsalgoritm som ska användas tillsammans med den här klientkrypteringsnyckeln för att kryptera/dekryptera data. | sträng |
| id | Namnet på ClientEncryptionKey | sträng |
| keyWrapMetadata | Metadata för omslutningsprovidern som kan användas för att packa upp den omslutna klientkrypteringsnyckeln. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Omsluten (krypterad) form av nyckeln som representeras som en bytematris. |
KeyWrapMetadata
| Name | Beskrivning | Värde |
|---|---|---|
| Algoritm | Algoritm som används för omslutning och avskrivning av datakrypteringsnyckeln. | sträng |
| name | Namnet på tillhörande KeyEncryptionKey (även kallat CustomerManagedKey). | sträng |
| typ | ProviderName för KeyStoreProvider. | sträng |
| värde | Referens/länk till KeyEncryptionKey. | sträng |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen databaseAccounts/sqlDatabases/clientEncryptionKeys kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-05-15-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
resource = {
encryptionAlgorithm = "string"
id = "string"
keyWrapMetadata = {
algorithm = "string"
name = "string"
type = "string"
value = "string"
}
}
}
})
}
Egenskapsvärden
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-05-15-preview" |
| name | Resursnamnet | sträng (krävs) |
| parent_id | ID:t för resursen som är överordnad för den här resursen. | ID för resurs av typen: sqlDatabases |
| properties | Egenskaper för att skapa och uppdatera ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (krävs) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | Beskrivning | Värde |
|---|---|---|
| resource | JSON-standardformatet för en ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (krävs) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Name | Beskrivning | Värde |
|---|---|---|
| encryptionAlgorithm | Krypteringsalgoritm som ska användas tillsammans med den här klientkrypteringsnyckeln för att kryptera/dekryptera data. | sträng |
| id | Namnet på ClientEncryptionKey | sträng |
| keyWrapMetadata | Metadata för omslutningsprovidern som kan användas för att packa upp den omslutna klientkrypteringsnyckeln. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Omsluten (krypterad) form av nyckeln som representeras som en bytematris. |
KeyWrapMetadata
| Name | Beskrivning | Värde |
|---|---|---|
| Algoritm | Algoritm som används för omslutning och avskrivning av datakrypteringsnyckeln. | sträng |
| name | Namnet på tillhörande KeyEncryptionKey (även kallat CustomerManagedKey). | sträng |
| typ | ProviderName för KeyStoreProvider. | sträng |
| värde | Referens/länk till KeyEncryptionKey. | sträng |