az iot dps enrollment

Observação

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

Gerenciar registros de dispositivo individuais em um Hub IoT do Azure Serviço de Provisionamento de Dispositivos.

Comandos

az iot dps enrollment create

Crie um registro de dispositivo individual em um Hub IoT do Azure Serviço de Provisionamento de Dispositivos.

az iot dps enrollment delete

Exclua um registro de dispositivo individual em um Hub IoT do Azure Serviço de Provisionamento de Dispositivos.

az iot dps enrollment list

Listar registros individuais de dispositivo em um serviço de provisionamento de dispositivos Hub IoT do Azure.

az iot dps enrollment registration

Gerenciar registros de dispositivo do lado do serviço para um registro individual em um serviço de provisionamento de dispositivos Hub IoT do Azure.

az iot dps enrollment registration delete

Exclua um registro de dispositivo para um registro individual em um serviço de provisionamento de dispositivo Hub IoT do Azure.

az iot dps enrollment registration show

Obtenha um registro de dispositivo para um registro individual em um serviço de provisionamento de dispositivo Hub IoT do Azure.

az iot dps enrollment show

Obtenha detalhes de registro de dispositivo individual em um serviço de provisionamento de dispositivos Hub IoT do Azure.

az iot dps enrollment update

Atualize um registro de dispositivo individual em um Hub IoT do Azure Serviço de Provisionamento de Dispositivos.

az iot dps enrollment create

Crie um registro de dispositivo individual em um Hub IoT do Azure Serviço de Provisionamento de Dispositivos.

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 Dispositivos IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name}' com o status de provisionamento 'desabilitado', ID do dispositivo '{device_id}', propriedades iniciais do gêmeo '{"location":{"region":"US"}}', marcas 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 Dispositivos 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 de Provisionamento de Dispositivos 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 symmetrickey --primary-key {primary_key} --secondary-key {secondary_key}

Crie um registro 'MyEnrollment' com reprovisionamento no serviço de Provisionamento de Dispositivos 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 Dispositivos 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 um registro 'MyEnrollment' com política de alocação de hash e vários hubs no serviço de Provisionamento de Dispositivos 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 hashed --endorsement-key 14963E8F3BA5B3984110B3C1CA8E8B89 --iot-hubs "{iot_hub_host_name1} {iot_hub_host_name2}"

Criar 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 Exigidos

--at --attestation-type

Mecanismo de atestado usado para autenticação no DPS.

valores aceitos: symmetricKey, tpm, x509
--eid --enrollment-id

ID de registro de dispositivo individual.

Parâmetros Opcionais

--allocation-policy --ap

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 conjunto padrão da política de alocação atual para a instância do Serviço de Provisionamento de Dispositivos.

valores aceitos: custom, geoLatency, hashed, static
--api-version --av

A versão da API dos tipos de serviço de provisionamento enviados na solicitação de alocação personalizada. Versão mínima com suporte: 2018-09-01-preview.

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão de Azure AD atual. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type=<auth-type-value>.

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

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.

--device-id -d

ID do dispositivo registrada no Hub IoT.

--device-information --info

Informações opcionais do dispositivo.

--dps-name -n

Nome do serviço de provisionamento de dispositivos Hub IoT do Azure. Obrigatório se --login não for fornecido.

--edge-enabled --ee

Sinalizador que indica a habilitação de borda.

valores aceitos: false, true
--ek --endorsement-key

Chave de endosso do TPM para um dispositivo TPM. Ao escolher tpm como tipo de atestado, a chave de endosso é necessária.

--hn --iot-hub-host-name

Nome do host do Hub IoT de destino. A política de alocação será padrão para estática se esse parâmetro for fornecido.

--ih --iot-hubs

O nome do host do Hub IoT de destino associado à política de alocação. Use a lista separada por espaço para vários Hubs IoT.

--initial-twin-properties --props

Propriedades iniciais do dispositivo gêmeo.

--initial-twin-tags --tags

Marcas de gêmeos do dispositivo inicial.

--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 de 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. Obrigatório se --dps-name não for fornecido.

--pk --primary-key

A chave de acesso compartilhado simétrica primária armazenada no formato base64.

--provisioning-status --ps

Habilitar ou desabilitar a entrada de registro.

valores aceitos: disabled, enabled
--reprovision-policy --rp

Política para determinar como os dados do dispositivo devem ser tratados no reprovisionamento para um Hub IoT diferente.

valores aceitos: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

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

--scp --secondary-certificate-path

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.

--secondary-key --sk

A chave de acesso compartilhado simétrica secundária armazenada no formato base64.

--webhook-url --wh

A URL de webhook do Azure Function usada para solicitações de alocação personalizadas.

az iot dps enrollment delete

Exclua um registro de dispositivo individual em um Hub IoT do Azure Serviço de Provisionamento de Dispositivos.

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

Parâmetros Exigidos

--eid --enrollment-id

ID de registro de dispositivo individual.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão de Azure AD atual. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type=<auth-type-value>.

