Udostępnij za pośrednictwem


Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2022-11-15-preview

Definicja zasobu Bicep

Typ zasobu databaseAccounts/sqlDatabases/clientEncryptionKeys można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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@2022-11-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any()
    }
  }
}

Wartości właściwości

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.
ciąg (wymagany)
Nadrzędny 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 : sqlDatabases
properties Właściwości do tworzenia i aktualizowania ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (wymagane)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

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

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Nazwa Opis Wartość
encryptionAlgorithm Algorytm szyfrowania, który będzie używany wraz z tym kluczem szyfrowania klienta do szyfrowania/odszyfrowywania danych. ciąg
identyfikator Nazwa klucza ClientEncryptionKey ciąg
keyWrapMetadata Metadane dla dostawcy opakowującego, który może służyć do odpakowywania opakowany klucz szyfrowania klienta. KeyWrapMetadata
wrappedDataEncryptionKey Opakowana (zaszyfrowana) forma klucza reprezentowana jako tablica bajtów. W przypadku funkcji Bicep można użyć funkcji any().

KeyWrapMetadata

Nazwa Opis Wartość
Algorytm Algorytm używany do opakowywania i rozpakowywania klucza szyfrowania danych. ciąg
name Nazwa skojarzonego klucza KeyEncryptionKey (aka CustomerManagedKey). ciąg
typ ProviderName dostawcy KeyStoreProvider. ciąg
wartość Odwołanie/łącze do klucza KeyEncryptionKey. ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/sqlDatabases/clientEncryptionKeys można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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": "2022-11-15-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

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys"
apiVersion Wersja interfejsu API zasobów "2022-11-15-preview"
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON.
ciąg (wymagany)
properties Właściwości do tworzenia i aktualizowania ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (wymagane)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

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

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Nazwa Opis Wartość
encryptionAlgorithm Algorytm szyfrowania, który będzie używany wraz z tym kluczem szyfrowania klienta do szyfrowania/odszyfrowywania danych. ciąg
identyfikator Nazwa klucza ClientEncryptionKey ciąg
keyWrapMetadata Metadane dla dostawcy opakowującego, który może służyć do odpakowywania opakowany klucz szyfrowania klienta. KeyWrapMetadata
wrappedDataEncryptionKey Opakowana (zaszyfrowana) forma klucza reprezentowana jako tablica bajtów.

KeyWrapMetadata

Nazwa Opis Wartość
Algorytm Algorytm używany do opakowywania i rozpakowywania klucza szyfrowania danych. ciąg
name Nazwa skojarzonego klucza KeyEncryptionKey (aka CustomerManagedKey). ciąg
typ ProviderName dostawcy KeyStoreProvider. ciąg
wartość Odwołanie/łącze do klucza KeyEncryptionKey. ciąg

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/sqlDatabases/clientEncryptionKeys można wdrożyć z operacjami docelowymi:

  • Grupy zasobów

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

Format zasobu

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

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

Wartości właściwości

databaseAccounts/sqlDatabases/clientEncryptionKeys

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2022-11-15-preview"
name Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu : sqlDatabases
properties Właściwości do tworzenia i aktualizowania ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (wymagane)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

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

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Nazwa Opis Wartość
encryptionAlgorithm Algorytm szyfrowania, który będzie używany wraz z tym kluczem szyfrowania klienta do szyfrowania/odszyfrowywania danych. ciąg
identyfikator Nazwa klucza ClientEncryptionKey ciąg
keyWrapMetadata Metadane dla dostawcy opakowującego, który może służyć do odpakowywania opakowany klucz szyfrowania klienta. KeyWrapMetadata
wrappedDataEncryptionKey Opakowana (zaszyfrowana) forma klucza reprezentowana jako tablica bajtów.

KeyWrapMetadata

Nazwa Opis Wartość
Algorytm Algorytm używany do opakowywania i rozpakowywania klucza szyfrowania danych. ciąg
name Nazwa skojarzonego klucza KeyEncryptionKey (aka CustomerManagedKey). ciąg
typ ProviderName dostawcy KeyStoreProvider. ciąg
wartość Odwołanie/łącze do klucza KeyEncryptionKey. ciąg