Sdílet prostřednictvím

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2024-05-15-preview

  • Článek

Definice prostředku Bicep

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

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í příkaz Bicep.

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

Hodnoty vlastností

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Jméno Popis Hodnota
zdroj Standardní formát JSON ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (povinné)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

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

KeyWrapMetadata

Jméno Popis Hodnota
algoritmus Algoritmus použitý při zabalení a rozbalení šifrovacího klíče dat řetězec
Jméno Název přidruženého klíče KeyEncryptionKey (neboli CustomerManagedKey). řetězec
typ ProviderName of KeyStoreProvider. řetězec
hodnota Odkaz / odkaz na KeyEncryptionKey. řetězec

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Jméno Popis Hodnota
Jméno Název prostředku string (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba 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: databaseAccounts/sqlDatabases
vlastnosti Vlastnosti pro vytvoření a aktualizaci ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (povinné)

Definice prostředku šablony ARM

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

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

Hodnoty vlastností

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Jméno Popis Hodnota
zdroj Standardní formát JSON ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (povinné)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

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

KeyWrapMetadata

Jméno Popis Hodnota
algoritmus Algoritmus použitý při zabalení a rozbalení šifrovacího klíče dat řetězec
Jméno Název přidruženého klíče KeyEncryptionKey (neboli CustomerManagedKey). řetězec
typ ProviderName of KeyStoreProvider. řetězec
hodnota Odkaz / odkaz na KeyEncryptionKey. řetězec

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Jméno Popis Hodnota
apiVersion Verze rozhraní API 2024-05-15-preview
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (povinné)
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Příklady použití

Definice prostředku Terraformu (poskytovatel AzAPI)

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

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

Hodnoty vlastností

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Jméno Popis Hodnota
zdroj Standardní formát JSON ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (povinné)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

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

KeyWrapMetadata

Jméno Popis Hodnota
algoritmus Algoritmus použitý při zabalení a rozbalení šifrovacího klíče dat řetězec
Jméno Název přidruženého klíče KeyEncryptionKey (neboli CustomerManagedKey). řetězec
typ ProviderName of KeyStoreProvider. řetězec
hodnota Odkaz / odkaz na KeyEncryptionKey. řetězec

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Jméno Popis Hodnota
Jméno Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: databaseAccounts/sqlDatabases
vlastnosti Vlastnosti pro vytvoření a aktualizaci ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (povinné)
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-05-15-preview