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.59.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando az iot device registration. Saiba mais sobre extensões.

Esse grupo de comandos está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Gerencie 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 no Serviço de Provisionamento de Dispositivos IoT.	Extensão	Versão prévia

az iot device registration create

Versão Prévia

O grupo de comandos 'iot device registration' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Registre um dispositivo IoT no Serviço de Provisionamento de Dispositivos IoT.

Os seguintes mecanismos de atestado são suportados:

Chave simétrica
Certificado x509 Se estiver usando métodos de autenticação x509, o certificado e os arquivos de chave (e a senha, se necessário) deverão 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}

Registre 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 da ID do Serviço de Provisionamento de Dispositivos e a chave simétrica fornecida. Isso ignorará a recuperação do Escopo da 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 da ID do Serviço de Provisionamento de Dispositivos e a chave simétrica do grupo de registro fornecida. Isso ignorará a recuperação do Escopo da ID e da chave simétrica do grupo de registro. A chave simétrica usada 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 da ID do Serviço de Provisionamento de Dispositivos e a chave simétrica fornecida. Isso ignorará a recuperação do Escopo da ID. Observe que, como a chave simétrica deve ser a chave do 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 da ID do Serviço de Provisionamento de Dispositivos e os arquivos de certificado e chave fornecidos. Isso ignorará a recuperação do Escopo da 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 da ID do Serviço de Provisionamento de Dispositivos e os arquivos de certificado e chave fornecidos e a senha do arquivo de chave. Isso ignorará a recuperação do Escopo da 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 da ID do Serviço de Provisionamento de Dispositivos e os arquivos de certificado e chave fornecidos. Isso ignorará a recuperação do Escopo da ID. Observe que a ID de registro 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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Valores aceitos: key, login

Valor padrão: key

--certificate-file-path --cp

Caminho para o arquivo PEM do certificado. Necessário para registros x509.

--ck --compute-key

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

Valor padrão: False

--dps-name -n

Nome do Serviço de Provisionamento de Dispositivos do Hub IoT do Azure. Necessário se --login não for fornecido ou argumentos authenticaton e --id-scope não forem fornecidos.

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

ID do grupo de registro. 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 Dispositivos do Hub IoT do Azure. Se fornecido com argumentos de autenticação, evitará o logon da sessão.

--key --symmetric-key

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

--key-file-path --kp

Caminho para o arquivo PEM de chave. Necessário para registros x509.

--login -l

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão tem prioridade. Necessário se --dps-name não for fornecido ou argumentos authenticaton e --id-scope não forem fornecidos.

--pass --passphrase

Frase secreta para o certificado.

--payload

Conteúdo de alocação personalizado 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 a verbosidade de log para mostrar todos os logs de depuração.

--help -h

Mostre esta mensagem de ajuda e saia.

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.