az iot dps enrollment

  • Ссылка

Примечание.

Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.37.0 или более поздней). Расширение автоматически установит при первом запуске команды az iot dps регистрации . Подробнее о расширениях.

Управление отдельными регистрациями устройств в службе подготовки устройств Центр Интернета вещей Azure.

Команды

Имя Описание Тип Состояние
az iot dps enrollment create

Создайте отдельную регистрацию устройств в службе подготовки устройств Центр Интернета вещей Azure.

 Расширение Общедоступная версия
az iot dps enrollment delete

Удаление регистрации отдельного устройства в службе подготовки устройств Центр Интернета вещей Azure.

 Расширение Общедоступная версия
az iot dps enrollment list

Перечисление отдельных регистраций устройств в службе подготовки устройств Центр Интернета вещей Azure.

 Расширение Общедоступная версия
az iot dps enrollment registration

Управление регистрацией устройств на стороне службы для отдельной регистрации в службе подготовки устройств Центр Интернета вещей Azure.

 Расширение Общедоступная версия
az iot dps enrollment registration delete

Удаление регистрации устройства для отдельной регистрации в службе подготовки устройств Центр Интернета вещей Azure.

 Расширение Общедоступная версия
az iot dps enrollment registration show

Получите регистрацию устройства для отдельной регистрации в службе подготовки устройств Центр Интернета вещей Azure.

 Расширение Общедоступная версия
az iot dps enrollment show

Получение сведений о регистрации отдельных устройств в службе подготовки устройств Центр Интернета вещей Azure.

 Расширение Общедоступная версия
az iot dps enrollment update

Обновите регистрацию отдельного устройства в службе подготовки устройств Центр Интернета вещей Azure.

 Расширение Общедоступная версия

az iot dps enrollment create

Создайте отдельную регистрацию устройств в службе подготовки устройств Центр Интернета вещей Azure.

Укажите формат сертификата, используя кодировку Base64 ASCII, и сертификат должен иметь соответствующие сегменты BEGIN и END, например, начать с "-----BEGIN CERTIFICATE-----" и завершиться "-----END CERTIFICATE-----".

az iot dps enrollment create --at {symmetricKey, tpm, x509}
                             --eid
                             [--allocation-policy {custom, geoLatency, hashed, static}]
                             [--api-version]
                             [--auth-type {key, login}]
                             [--certificate-path]
                             [--device-id]
                             [--device-information]
                             [--dps-name]
                             [--edge-enabled {false, true}]
                             [--ek]
                             [--ih]
                             [--initial-twin-properties]
                             [--initial-twin-tags]
                             [--login]
                             [--pk]
                             [--provisioning-status {disabled, enabled}]
                             [--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp]
                             [--secondary-key]
                             [--webhook-url]

Примеры

Создайте регистрацию "{enrollment_id}" с типом аттестации x509 в службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}" с состоянием подготовки "отключено", идентификатор устройства "{device_id}", начальные свойства двойника "{"location":"region":"US"}}", начальные теги двойников "{"version":"1"}" и сведения об устройстве "{"color":"red"}".

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type x509 --certificate-path /certificates/Certificate.pem --provisioning-status disabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version':'1'}" --device-info "{'color':'red'}" --device-id {device_id}

Создайте регистрацию MyEnrollment с типом аттестации tpm в службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}".

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89

Создайте регистрацию MyEnrollment с типом аттестации "симметричный ключ" в службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}".

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --primary-key {primary_key} --secondary-key {secondary_key}

Создайте регистрацию MyEnrollment с повторной подготовкой в службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}".

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --reprovision-policy {reprovision_type} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89

Создайте регистрацию MyEnrollment со статической политикой выделения в службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}".

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy static --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs {iot_hub_host_name}

Создайте регистрацию MyEnrollment с хэш-политикой выделения и несколькими центрами в службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}".

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type tpm --allocation-policy hashed --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs "{iot_hub_host_name1} {iot_hub_host_name2}"

Создайте регистрацию MyEnrollment с помощью настраиваемой политики выделения.

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}

Обязательные параметры

--at --attestation-type

Механизм аттестации, используемый для проверки подлинности в DPS.

допустимые значения: symmetricKey, tpm, x509
--eid --enrollment-id

Идентификатор регистрации отдельных устройств.

Необязательные параметры

--allocation-policy --ap

Тип политики выделения, чтобы определить, как устройство назначается Центр Интернета вещей. Если это не указано, политика выделения будет текущей политикой выделения по умолчанию для экземпляра службы подготовки устройств.

допустимые значения: custom, geoLatency, hashed, static
--api-version --av

