Dela via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2024-12-01-preview

Bicep-resursdefinition

Resurstypen databaseAccounts/sqlDatabases/clientEncryptionKeys kan distribueras med åtgärder som mål:

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-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any(...)
    }
  }
}

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
förälder 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 den överordnade resursen.		 Symboliskt namn för resurs av typen: databaseAccounts/sqlDatabases
Egenskaper Egenskaper för att skapa och uppdatera ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (krävs)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Namn Beskrivning Värde
resurs JSON-standardformatet för en ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (krävs)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Namn Beskrivning Värde
encryptionAlgorithm (på engelska) Krypteringsalgoritm som ska användas tillsammans med den här klientkrypteringsnyckeln för att kryptera/dekryptera data. sträng
Id Namn på ClientEncryptionKey sträng
keyWrapMetadata Metadata för omslutningsprovidern som kan användas för att packa upp den omslutna klientkrypteringsnyckeln. KeyWrapMetadata (på engelska)
wrappedDataEncryptionKey Omsluten (krypterad) form av nyckeln som representeras som en bytematris. någon

KeyWrapMetadata (på engelska)

Namn Beskrivning Värde
algoritm Algoritm som används för att omsluta och packa upp datakrypteringsnyckeln. sträng
Namn 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:

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

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Namn Beskrivning Värde
apiVersion API-versionen "2024-12-01-preview"
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för att skapa och uppdatera ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (krävs)
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys"

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Namn Beskrivning Värde
resurs JSON-standardformatet för en ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (krävs)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Namn Beskrivning Värde
encryptionAlgorithm (på engelska) Krypteringsalgoritm som ska användas tillsammans med den här klientkrypteringsnyckeln för att kryptera/dekryptera data. sträng
Id Namn på ClientEncryptionKey sträng
keyWrapMetadata Metadata för omslutningsprovidern som kan användas för att packa upp den omslutna klientkrypteringsnyckeln. KeyWrapMetadata (på engelska)
wrappedDataEncryptionKey Omsluten (krypterad) form av nyckeln som representeras som en bytematris. någon

KeyWrapMetadata (på engelska)

Namn Beskrivning Värde
algoritm Algoritm som används för att omsluta och packa upp datakrypteringsnyckeln. sträng
Namn 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

Användningsexempel

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-12-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
        wrappedDataEncryptionKey = ?
      }
    }
  }
}

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
föräldra_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: databaseAccounts/sqlDatabases
Egenskaper Egenskaper för att skapa och uppdatera ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (krävs)
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-12-01-preview"

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Namn Beskrivning Värde
resurs JSON-standardformatet för en ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (krävs)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Namn Beskrivning Värde
encryptionAlgorithm (på engelska) Krypteringsalgoritm som ska användas tillsammans med den här klientkrypteringsnyckeln för att kryptera/dekryptera data. sträng
Id Namn på ClientEncryptionKey sträng
keyWrapMetadata Metadata för omslutningsprovidern som kan användas för att packa upp den omslutna klientkrypteringsnyckeln. KeyWrapMetadata (på engelska)
wrappedDataEncryptionKey Omsluten (krypterad) form av nyckeln som representeras som en bytematris. någon

KeyWrapMetadata (på engelska)

Namn Beskrivning Värde
algoritm Algoritm som används för att omsluta och packa upp datakrypteringsnyckeln. sträng
Namn 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