valores aceitos: key, login
valor padrão: key
--dps-name -n

Nome do serviço de provisionamento de dispositivos Hub IoT do Azure. Obrigatório se --login não for fornecido.

--etag -e

Marca de etag ou entidade correspondente ao último estado do recurso. Se nenhuma etag for fornecida, o valor '*' será usado.

--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 de 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. Obrigatório se --dps-name não for fornecido.

--resource-group -g

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

az iot dps enrollment list

Listar registros individuais de dispositivo em um serviço de provisionamento de dispositivos Hub IoT do Azure.

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

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão de Azure AD atual. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type=<auth-type-value>.

valores aceitos: key, login
valor padrão: key
--dps-name -n

Nome do serviço de provisionamento de dispositivos Hub IoT do Azure. Obrigatório se --login não for fornecido.

--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 de 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. Obrigatório se --dps-name não for fornecido.

--resource-group -g

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

--top

Número máximo de elementos a serem retornados. Use -1 para ilimitado.

az iot dps enrollment show

Obtenha detalhes de registro de dispositivo individuais em um serviço de provisionamento de dispositivo Hub IoT do Azure.

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

Exemplos

Uso básico

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

Incluir informações completas de atestado em 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 Exigidos

--eid --enrollment-id

ID de registro de dispositivo individual.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão de Azure AD atual. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type=<auth-type-value>.

valores aceitos: key, login
valor padrão: key
--dps-name -n

Nome do serviço de provisionamento de dispositivos Hub IoT do Azure. Obrigatório se --login não for fornecido.

--keys --show-keys

Inclua chaves de atestado e informações nos resultados do registro.

valores aceitos: false, true
--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 de 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. Obrigatório se --dps-name não for fornecido.

--resource-group -g

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

az iot dps enrollment update

Atualize um registro de dispositivo individual em um Hub IoT do Azure Serviço de Provisionamento de Dispositivos.

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 Dispositivos 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=

Atualize o registro '{enrollment_id}' com uma nova chave de endosso no Serviço de Provisionamento de Dispositivos 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 Dispositivos 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=

Atualize o registro '{enrollment_id}' com um novo tipo de reprovisionamento no Serviço de Provisionamento de Dispositivos 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 Dispositivos 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 Dispositivos IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name}' com as propriedades gêmeas iniciais '{"location":{"region":"USA"}}', as marcas gêmeas iniciais '{"version":"2"}' e as 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 Exigidos

--eid --enrollment-id

ID de registro de dispositivo individual.

Parâmetros Opcionais

--allocation-policy --ap

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 conjunto padrão da política de alocação atual para a instância do Serviço de Provisionamento de Dispositivos.

valores aceitos: custom, geoLatency, hashed, static
--api-version --av

A versão da API dos tipos de serviço de provisionamento enviados na solicitação de alocação personalizada. Versão mínima com suporte: 2018-09-01-preview.

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão Azure AD atual. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type=<auth-type-value>.

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

O caminho para o arquivo que contém o certificado primário.

--device-id -d

ID do dispositivo registrada no Hub IoT.

--device-information --info

Informações opcionais do dispositivo.

--dps-name -n

Nome do Hub IoT do Azure Serviço de Provisionamento de Dispositivos. Obrigatório se --login não for fornecido.

--edge-enabled --ee

Sinalizador indicando habilitação de borda.

valores aceitos: false, true
--ek --endorsement-key

Chave de endosso do TPM para um dispositivo TPM.

--etag -e

Marca de etag ou entidade correspondente ao último estado do recurso. Se nenhuma etag for fornecida, o valor '*' será usado.

--hn --iot-hub-host-name

Nome do host do Hub IoT de destino. A política de alocação padrão será estática se esse parâmetro for fornecido.

--ih --iot-hubs

O nome do host do destino Hub IoT associado à política de alocação. Use a lista separada por espaço para vários Hubs IoT.

--initial-twin-properties --props

Propriedades do dispositivo gêmeo inicial.

--initial-twin-tags --tags

Marcas de dispositivo gêmeo iniciais.

--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. Obrigatório se --dps-name não for fornecido.

--pk --primary-key

A chave de acesso compartilhado simétrica primária armazenada no formato base64.

--provisioning-status --ps

Habilitar ou desabilitar a entrada de registro.

valores aceitos: disabled, enabled
--rc --remove-certificate

Sinalizador para remover o certificado primário atual.

valores aceitos: false, true
--remove-secondary-certificate --rsc

Sinalizador para remover o certificado secundário atual.

valores aceitos: false, true
--reprovision-policy --rp

Política para determinar como os dados do dispositivo devem ser tratados no provisionamento novamente para um Hub IoT diferente.

valores aceitos: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

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

--scp --secondary-certificate-path

O caminho para o arquivo que contém o certificado secundário.

--secondary-key --sk

A chave de acesso compartilhado simétrica secundária armazenada no formato base64.

--webhook-url --wh

A URL de webhook do Azure Function usada para solicitações de alocação personalizadas.