Версия API типов служб подготовки, отправленных в пользовательском запросе на выделение. Минимальная поддерживаемая версия: 2018-09-01-preview.

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Вы можете настроить значение по умолчанию с помощью az configure --defaults iotdps-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--certificate-path --cp

Путь к файлу, содержаму первичный сертификат. Требуется при выборе x509 в качестве типа аттестации, а путь к вторичному сертификату не указан.

--device-id -d

Идентификатор устройства, зарегистрированный в Центр Интернета вещей.

--device-information --info

Необязательные сведения об устройстве.

--dps-name -n

Имя или имя узла службы подготовки устройств Центр Интернета вещей Azure. Требуется, если --login не указан.

--edge-enabled --ee

Флаг, указывающий включение ребра.

допустимые значения: false, true
значение по умолчанию: False
--ek --endorsement-key

Ключ подтверждения доверенного платформенного модуля для устройства TPM. При выборе tpm в качестве типа аттестации требуется ключ подтверждения.

--ih --iot-hubs

Имя узла целевой Центр Интернета вещей, связанной с политикой выделения. Используйте разделенный пробелами список для нескольких Центр Интернета вещей.

--initial-twin-properties --props

Начальные свойства двойника устройства.

--initial-twin-tags --tags

Начальные теги двойника устройства.

--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Обязательный параметр , если --dps-name не указан.

--pk --primary-key

Первичный симметричный общий ключ доступа, хранящийся в формате Base64.

--provisioning-status --ps

Включение или отключение записи регистрации.

допустимые значения: disabled, enabled
--reprovision-policy --rp

Политика, чтобы определить, как следует обрабатывать данные устройства при повторной подготовке в другой Центр Интернета вещей.

допустимые значения: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--scp --secondary-certificate-path

Путь к файлу, содержаму вторичный сертификат. Требуется при выборе x509 в качестве типа аттестации, а путь к основному сертификату не указан.

--secondary-key --sk

Вторичный симметричный общий ключ доступа, хранящийся в формате Base64.

--webhook-url --wh

URL-адрес веб-перехватчика функции Azure, используемый для пользовательских запросов на выделение.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az iot dps enrollment delete

Удаление регистрации отдельного устройства в службе подготовки устройств Центр Интернета вещей Azure.

az iot dps enrollment delete --eid
                             [--auth-type {key, login}]
                             [--dps-name]
                             [--etag]
                             [--login]
                             [--resource-group]

Обязательные параметры

--eid --enrollment-id

Идентификатор регистрации отдельных устройств.

Необязательные параметры

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Вы можете настроить значение по умолчанию с помощью az configure --defaults iotdps-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--dps-name -n

Имя или имя узла службы подготовки устройств Центр Интернета вещей Azure. Требуется, если --login не указан.

--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".

--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Обязательный параметр , если --dps-name не указан.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az iot dps enrollment list

Перечисление отдельных регистраций устройств в службе подготовки устройств Центр Интернета вещей Azure.

az iot dps enrollment list [--auth-type {key, login}]
                           [--dps-name]
                           [--login]
                           [--resource-group]
                           [--top]

Необязательные параметры

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Вы можете настроить значение по умолчанию с помощью az configure --defaults iotdps-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--dps-name -n

Имя или имя узла службы подготовки устройств Центр Интернета вещей Azure. Требуется, если --login не указан.

--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Обязательный параметр , если --dps-name не указан.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--top

Максимальное количество возвращаемых элементов. Используйте -1 для неограниченного количества.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az iot dps enrollment show

Получение сведений о регистрации отдельных устройств в службе подготовки устройств Центр Интернета вещей Azure.

az iot dps enrollment show --eid
                           [--auth-type {key, login}]
                           [--dps-name]
                           [--keys {false, true}]
                           [--login]
                           [--resource-group]

Примеры

Базовое использование

az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}

Включение полных сведений аттестации в результаты регистрации симметричного ключа

az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys

Обязательные параметры

--eid --enrollment-id

Идентификатор регистрации отдельных устройств.

Необязательные параметры

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Вы можете настроить значение по умолчанию с помощью az configure --defaults iotdps-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--dps-name -n

Имя или имя узла службы подготовки устройств Центр Интернета вещей Azure. Требуется, если --login не указан.

--keys --show-keys

Включите ключи аттестации и сведения в результаты регистрации.

допустимые значения: false, true
--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Обязательный параметр , если --dps-name не указан.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az iot dps enrollment update

Обновите регистрацию отдельного устройства в службе подготовки устройств Центр Интернета вещей Azure.

Укажите формат сертификата, используя кодировку Base64 ASCII, и сертификат должен иметь соответствующие сегменты BEGIN и END, например, начать с "-----BEGIN CERTIFICATE-----" и завершиться "-----END CERTIFICATE-----".

