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

База данных Microsoft.DocumentDBAccounts/sqlDatabases/clientEncryptionKeys 2023-11-15

  • Статья

Определение ресурсов Bicep

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

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

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

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

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

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

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

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

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

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

KeyWrapMetadata

Имя Описание Ценность
алгоритм Алгоритм, используемый в оболочке и распаку ключей шифрования данных. струна
имя Имя связанного KeyEncryptionKey (aka CustomerManagedKey). струна
тип Имя поставщика KeyStoreProvider. струна
ценность Ссылка/ ссылка на KeyEncryptionKey. струна

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

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

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

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

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

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

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

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

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

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

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

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

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

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

KeyWrapMetadata

Имя Описание Ценность
алгоритм Алгоритм, используемый в оболочке и распаку ключей шифрования данных. струна
имя Имя связанного KeyEncryptionKey (aka CustomerManagedKey). струна
тип Имя поставщика KeyStoreProvider. струна
ценность Ссылка/ ссылка на KeyEncryptionKey. струна

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Имя Описание Ценность
apiVersion Версия API '2023-11-15'
имя Имя ресурса строка (обязательно)
свойства Свойства для создания и обновления ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (обязательно)
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys"

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

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

  • групп ресурсов

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

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

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

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

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

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

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

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

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

KeyWrapMetadata

Имя Описание Ценность
алгоритм Алгоритм, используемый в оболочке и распаку ключей шифрования данных. струна
имя Имя связанного KeyEncryptionKey (aka CustomerManagedKey). струна
тип Имя поставщика KeyStoreProvider. струна
ценность Ссылка/ ссылка на KeyEncryptionKey. струна

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databaseAccounts/sqlDatabases
свойства Свойства для создания и обновления ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (обязательно)
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-11-15"