Devices - Update Extended Information

Ссылка

Service:: Data Box Edge/Data Box Gateway

API Version:: 2021-02-01

Возвращает дополнительные сведения для указанного устройства Data Box Edge или Шлюза Data Box.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation?api-version=2021-02-01

Параметры URI

Name	In	Required	Type	Description
deviceName	path	True	string	Имя устройства.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Идентификатор подписки.
api-version	query	True	string	Версия API.

Текст запроса

Name	Type	Description
channelIntegrityKeyName	string	Имя ключа целостности канала, хранящегося в клиентском Key Vault
channelIntegrityKeyVersion	string	Версия ключа целостности канала, хранящейся в клиентском Key Vault
clientSecretStoreId	string	Идентификатор Key Vault ARM для секретов клиента
clientSecretStoreUrl	string	URL-адрес для доступа к клиентскому Key Vault
syncStatus	KeyVaultSyncStatus	Для изменения или запуска повторной синхронизации в key-vault, для установки состояния KeyVaultSyncPending остальная часть состояния не будет применяться.

Ответы

Name	Type	Description
200 OK	DataBoxEdgeDeviceExtendedInfo	Измените дополнительные сведения.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

GetUpdateExtendedInfo

Sample Request

POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateExtendedInformation?api-version=2021-02-01

Request Body

{}

Sample Response

Status code:: 200

{
  "properties": {
    "clientSecretStoreId": "/subscriptions/0d44739e-0563-474f-97e7-24a0cdb23b29/resourceGroups/arja-rg/providers/Microsoft.KeyVault/vaults/test-keyvault-ccy-523",
    "clientSecretStoreUrl": "https://test-keyvault-ccy-523.vault.azure.net",
    "channelIntegrityKeyName": "ase-cik-ab861822-21ea-4d31-96ec-89aa066f9a59",
    "channelIntegrityKeyVersion": "95e9b619e65f433d82c9e1ead48214b9",
    "keyVaultSyncStatus": "KeyVaultSynced",
    "deviceSecrets": {
      "HcsDataVolumeBitLockerExternalKey": {
        "keyVaultId": "Id"
      },
      "HcsInternalVolumeBitLockerExternalKey": {
        "keyVaultId": "Id"
      },
      "SystemVolumeBitLockerRecoveryKey": {
        "keyVaultId": "Id"
      },
      "SEDEncryptionExternalKeyId": {},
      "SEDEncryptionExternalKey": {},
      "BMCDefaultUserPassword": {},
      "RotateKeyForDataVolumeBitlocker": {},
      "RotateKeysForSedDrivesSerialized": {}
    }
  }
}

Определения

AsymmetricEncryptedSecret	Представляет секреты, предназначенные для шифрования с асимметричной парой ключей.
CloudError	Ответ об ошибке службы.
CloudErrorBody	Ответ об ошибке службы.
DataBoxEdgeDeviceExtendedInfo	Расширенные сведения об устройстве Data Box Edge или шлюзе.
DataBoxEdgeDeviceExtendedInfoPatch	Расширенное исправление сведений для устройства Data Box Edge или шлюза.
EncryptionAlgorithm	Алгоритм, используемый для шифрования значения.
KeyVaultSyncStatus	Состояние синхронизации хранилища ключей
Secret	Хранит секрет устройства в виде ссылки на KeyVault или в виде зашифрованного значения.

AsymmetricEncryptedSecret

Представляет секреты, предназначенные для шифрования с асимметричной парой ключей.

Name	Type	Description
encryptionAlgorithm	EncryptionAlgorithm	Алгоритм, используемый для шифрования значения.
encryptionCertThumbprint	string	Сертификат отпечатка, используемый для шифрования значения. Если значение незашифровано, оно будет иметь значение NULL.
value	string	Значение секрета.

CloudError

Ответ об ошибке службы.

Name	Type	Description
error	CloudErrorBody	Сведения об ошибке.

CloudErrorBody

Ответ об ошибке службы.

Name	Type	Description
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

DataBoxEdgeDeviceExtendedInfo

Расширенные сведения об устройстве Data Box Edge или шлюзе.

Name	Type	Description
id	string	Идентификатор пути, который однозначно идентифицирует объект.
name	string	Имя объекта.
properties.channelIntegrityKeyName	string	Имя ключа целостности канала, хранящегося в клиентском Key Vault
properties.channelIntegrityKeyVersion	string	Версия ключа целостности канала, хранящейся в клиентском Key Vault
properties.clientSecretStoreId	string	Идентификатор Key Vault ARM для секретов клиента
properties.clientSecretStoreUrl	string	URL-адрес для доступа к клиентскому Key Vault
properties.deviceSecrets	<string, Secret>	Секреты устройств будут возвращены только с помощью ODataFilter $expand=deviceSecrets
properties.encryptionKey	string	Общедоступная часть сертификата шифрования. Клиент использует его для шифрования любого секрета.
properties.encryptionKeyThumbprint	string	Цифровая подпись зашифрованного сертификата.
properties.keyVaultSyncStatus	KeyVaultSyncStatus	Состояние синхронизации хранилища ключей
properties.resourceKey	string	Идентификатор ресурса.
type	string	Иерархический тип объекта.

DataBoxEdgeDeviceExtendedInfoPatch

Расширенное исправление сведений для устройства Data Box Edge или шлюза.

Name	Type	Description
channelIntegrityKeyName	string	Имя ключа целостности канала, хранящегося в клиентском Key Vault
channelIntegrityKeyVersion	string	Версия ключа целостности канала, хранящейся в клиентском Key Vault
clientSecretStoreId	string	Идентификатор Key Vault ARM для секретов клиента
clientSecretStoreUrl	string	URL-адрес для доступа к клиентскому Key Vault
syncStatus	KeyVaultSyncStatus	Для изменения или запуска повторной синхронизации в key-vault, для установки состояния KeyVaultSyncPending остальная часть состояния не будет применяться.

EncryptionAlgorithm

Алгоритм, используемый для шифрования значения.

Name	Type	Description
AES256	string
None	string
RSAES_PKCS1_v_1_5	string

KeyVaultSyncStatus

Состояние синхронизации хранилища ключей

Name	Type	Description
KeyVaultNotConfigured	string
KeyVaultNotSynced	string
KeyVaultSyncFailed	string
KeyVaultSyncPending	string
KeyVaultSynced	string
KeyVaultSyncing	string

Secret

Хранит секрет устройства в виде ссылки на KeyVault или в виде зашифрованного значения.

Name	Type	Description
encryptedSecret	AsymmetricEncryptedSecret	Зашифрованное значение секрета (с помощью открытого ключа устройства).
keyVaultId	string	Идентификатор Key-Vault, где хранится секрет (например, secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).