az iot dps enrollment
Nota
Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.46.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot dps enrollment . Saiba mais sobre extensões.
Gerencie inscrições de dispositivos individuais em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
Comandos
Name | Description | Tipo | Status |
---|---|---|---|
az iot dps enrollment create |
Crie um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. |
Extensão | GA |
az iot dps enrollment delete |
Exclua um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. |
Extensão | GA |
az iot dps enrollment list |
Liste inscrições de dispositivos individuais em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. |
Extensão | GA |
az iot dps enrollment registration |
Gerencie registros de dispositivos do lado do serviço para um registro individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. |
Extensão | GA |
az iot dps enrollment registration delete |
Exclua um registro de dispositivo para um registro individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. |
Extensão | GA |
az iot dps enrollment registration show |
Obtenha um registro de dispositivo para um registro individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. |
Extensão | GA |
az iot dps enrollment show |
Obtenha detalhes de registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. |
Extensão | GA |
az iot dps enrollment update |
Atualize um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. |
Extensão | GA |
az iot dps enrollment create
Crie um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
Forneça o formato do certificado usando a codificação ASCII Base64 e o certificado deve ter segmentos BEGIN e END correspondentes, por exemplo: comece com '-----BEGIN CERTIFICATE-----' e termine com '-----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]
[--hn]
[--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]
Exemplos
Crie um registro '{enrollment_id}' com o tipo de atestado 'x509' no Serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name}' com status de provisionamento 'desabilitado', ID do dispositivo '{device_id}', propriedades gêmeas iniciais '{"location":{"region":"US"}}', tags gêmeas iniciais '{"version":"1"}' e informações do dispositivo '{"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}
Crie um registro 'MyEnrollment' com o tipo de atestado 'tpm' no Serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' no grupo de recursos '{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
Crie um registro 'MyEnrollment' com o tipo de atestado 'symmetrickey' no serviço Azure IoT Device Provisioning '{dps_name}' no grupo de recursos '{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}
Crie um registro 'MyEnrollment' com reprovisionamento no serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' no grupo de recursos '{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
Crie um registro 'MyEnrollment' com política de alocação estática no serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' no grupo de recursos '{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}
Crie uma inscrição “MyEnrollment” com uma política de alocação de hash e vários hubs no serviço de Aprovisionamento de dispositivos “{dps_name}” da Internet das Coisas do Azure no grupo de recursos “{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}
Crie um registro 'MyEnrollment' com política de alocação personalizada,
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}
Parâmetros Obrigatórios
Mecanismo de atestado usado para autenticação no DPS.
ID de inscrição de dispositivo individual.
Parâmetros Opcionais
Tipo de política de alocação para determinar como um dispositivo é atribuído a um Hub IoT. Se não for fornecida, a política de alocação será o padrão da política de alocação atual definida para a instância do Serviço de Provisionamento de Dispositivo.
A versão da API dos tipos de serviço de provisionamento enviados na solicitação de alocação personalizada. Versão mínima suportada: 2018-09-01-preview.
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 de 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 iotdps-data-auth-type={auth-type-value}
.
O caminho para o arquivo que contém o certificado primário. Obrigatório ao escolher x509 como tipo de atestado e o caminho do certificado secundário não é fornecido.
ID do dispositivo registrado no Hub IoT.
Informações opcionais do dispositivo.
Nome ou nome de host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
Sinalizador que indica a ativação da borda.
Chave de endosso TPM para um dispositivo TPM. Ao escolher tpm como tipo de atestado, a chave de endosso é necessária.
O argumento 'iot_hub_host_name' foi preterido e será removido em uma versão futura. Use '--iot-hubs' em vez disso.
Nome do host do Hub IoT de destino. O padrão da política de alocação é estático se esse parâmetro for fornecido.
Nome do host do Hub IoT de destino associado à política de alocação. Use uma lista separada por espaço para vários Hubs IoT.
Propriedades gêmeas iniciais do dispositivo.
Tags gêmeas iniciais do dispositivo.
Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.
A chave de acesso compartilhada simétrica primária armazenada no formato base64.
Habilite ou desabilite a entrada de inscrição.
Política para determinar como os dados do dispositivo devem ser tratados no reprovisionamento para um Hub IoT diferente.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O caminho para o arquivo que contém o certificado secundário. Obrigatório ao escolher x509 como tipo de atestado e o caminho do certificado primário não é fornecido.
A chave de acesso compartilhada simétrica secundária armazenada no formato base64.
A URL do webhook da Função do Azure usada para solicitações de alocação personalizadas.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az iot dps enrollment delete
Exclua um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
az iot dps enrollment delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Parâmetros Obrigatórios
ID de inscrição de dispositivo individual.
Parâmetros Opcionais
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 de 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 iotdps-data-auth-type={auth-type-value}
.
Nome ou nome de host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
Etag ou entity tag correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.
Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az iot dps enrollment list
Liste inscrições de dispositivos individuais em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
az iot dps enrollment list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
Parâmetros Opcionais
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 de 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 iotdps-data-auth-type={auth-type-value}
.
Nome ou nome de host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Número máximo de elementos a devolver. Use -1 para ilimitado.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az iot dps enrollment show
Obtenha detalhes de registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
az iot dps enrollment show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]
Exemplos
Utilização básica
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Incluir informações completas de atestado nos resultados para um registro de chave simétrica
az iot dps enrollment show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Parâmetros Obrigatórios
ID de inscrição de dispositivo individual.
Parâmetros Opcionais
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 de 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 iotdps-data-auth-type={auth-type-value}
.
Nome ou nome de host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
Inclua chaves de atestado e informações nos resultados da inscrição.
Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az iot dps enrollment update
Atualize um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
Forneça o formato do certificado usando a codificação ASCII Base64 e o certificado deve ter segmentos BEGIN e END correspondentes, por exemplo: comece com '-----BEGIN CERTIFICATE-----' e termine com '-----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]
[--hn]
[--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]
Exemplos
Atualize o registro '{enrollment_id}' com um novo certificado x509 no Serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' no grupo de recursos '{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=
Atualizar o registro '{enrollment_id}' com uma nova chave de endosso no Serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' no grupo de recursos '{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=
Atualize o registro '{enrollment_id}' com uma nova chave primária no Serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' no grupo de recursos '{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=
Atualizar o registro '{enrollment_id}' com um novo tipo de reprovisionamento no Serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' no grupo de recursos '{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=
Atualize o registro '{enrollment_id}' com uma nova política de alocação no Serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' no grupo de recursos '{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}
Atualize o registro '{enrollment_id}' no Serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name}' com propriedades gêmeas iniciais '{"location":{"region":"USA"}}', tags gêmeas iniciais '{"version":"2"}' e informações do dispositivo '{"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'}"
Parâmetros Obrigatórios
ID de inscrição de dispositivo individual.
Parâmetros Opcionais
Tipo de política de alocação para determinar como um dispositivo é atribuído a um Hub IoT. Se não for fornecida, a política de alocação será o padrão da política de alocação atual definida para a instância do Serviço de Provisionamento de Dispositivo.
A versão da API dos tipos de serviço de provisionamento enviados na solicitação de alocação personalizada. Versão mínima suportada: 2018-09-01-preview.
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 de 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 iotdps-data-auth-type={auth-type-value}
.
O caminho para o arquivo que contém o certificado primário.
ID do dispositivo registrado no Hub IoT.
Informações opcionais do dispositivo.
Nome ou nome de host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
Sinalizador que indica a ativação da borda.
Chave de endosso TPM para um dispositivo TPM.
Etag ou entity tag correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.
O argumento 'iot_hub_host_name' foi preterido e será removido em uma versão futura. Use '--iot-hubs' em vez disso.
Nome do host do Hub IoT de destino. O padrão da política de alocação é estático se esse parâmetro for fornecido.
Nome do host do Hub IoT de destino associado à política de alocação. Use uma lista separada por espaço para vários Hubs IoT.
Propriedades gêmeas iniciais do dispositivo.
Tags gêmeas iniciais do dispositivo.
Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.
A chave de acesso compartilhada simétrica primária armazenada no formato base64.
Habilite ou desabilite a entrada de inscrição.
Sinalizar para remover o certificado primário atual.
Sinalizador para remover o certificado secundário atual.
Política para determinar como os dados do dispositivo devem ser tratados no reprovisionamento para um Hub IoT diferente.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O caminho para o arquivo que contém o certificado secundário.
A chave de acesso compartilhada simétrica secundária armazenada no formato base64.
A URL do webhook da Função do Azure usada para solicitações de alocação personalizadas.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.