Delen via

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

  • Artikel

Bicep-resourcedefinitie

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

Zie logboek wijzigenvoor 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@2024-11-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)
    }
  }
}

Eigenschapswaarden

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Naam Beschrijving Waarde
hulpbron De standaard JSON-indeling van een ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (vereist)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Naam Beschrijving Waarde
encryptionAlgorithm Versleutelingsalgoritmen die samen met deze clientversleutelingssleutel worden gebruikt voor het versleutelen/ontsleutelen van gegevens. snaar
legitimatiebewijs Naam van de ClientEncryptionKey snaar
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. enig

KeyWrapMetadata

Naam Beschrijving Waarde
algoritme Algoritme dat wordt gebruikt bij het verpakken en uitpakken van de gegevensversleutelingssleutel. snaar
naam De naam van de bijbehorende KeyEncryptionKey (ook wel CustomerManagedKey genoemd). snaar
type ProviderNaam van KeyStoreProvider. snaar
waarde Verwijzing/koppeling naar de KeyEncryptionKey. snaar

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Naam Beschrijving Waarde
naam De resourcenaam tekenreeks (vereist)
ouder 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 de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: databaseAccounts/sqlDatabases
Eigenschappen Eigenschappen voor het maken en bijwerken van ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (vereist)

Resourcedefinitie van ARM-sjabloon

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

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

Eigenschapswaarden

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Naam Beschrijving Waarde
hulpbron De standaard JSON-indeling van een ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (vereist)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Naam Beschrijving Waarde
encryptionAlgorithm Versleutelingsalgoritmen die samen met deze clientversleutelingssleutel worden gebruikt voor het versleutelen/ontsleutelen van gegevens. snaar
legitimatiebewijs Naam van de ClientEncryptionKey snaar
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. enig

KeyWrapMetadata

Naam Beschrijving Waarde
algoritme Algoritme dat wordt gebruikt bij het verpakken en uitpakken van de gegevensversleutelingssleutel. snaar
naam De naam van de bijbehorende KeyEncryptionKey (ook wel CustomerManagedKey genoemd). snaar
type ProviderNaam van KeyStoreProvider. snaar
waarde Verwijzing/koppeling naar de KeyEncryptionKey. snaar

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Naam Beschrijving Waarde
apiVersion De API-versie '2024-11-15'
naam De resourcenaam tekenreeks (vereist)
Eigenschappen Eigenschappen voor het maken en bijwerken van ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (vereist)
type Het resourcetype 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'

Resourcedefinitie van Terraform (AzAPI-provider)

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

  • resourcegroepen

Zie logboek wijzigenvoor 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@2024-11-15"
  name = "string"
  body = jsonencode({
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
        wrappedDataEncryptionKey = ?
      }
    }
  })
}

Eigenschapswaarden

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Naam Beschrijving Waarde
hulpbron De standaard JSON-indeling van een ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (vereist)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Naam Beschrijving Waarde
encryptionAlgorithm Versleutelingsalgoritmen die samen met deze clientversleutelingssleutel worden gebruikt voor het versleutelen/ontsleutelen van gegevens. snaar
legitimatiebewijs Naam van de ClientEncryptionKey snaar
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. enig

KeyWrapMetadata

Naam Beschrijving Waarde
algoritme Algoritme dat wordt gebruikt bij het verpakken en uitpakken van de gegevensversleutelingssleutel. snaar
naam De naam van de bijbehorende KeyEncryptionKey (ook wel CustomerManagedKey genoemd). snaar
type ProviderNaam van KeyStoreProvider. snaar
waarde Verwijzing/koppeling naar de KeyEncryptionKey. snaar

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Naam Beschrijving Waarde
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: databaseAccounts/sqlDatabases
Eigenschappen Eigenschappen voor het maken en bijwerken van ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (vereist)
type Het resourcetype "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-11-15"