az iot device registration

  • Versão Prévia
  • Referência

Observação

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.37.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot device registration . Saiba mais sobre extensões.

Este grupo de comandos está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Gerenciar registros de dispositivos IoT para o Serviço de Provisionamento de Dispositivos IoT.

Use az iot dps enrollment registration ou az iot dps enrollment-group registration para exibir e excluir registros.

Comandos

Nome Description Tipo Status
az iot device registration create

Registre um dispositivo IoT com o Serviço de Provisionamento de Dispositivo IoT.

 Extensão Versão Prévia

az iot device registration create

Versão Prévia

O grupo de comando 'registro de dispositivo iot' está em pré-visualização e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Registre um dispositivo IoT com o Serviço de Provisionamento de Dispositivo IoT.

Os seguintes mecanismos de atestado são suportados:

  • Chave simétrica
  • Certificado x509 Se estiver usando métodos de autenticação x509, os arquivos de certificado e chave (e senha, se necessário) devem ser fornecidos.
az iot device registration create --registration-id
                                  [--auth-type {key, login}]
                                  [--certificate-file-path]
                                  [--ck]
                                  [--dps-name]
                                  [--enrollment-group-id]
                                  [--host]
                                  [--id-scope]
                                  [--key]
                                  [--key-file-path]
                                  [--login]
                                  [--pass]
                                  [--payload]
                                  [--resource-group]

Exemplos

Registre um dispositivo IoT usando um registro individual.

az iot device registration create -n {dps_name} --rid {registration_id}

Registrar um dispositivo IoT usando um registro de grupo.

az iot device registration create -n {dps_name} --rid {registration_id} --gid {group_enrollment_id}

Registre um dispositivo IoT usando um registro individual, o escopo de ID do Serviço de Provisionamento de Dispositivo e uma chave simétrica fornecida. Isso ignorará a recuperação do escopo de ID e da chave simétrica de registro individal.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}

Registre um dispositivo IoT usando um registro de grupo, o Escopo de ID do Serviço de Provisionamento de Dispositivo e uma chave simétrica de grupo de registro fornecida. Isso ignorará a recuperação do escopo de ID e da chave simétrica do grupo de registro. A chave simétrica utilizada para o registro do dispositivo será computada a partir da chave simétrica fornecida.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --gid {group_enrollment_id} --key {symmetric_key} --ck

Registre um dispositivo IoT usando um registro de grupo, o escopo de ID do Serviço de Provisionamento de Dispositivo e uma chave simétrica fornecida. Isso ignorará a recuperação do escopo de ID. Observe que, como a chave simétrica deve ser a chave de dispositivo computada, a ID do grupo de registro não é necessária.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --key {symmetric_key}

Registre um dispositivo IoT usando um registro individual, o escopo de ID do Serviço de Provisionamento de Dispositivo e arquivos de certificado e chave fornecidos. Isso ignorará a recuperação do escopo de ID.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}

Registre um dispositivo IoT usando um registro individual, o Escopo de ID do Serviço de Provisionamento de Dispositivo e os arquivos de certificado e chave fornecidos e a senha para o arquivo de chave. Isso ignorará a recuperação do escopo de ID.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file} --pass {passphrase}

Registre um dispositivo IoT usando um registro de grupo, o Escopo de ID do Serviço de Provisionamento de Dispositivo e arquivos de certificado e chave fornecidos. Isso ignorará a recuperação do escopo de ID. Observe que a ID de inscrição de grupo não é necessária para atestados x509 e o assunto do arquivo de certificado é a ID de registro.

az iot device registration create --id-scope {id_scope} --rid {registration_id} --cp {certificate_file} --kp {key_file}

Parâmetros Exigidos

--registration-id --rid

ID de registro do dispositivo ou ID de registro individual.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type=<auth-type-value>o .

valores aceitos: key, login
valor padrão: key
--certificate-file-path --cp

Caminho para o arquivo PEM do certificado. Obrigatório para registros x509.

--ck --compute-key

Sinalizador para indicar que a chave simétrica para o registro do dispositivo deve ser computada a partir da chave fornecida com --symmetric-key.

valor padrão: False
--dps-name -n

Nome do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido ou se os argumentos authenticaton e --id-scope não forem fornecidos.

--enrollment-group-id --gid --group-id

ID do grupo de inscrição. Necessário apenas para recuperar argumentos de autenticação.

--host --provisioning-host

Ponto de extremidade apontando para o host de provisionamento a ser usado.

valor padrão: global.azure-devices-provisioning.net
--id-scope --scope

Escopo de id do serviço de provisionamento de dispositivo do Hub IoT do Azure. Se fornecido com argumentos de autenticação, evitará o login da sessão.

--key --symmetric-key

A chave de acesso compartilhada simétrica para o registro do dispositivo.

--key-file-path --kp

Caminho para o arquivo PEM chave. Obrigatório para registros x509.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --dps-name não for fornecido ou se os argumentos authenticaton e --id-scope não forem fornecidos.

--pass --passphrase

Senha para o certificado.

--payload

Carga útil de alocação personalizada como JSON. Especificamente para uso com políticas de alocação personalizadas usando o Azure Functions.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.