az iot dps enrollment update --eid
                             [--allocation-policy {custom, geoLatency, hashed, static}]
                             [--api-version]
                             [--auth-type {key, login}]
                             [--certificate-path]
                             [--device-id]
                             [--device-information]
                             [--dps-name]
                             [--edge-enabled {false, true}]
                             [--ek]
                             [--etag]
                             [--ih]
                             [--initial-twin-properties]
                             [--initial-twin-tags]
                             [--login]
                             [--pk]
                             [--provisioning-status {disabled, enabled}]
                             [--rc {false, true}]
                             [--remove-secondary-certificate {false, true}]
                             [--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp]
                             [--secondary-key]
                             [--webhook-url]

Примеры

Обновите регистрацию "{enrollment_id}" с новым сертификатом x509 в службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}".

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --etag AAAAAAAAAAA=

Обновите регистрацию "{enrollment_id}" с новым ключом подтверждения в службе подготовки устройств Azure IoT "{dps_name}" в группе ресурсов "{resource_group_name}".

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --etag AAAAAAAAAAA=

Обновите регистрацию "{enrollment_id}" с новым первичным ключом в службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}".

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=

Обновите регистрацию "{enrollment_id}" с новым типом повторной подготовки устройств в Службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}".

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --reprovision-policy {reprovision_type} --etag AAAAAAAAAAA=

Обновите регистрацию "{enrollment_id}" с помощью новой политики выделения в службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}".

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy geolatency --etag AAAAAAAAAAA= --iot-hubs "{iot_hub_host_name1} {iot_hub_host_name2} {iot_hub_host_name3}"

Обновите регистрацию "{enrollment_id}" в службе подготовки устройств Интернета вещей Azure "{dps_name}" в группе ресурсов "{resource_group_name}" с начальными свойствами двойника "{"location":{"region":"США"}", начальными тегами двойников "{"version":"2"}" и сведениями об устройстве "{"color":"red"}".

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version1':'2'}" --device-info "{'color':'red'}"

Обязательные параметры

--eid --enrollment-id

Идентификатор регистрации отдельных устройств.

Необязательные параметры

--allocation-policy --ap

Тип политики выделения, чтобы определить, как устройство назначается Центр Интернета вещей. Если это не указано, политика выделения будет текущей политикой выделения по умолчанию для экземпляра службы подготовки устройств.

допустимые значения: custom, geoLatency, hashed, static
--api-version --av

Версия API типов служб подготовки, отправленных в пользовательском запросе на выделение. Минимальная поддерживаемая версия: 2018-09-01-preview.

--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Вы можете настроить значение по умолчанию с помощью az configure --defaults iotdps-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--certificate-path --cp

Путь к файлу, содержаму первичный сертификат.

--device-id -d

Идентификатор устройства, зарегистрированный в Центр Интернета вещей.

--device-information --info

Необязательные сведения об устройстве.

--dps-name -n

Имя или имя узла службы подготовки устройств Центр Интернета вещей Azure. Требуется, если --login не указан.

--edge-enabled --ee

Флаг, указывающий включение ребра.

допустимые значения: false, true
--ek --endorsement-key

Ключ подтверждения доверенного платформенного модуля для устройства TPM.

--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".

--ih --iot-hubs

Имя узла целевой Центр Интернета вещей, связанной с политикой выделения. Используйте разделенный пробелами список для нескольких Центр Интернета вещей.

--initial-twin-properties --props

Начальные свойства двойника устройства.

--initial-twin-tags --tags

Начальные теги двойника устройства.

--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Обязательный параметр , если --dps-name не указан.

--pk --primary-key

Первичный симметричный общий ключ доступа, хранящийся в формате Base64.

--provisioning-status --ps

Включение или отключение записи регистрации.

допустимые значения: disabled, enabled
--rc --remove-certificate

Пометка для удаления текущего первичного сертификата.

допустимые значения: false, true
--remove-secondary-certificate --rsc

Пометка для удаления текущего вторичного сертификата.

допустимые значения: false, true
--reprovision-policy --rp

Политика, чтобы определить, как следует обрабатывать данные устройства при повторной подготовке в другой Центр Интернета вещей.

допустимые значения: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

--scp --secondary-certificate-path

Путь к файлу, содержаму вторичный сертификат.

--secondary-key --sk

Вторичный симметричный общий ключ доступа, хранящийся в формате Base64.

--webhook-url --wh

URL-адрес веб-перехватчика функции Azure, используемый для пользовательских запросов на выделение.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

Показывать только ошибки, блокируя предупреждения.

--output -o

Формат вывода.

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Повышение уровня детализации журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.