Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys

  • Artykuł

Definicja zasobu Bicep

Typ zasobu databaseAccounts/sqlDatabases/clientEncryptionKeys można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, dodaj następujący kod Bicep do szablonu.

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(...)
    }
  }
}

Wartości właściwości

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nazwa Opis Wartość
zasób Standardowy format JSON clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (wymagane)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nazwa Opis Wartość
encryptionAlgorithm Algorytm szyfrowania, który będzie używany wraz z tym kluczem szyfrowania klienta do szyfrowania/odszyfrowywania danych. struna
id Nazwa klucza ClientEncryptionKey struna
keyWrapMetadata Metadane dostawcy opakowującego, za pomocą których można odpakować opakowany klucz szyfrowania klienta. KeyWrapMetadata
wrappedDataEncryptionKey Opakowana (zaszyfrowana) forma klucza reprezentowana jako tablica bajtów. jakikolwiek

KeyWrapMetadata

Nazwa Opis Wartość
algorytm Algorytm używany w zawijaniu i rozpakuj klucz szyfrowania danych. struna
nazwa Nazwa skojarzonego klucza KeyEncryptionKey (aka CustomerManagedKey). struna
typ ProviderName dostawcy KeyStoreProvider. struna
wartość Odwołanie/łącze do klucza KeyEncryptionKey. struna

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: databaseAccounts/sqlDatabases
Właściwości Właściwości do tworzenia i aktualizowania clientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (wymagane)

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/sqlDatabases/clientEncryptionKeys można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, dodaj następujący kod JSON do szablonu.

{
  "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": {}
    }
  }
}

Wartości właściwości

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nazwa Opis Wartość
zasób Standardowy format JSON clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (wymagane)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nazwa Opis Wartość
encryptionAlgorithm Algorytm szyfrowania, który będzie używany wraz z tym kluczem szyfrowania klienta do szyfrowania/odszyfrowywania danych. struna
id Nazwa klucza ClientEncryptionKey struna
keyWrapMetadata Metadane dostawcy opakowującego, za pomocą których można odpakować opakowany klucz szyfrowania klienta. KeyWrapMetadata
wrappedDataEncryptionKey Opakowana (zaszyfrowana) forma klucza reprezentowana jako tablica bajtów. jakikolwiek

KeyWrapMetadata

Nazwa Opis Wartość
algorytm Algorytm używany w zawijaniu i rozpakuj klucz szyfrowania danych. struna
nazwa Nazwa skojarzonego klucza KeyEncryptionKey (aka CustomerManagedKey). struna
typ ProviderName dostawcy KeyStoreProvider. struna
wartość Odwołanie/łącze do klucza KeyEncryptionKey. struna

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2024-12-01-preview"
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości do tworzenia i aktualizowania clientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (wymagane)
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys"

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/sqlDatabases/clientEncryptionKeys można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-12-01-preview"
  name = "string"
  body = {
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
        wrappedDataEncryptionKey = ?
      }
    }
  }
}

Wartości właściwości

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nazwa Opis Wartość
zasób Standardowy format JSON clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (wymagane)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nazwa Opis Wartość
encryptionAlgorithm Algorytm szyfrowania, który będzie używany wraz z tym kluczem szyfrowania klienta do szyfrowania/odszyfrowywania danych. struna
id Nazwa klucza ClientEncryptionKey struna
keyWrapMetadata Metadane dostawcy opakowującego, za pomocą których można odpakować opakowany klucz szyfrowania klienta. KeyWrapMetadata
wrappedDataEncryptionKey Opakowana (zaszyfrowana) forma klucza reprezentowana jako tablica bajtów. jakikolwiek

KeyWrapMetadata

Nazwa Opis Wartość
algorytm Algorytm używany w zawijaniu i rozpakuj klucz szyfrowania danych. struna
nazwa Nazwa skojarzonego klucza KeyEncryptionKey (aka CustomerManagedKey). struna
typ ProviderName dostawcy KeyStoreProvider. struna
wartość Odwołanie/łącze do klucza KeyEncryptionKey. struna

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts/sqlDatabases
Właściwości Właściwości do tworzenia i aktualizowania clientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (wymagane)
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-12-01-preview"