Microsoft.DocumentDB-DatenbankAccounts/sqlDatabases/clientEncryptionKeys 2023-03-15
Bicep-Ressourcendefinition
Der Ressourcentyp databaseAccounts/sqlDatabases/clientEncryptionKeys kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-15' = {
name: 'string'
parent: resourceSymbolicName
properties: {
resource: {
encryptionAlgorithm: 'string'
id: 'string'
keyWrapMetadata: {
algorithm: 'string'
name: 'string'
type: 'string'
value: 'string'
}
wrappedDataEncryptionKey: any()
}
}
}
Eigenschaftswerte
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen. |
Zeichenfolge (erforderlich) |
| parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ: sqlDatabases |
| properties | Eigenschaften zum Erstellen und Aktualisieren von ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (erforderlich) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| resource | Das JSON-Standardformat eines ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (erforderlich) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| encryptionAlgorithm | Verschlüsselungsalgorithmus, der zusammen mit diesem Clientverschlüsselungsschlüssel zum Verschlüsseln/Entschlüsseln von Daten verwendet wird. | Zeichenfolge |
| id | Name des ClientEncryptionKey | Zeichenfolge |
| keyWrapMetadata | Metadaten für den Umbruchanbieter, die zum Entpacken des umschlossenen Clientverschlüsselungsschlüssels verwendet werden können. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Umschlossene (verschlüsselte) Form des Schlüssels, der als Bytearray dargestellt wird. | Für Bicep können Sie die Funktion any() verwenden. |
KeyWrapMetadata
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Algorithmus | Algorithmus, der beim Umschließen und Entpacken des Datenverschlüsselungsschlüssels verwendet wird. | Zeichenfolge |
| name | Der Name des zugeordneten KeyEncryptionKey (auch als CustomerManagedKey bezeichnet). | Zeichenfolge |
| type | ProviderName von KeyStoreProvider. | Zeichenfolge |
| value | Referenz/Link zum KeyEncryptionKey. | Zeichenfolge |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp databaseAccounts/sqlDatabases/clientEncryptionKeys kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
"apiVersion": "2023-03-15",
"name": "string",
"properties": {
"resource": {
"encryptionAlgorithm": "string",
"id": "string",
"keyWrapMetadata": {
"algorithm": "string",
"name": "string",
"type": "string",
"value": "string"
},
"wrappedDataEncryptionKey": {}
}
}
}
Eigenschaftswerte
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys" |
| apiVersion | Die Version der Ressourcen-API | '2023-03-15' |
| name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen. |
Zeichenfolge (erforderlich) |
| properties | Eigenschaften zum Erstellen und Aktualisieren von ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (erforderlich) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| resource | Das JSON-Standardformat eines ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (erforderlich) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| encryptionAlgorithm | Verschlüsselungsalgorithmus, der zusammen mit diesem Clientverschlüsselungsschlüssel verwendet wird, um Daten zu verschlüsseln/zu entschlüsseln. | Zeichenfolge |
| id | Name des ClientEncryptionKey | Zeichenfolge |
| keyWrapMetadata | Metadaten für den Wrappinganbieter, die zum Entpacken des umschlossenen Clientverschlüsselungsschlüssels verwendet werden können. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Umschlossene (verschlüsselte) Form des Schlüssels, der als Bytearray dargestellt wird. |
KeyWrapMetadata
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Algorithmus | Algorithmus, der beim Umschließen und Entpacken des Datenverschlüsselungsschlüssels verwendet wird. | Zeichenfolge |
| name | Der Name des zugeordneten KeyEncryptionKey (auch bekannt als CustomerManagedKey). | Zeichenfolge |
| type | ProviderName von KeyStoreProvider. | Zeichenfolge |
| value | Verweis/Link zum KeyEncryptionKey. | Zeichenfolge |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp databaseAccounts/sqlDatabases/clientEncryptionKeys kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-15"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
resource = {
encryptionAlgorithm = "string"
id = "string"
keyWrapMetadata = {
algorithm = "string"
name = "string"
type = "string"
value = "string"
}
}
}
})
}
Eigenschaftswerte
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-15" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource vom Typ: sqlDatabases |
| properties | Eigenschaften zum Erstellen und Aktualisieren von ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (erforderlich) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| resource | Das JSON-Standardformat eines ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (erforderlich) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| encryptionAlgorithm | Verschlüsselungsalgorithmus, der zusammen mit diesem Clientverschlüsselungsschlüssel verwendet wird, um Daten zu verschlüsseln/zu entschlüsseln. | Zeichenfolge |
| id | Name des ClientEncryptionKey | Zeichenfolge |
| keyWrapMetadata | Metadaten für den Wrappinganbieter, die zum Entpacken des umschlossenen Clientverschlüsselungsschlüssels verwendet werden können. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Umschlossene (verschlüsselte) Form des Schlüssels, der als Bytearray dargestellt wird. |
KeyWrapMetadata
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Algorithmus | Algorithmus, der beim Umschließen und Entpacken des Datenverschlüsselungsschlüssels verwendet wird. | Zeichenfolge |
| name | Der Name des zugeordneten KeyEncryptionKey (auch als CustomerManagedKey bezeichnet). | Zeichenfolge |
| type | ProviderName von KeyStoreProvider. | Zeichenfolge |
| value | Referenz/Link zum KeyEncryptionKey. | Zeichenfolge |