Share via

Microsoft.DocumentDB-databaseAccounts/sqlDatabases/clientEncryptionKeys 2022-11-15-preview

  • Artikel

Bicep-resourcedefinitie

Het resourcetype databaseAccounts/sqlDatabases/clientEncryptionKeys kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2022-11-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any()
    }
  }
}

Eigenschapswaarden

databaseAccounts/sqlDatabases/clientEncryptionKeys

Naam Description Waarde
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep.		 tekenreeks (vereist)
Bovenliggende In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie Onderliggende resource buiten bovenliggende resource voor meer informatie.		 Symbolische naam voor resource van het type: sqlDatabases
properties Eigenschappen voor het maken en bijwerken van ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (vereist)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Naam Description Waarde
resource De standaard-JSON-indeling van een ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (vereist)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Naam Description Waarde
encryptionAlgorithm Versleutelingsalgoritmen die samen met deze clientversleutelingssleutel worden gebruikt voor het versleutelen/ontsleutelen van gegevens. tekenreeks
id Naam van de ClientEncryptionKey tekenreeks
keyWrapMetadata Metagegevens voor de wrapping-provider die kunnen worden gebruikt om de verpakte clientversleutelingssleutel uit te pakken. KeyWrapMetadata
wrappedDataEncryptionKey Verpakte (versleutelde) vorm van de sleutel die wordt weergegeven als een bytematrix. Voor Bicep kunt u de functie any() gebruiken.

KeyWrapMetadata

Naam Description Waarde
Algoritme Algoritme dat wordt gebruikt voor het verpakken en uitpakken van de gegevensversleutelingssleutel. tekenreeks
naam De naam van de gekoppelde KeyEncryptionKey (ook wel CustomerManagedKey genoemd). tekenreeks
type ProviderName van KeyStoreProvider. tekenreeks
waarde Verwijzing naar/koppeling naar de KeyEncryptionKey. tekenreeks

Resourcedefinitie van ARM-sjabloon

Het resourcetype databaseAccounts/sqlDatabases/clientEncryptionKeys kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
  "apiVersion": "2022-11-15-preview",
  "name": "string",
  "properties": {
    "resource": {
      "encryptionAlgorithm": "string",
      "id": "string",
      "keyWrapMetadata": {
        "algorithm": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      },
      "wrappedDataEncryptionKey": {}
    }
  }
}

Eigenschapswaarden

databaseAccounts/sqlDatabases/clientEncryptionKeys

Naam Description Waarde
type Het resourcetype 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'
apiVersion De resource-API-versie '2022-11-15-preview'
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen.		 tekenreeks (vereist)
properties Eigenschappen voor het maken en bijwerken van ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (vereist)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Naam Description Waarde
resource De standaard-JSON-indeling van een ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (vereist)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Naam Description Waarde
encryptionAlgorithm Versleutelingsalgoritmen die samen met deze clientversleutelingssleutel worden gebruikt voor het versleutelen/ontsleutelen van gegevens. tekenreeks
id Naam van de ClientEncryptionKey tekenreeks
keyWrapMetadata Metagegevens voor de wrapping-provider die kunnen worden gebruikt om de verpakte clientversleutelingssleutel uit te pakken. KeyWrapMetadata
wrappedDataEncryptionKey Verpakte (versleutelde) vorm van de sleutel die wordt weergegeven als een bytematrix.

KeyWrapMetadata

Naam Description Waarde
Algoritme Algoritme dat wordt gebruikt voor het verpakken en uitpakken van de gegevensversleutelingssleutel. tekenreeks
naam De naam van de gekoppelde KeyEncryptionKey (ook wel CustomerManagedKey genoemd). tekenreeks
type ProviderName van KeyStoreProvider. tekenreeks
waarde Verwijzing naar/koppeling naar de KeyEncryptionKey. tekenreeks

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype databaseAccounts/sqlDatabases/clientEncryptionKeys kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2022-11-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
      }
    }
  })
}

Eigenschapswaarden

databaseAccounts/sqlDatabases/clientEncryptionKeys

Naam Description Waarde
type Het resourcetype "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2022-11-15-preview"
naam De resourcenaam tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: sqlDatabases
properties Eigenschappen voor het maken en bijwerken van ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (vereist)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Naam Description Waarde
resource De standaard-JSON-indeling van een ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (vereist)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Naam Description Waarde
encryptionAlgorithm Versleutelingsalgoritmen die samen met deze clientversleutelingssleutel worden gebruikt voor het versleutelen/ontsleutelen van gegevens. tekenreeks
id Naam van de ClientEncryptionKey tekenreeks
keyWrapMetadata Metagegevens voor de wrapping-provider die kunnen worden gebruikt om de verpakte clientversleutelingssleutel uit te pakken. KeyWrapMetadata
wrappedDataEncryptionKey Verpakte (versleutelde) vorm van de sleutel die wordt weergegeven als een bytematrix.

KeyWrapMetadata

Naam Description Waarde
Algoritme Algoritme dat wordt gebruikt voor het verpakken en uitpakken van de gegevensversleutelingssleutel. tekenreeks
naam De naam van de gekoppelde KeyEncryptionKey (ook wel CustomerManagedKey genoemd). tekenreeks
type ProviderName van KeyStoreProvider. tekenreeks
waarde Verwijzing/koppeling naar de KeyEncryptionKey. tekenreeks