Freigeben über

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2024-08-15

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp "databaseAccounts/sqlDatabases/clientEncryptionKeys" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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 die folgende Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-08-15' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any(Azure.Bicep.Types.Concrete.AnyType)
    }
  }
}

Eigenschaftswerte

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Name Beschreibung Wert
Ressource Das standardmäßige JSON-Format eines ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (erforderlich)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Name Beschreibung Wert
encryptionAlgorithm Verschlüsselungsalgorithmus, der zusammen mit diesem Clientverschlüsselungsschlüssel zum Verschlüsseln/Entschlüsseln von Daten verwendet wird. Schnur
id Name des ClientEncryptionKey Schnur
keyWrapMetadata Metadaten für den Umbruchanbieter, der zum Entpacken des umschlossenen Clientverschlüsselungsschlüssels verwendet werden kann. KeyWrapMetadata-
wrappedDataEncryptionKey Umschlossene (verschlüsselte) Form des Schlüssels, der als Bytearray dargestellt wird. jegliche

KeyWrapMetadata

Name Beschreibung Wert
Algorithmus Algorithmus, der beim Umbruch und Entschlüsseln des Datenverschlüsselungsschlüssels verwendet wird. Schnur
Name Der Name des zugeordneten KeyEncryptionKey (auch bekannt als CustomerManagedKey). Schnur
Art ProviderName von KeyStoreProvider. Schnur
Wert Verweisen / Verknüpfen mit dem KeyEncryptionKey. Schnur

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Elternteil 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 des Typs: databaseAccounts/sqlDatabases
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren von ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (erforderlich)

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "databaseAccounts/sqlDatabases/clientEncryptionKeys" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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": "2024-08-15",
  "name": "string",
  "properties": {
    "resource": {
      "encryptionAlgorithm": "string",
      "id": "string",
      "keyWrapMetadata": {
        "algorithm": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      },
      "wrappedDataEncryptionKey": {}
    }
  }
}

Eigenschaftswerte

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Name Beschreibung Wert
Ressource Das standardmäßige JSON-Format eines ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (erforderlich)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Name Beschreibung Wert
encryptionAlgorithm Verschlüsselungsalgorithmus, der zusammen mit diesem Clientverschlüsselungsschlüssel zum Verschlüsseln/Entschlüsseln von Daten verwendet wird. Schnur
id Name des ClientEncryptionKey Schnur
keyWrapMetadata Metadaten für den Umbruchanbieter, der zum Entpacken des umschlossenen Clientverschlüsselungsschlüssels verwendet werden kann. KeyWrapMetadata-
wrappedDataEncryptionKey Umschlossene (verschlüsselte) Form des Schlüssels, der als Bytearray dargestellt wird. jegliche

KeyWrapMetadata

Name Beschreibung Wert
Algorithmus Algorithmus, der beim Umbruch und Entschlüsseln des Datenverschlüsselungsschlüssels verwendet wird. Schnur
Name Der Name des zugeordneten KeyEncryptionKey (auch bekannt als CustomerManagedKey). Schnur
Art ProviderName von KeyStoreProvider. Schnur
Wert Verweisen / Verknüpfen mit dem KeyEncryptionKey. Schnur

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Name Beschreibung Wert
apiVersion Die API-Version '2024-08-15'
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren von ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (erforderlich)
Art Der Ressourcentyp 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'

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 unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-08-15"
  name = "string"
  body = jsonencode({
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
        wrappedDataEncryptionKey = ?
      }
    }
  })
}

Eigenschaftswerte

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Name Beschreibung Wert
Ressource Das standardmäßige JSON-Format eines ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (erforderlich)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Name Beschreibung Wert
encryptionAlgorithm Verschlüsselungsalgorithmus, der zusammen mit diesem Clientverschlüsselungsschlüssel zum Verschlüsseln/Entschlüsseln von Daten verwendet wird. Schnur
id Name des ClientEncryptionKey Schnur
keyWrapMetadata Metadaten für den Umbruchanbieter, der zum Entpacken des umschlossenen Clientverschlüsselungsschlüssels verwendet werden kann. KeyWrapMetadata-
wrappedDataEncryptionKey Umschlossene (verschlüsselte) Form des Schlüssels, der als Bytearray dargestellt wird. jegliche

KeyWrapMetadata

Name Beschreibung Wert
Algorithmus Algorithmus, der beim Umbruch und Entschlüsseln des Datenverschlüsselungsschlüssels verwendet wird. Schnur
Name Der Name des zugeordneten KeyEncryptionKey (auch bekannt als CustomerManagedKey). Schnur
Art ProviderName von KeyStoreProvider. Schnur
Wert Verweisen / Verknüpfen mit dem KeyEncryptionKey. Schnur

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: databaseAccounts/sqlDatabases
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren von ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (erforderlich)
Art Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-08-15"