Поделиться через

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2021-10-15-preview

  • Статья

Определение ресурса Bicep

Тип ресурса databaseAccounts/sqlDatabases/clientEncryptionKeys можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, добавьте следующий Bicep в шаблон.

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

Значения свойств

databaseAccounts/sqlDatabases/clientEncryptionKeys

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.		 строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: sqlDatabases
properties Свойства для создания и обновления ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (обязательно)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Имя Описание Значение
ресурс Стандартный формат JSON clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (обязательно)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Имя Описание Значение
encryptionAlgorithm Алгоритм шифрования, который будет использоваться вместе с этим ключом шифрования клиента для шифрования и расшифровки данных. строка
идентификатор Имя ClientEncryptionKey строка
keyWrapMetadata Метаданные поставщика оболочки, которые можно использовать для распаковки ключа шифрования клиента. KeyWrapMetadata
wrappedDataEncryptionKey Зашифрованная (зашифрованная) форма ключа, представленного в виде массива байтов. Для Bicep можно использовать функцию any().

KeyWrapMetadata

Имя Описание Значение
name Имя связанного ключа KeyEncryptionKey (customerManagedKey). строка
type ProviderName объекта KeyStoreProvider. строка
value Ссылка или ссылка на KeyEncryptionKey. строка

Определение ресурса шаблона ARM

Тип ресурса databaseAccounts/sqlDatabases/clientEncryptionKeys можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, добавьте следующий код JSON в шаблон.

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

Значения свойств

databaseAccounts/sqlDatabases/clientEncryptionKeys

Имя Описание Значение
тип Тип ресурса Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys
версия_API Версия API ресурсов '2021-10-15-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.		 string (обязательно)
properties Свойства для создания и обновления ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (обязательно)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Имя Описание Значение
ресурс Стандартный формат JSON clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (обязательно)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Имя Описание Значение
encryptionAlgorithm Алгоритм шифрования, который будет использоваться вместе с этим ключом шифрования клиента для шифрования и расшифровки данных. строка
идентификатор Имя ClientEncryptionKey строка
keyWrapMetadata Метаданные для поставщика оболочки, которые можно использовать для распаковки ключа шифрования клиента, включаемого в оболочку. KeyWrapMetadata
wrappedDataEncryptionKey Зашифрованная (зашифрованная) форма ключа, представленного в виде массива байтов.

KeyWrapMetadata

Имя Описание Значение
name Имя связанного ключа KeyEncryptionKey (customerManagedKey). строка
type ProviderName объекта KeyStoreProvider. строка
value Ссылка или ссылка на KeyEncryptionKey. строка

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса databaseAccounts/sqlDatabases/clientEncryptionKeys можно развернуть с помощью операций, предназначенных для:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, добавьте следующую terraform в шаблон.

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

Значения свойств

databaseAccounts/sqlDatabases/clientEncryptionKeys

Имя Описание Значение
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2021-10-15-preview"
name имя ресурса. string (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: sqlDatabases
properties Свойства для создания и обновления ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (обязательно)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Имя Описание Значение
ресурс Стандартный формат JSON clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (обязательно)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Имя Описание Значение
encryptionAlgorithm Алгоритм шифрования, который будет использоваться вместе с этим ключом шифрования клиента для шифрования и расшифровки данных. строка
идентификатор Имя ClientEncryptionKey строка
keyWrapMetadata Метаданные для поставщика оболочки, которые можно использовать для распаковки ключа шифрования клиента, включаемого в оболочку. KeyWrapMetadata
wrappedDataEncryptionKey Зашифрованная (зашифрованная) форма ключа, представленного в виде массива байтов.

KeyWrapMetadata

Имя Описание Значение
name Имя связанного ключа KeyEncryptionKey (customerManagedKey). строка
type ProviderName объекта KeyStoreProvider. строка
value Ссылка или ссылка на KeyEncryptionKey. строка