Databáze Microsoft.DocumentDBAccounts/sqlDatabases/clientEncryptionKeys 2023-09-15

  • Článek

Definice prostředku Bicep

Typ prostředku databaseAccounts/sqlDatabases/clientEncryptionKeys je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, přidejte do šablony následující bicep.

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

Hodnoty vlastností

databaseAccounts/sqlDatabases/clientEncryptionKeys

Název Description Hodnota
name Název prostředku

Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu.		 string (povinné)
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: sqlDatabases
properties Vlastnosti pro vytvoření a aktualizaci ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (povinné)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Název Description Hodnota
prostředek Standardní formát JSON klíče ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (povinné)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Název Description Hodnota
encryptionAlgorithm Šifrovací algoritmus, který se použije společně s tímto šifrovacím klíčem klienta k šifrování nebo dešifrování dat. řetězec
id Název klíče ClientEncryptionKey řetězec
keyWrapMetadata Metadata zprostředkovatele zabalení, která se dají použít k rozbalení zabaleného šifrovacího klíče klienta. KeyWrapMetadata
wrappedDataEncryptionKey Zabalená (šifrovaná) forma klíče reprezentovaného jako pole bajtů. Pro Bicep můžete použít funkci any().

KeyWrapMetadata

Název Description Hodnota
Algoritmus Algoritmus použitý při zabalení a rozbalování šifrovacího klíče dat řetězec
name Název přidruženého klíče KeyEncryptionKey (neboli CustomerManagedKey). řetězec
typ ProviderName pro KeyStoreProvider. řetězec
hodnota Odkaz nebo odkaz na klíč KeyEncryptionKey. řetězec

Definice prostředku šablony ARM

Typ prostředku databaseAccounts/sqlDatabases/clientEncryptionKeys je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, přidejte do šablony následující kód JSON.

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

Hodnoty vlastností

databaseAccounts/sqlDatabases/clientEncryptionKeys

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys
apiVersion Verze rozhraní API prostředku '2023-09-15'
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.		 string (povinné)
properties Vlastnosti pro vytvoření a aktualizaci ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (povinné)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Název Description Hodnota
prostředek Standardní formát JSON clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (povinné)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Název Description Hodnota
šifrováníAlgorithm Šifrovací algoritmus, který se použije společně s tímto šifrovacím klíčem klienta k šifrování/dešifrování dat. řetězec
id Název klíče ClientEncryptionKey řetězec
keyWrapMetadata Metadata pro zprostředkovatele zabalení, která lze použít k rozbalení zabaleného šifrovacího klíče klienta. KeyWrapMetadata
wrappedDataEncryptionKey Zabalená (šifrovaná) forma klíče reprezentovaného jako pole bajtů.

KeyWrapMetadata

Název Description Hodnota
Algoritmus Algoritmus použitý k zabalení a rozbalení šifrovacího klíče dat. řetězec
name Název přidruženého klíče KeyEncryptionKey (neboli CustomerManagedKey). řetězec
typ ProviderName poskytovatele KeyStoreProvider. řetězec
hodnota Odkaz nebo odkaz na KeyEncryptionKey. řetězec

Definice prostředku Terraform (poskytovatel AzAPI)

Typ prostředku databaseAccounts/sqlDatabases/clientEncryptionKeys je možné nasadit s operacemi, které cílí na:

  • Skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

databaseAccounts/sqlDatabases/clientEncryptionKeys

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15
name Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu : sqlDatabases
properties Vlastnosti pro vytvoření a aktualizaci ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (povinné)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Název Description Hodnota
prostředek Standardní formát JSON clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (povinné)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Název Description Hodnota
šifrováníAlgorithm Šifrovací algoritmus, který se použije společně s tímto šifrovacím klíčem klienta k šifrování/dešifrování dat. řetězec
id Název klíče ClientEncryptionKey řetězec
keyWrapMetadata Metadata pro zprostředkovatele zabalení, která lze použít k rozbalení zabaleného šifrovacího klíče klienta. KeyWrapMetadata
wrappedDataEncryptionKey Zabalená (šifrovaná) forma klíče reprezentovaného jako pole bajtů.

KeyWrapMetadata

Název Description Hodnota
Algoritmus Algoritmus použitý k zabalení a rozbalení šifrovacího klíče dat. řetězec
name Název přidruženého klíče KeyEncryptionKey (neboli CustomerManagedKey). řetězec
typ ProviderName pro KeyStoreProvider. řetězec
hodnota Odkaz nebo odkaz na klíč KeyEncryptionKey. řetězec