az iot dps enrollment

Note

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.67.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.	Extension	disponibilidade geral
az iot dps enrollment delete	Exclua um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.	Extension	disponibilidade geral
az iot dps enrollment list	Liste inscrições de dispositivos individuais em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.	Extension	disponibilidade geral
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.	Extension	disponibilidade geral
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.	Extension	disponibilidade geral
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.	Extension	disponibilidade geral
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.	Extension	disponibilidade geral
az iot dps enrollment update	Atualize um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.	Extension	disponibilidade geral

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 --attestation-type {symmetricKey, tpm, x509}
                             --eid --enrollment-id
                             [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                             [--api-version --av]
                             [--auth-type {key, login}]
                             [--certificate-path --cp]
                             [--cpn --credential-policy-name]
                             [--device-id]
                             [--device-information --info]
                             [--dps-name]
                             [--edge-enabled --ee {false, true}]
                             [--ek --endorsement-key]
                             [--ih --iot-hubs]
                             [--initial-twin-properties --props]
                             [--initial-twin-tags --tags]
                             [--login]
                             [--pk --primary-key]
                             [--provisioning-status --ps {disabled, enabled}]
                             [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp --secondary-certificate-path]
                             [--secondary-key --sk]
                             [--webhook-url --wh]

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-information "{'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 um registro 'MyEnrollment' com política de alocação em hash e vários hubs 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 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}

Crie um registro com uma Política de Credenciais de Namespace ADR personalizada especificada.

az iot dps enrollment create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --attestation-type symmetrickey --credential-policy-name {policy_name}

Parâmetros Obrigatórios

--at --attestation-type

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

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments
Valores aceites:	symmetricKey, tpm, x509

--eid --enrollment-id

ID de inscrição de dispositivo individual.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade	Valor
Grupo de parâmetros:	Allocation Policy Arguments
Valores aceites:	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 suportada: 2018-09-01-preview.

Propriedade	Valor
Grupo de parâmetros:	Allocation Policy Arguments

--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 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}.

Propriedade	Valor
Grupo de parâmetros:	Access Control Arguments
Default value:	key
Valores aceites:	key, login

--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.

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments

--cpn --credential-policy-name

Nome da Política de Credenciais de Namespace ADR.

Propriedade	Valor
Grupo de parâmetros:	ADR Credential Policy Arguments

--device-id -d

ID do dispositivo registrado no Hub IoT.

--device-information --info

Informações opcionais do dispositivo.

--dps-name -n

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.

Propriedade	Valor
Grupo de parâmetros:	Device Provisioning Service Identifier Arguments

--edge-enabled --ee

Sinalizador que indica a ativação da borda.

Propriedade	Valor
Default value:	False
Valores aceites:	false, true

--ek --endorsement-key

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

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments

--ih --iot-hubs

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.

Propriedade	Valor
Grupo de parâmetros:	Allocation Policy Arguments

--initial-twin-properties --props

Propriedades gêmeas iniciais do dispositivo.

--initial-twin-tags --tags

Tags gêmeas iniciais do dispositivo.

--login -l

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.

Propriedade	Valor
Grupo de parâmetros:	Device Provisioning Service Identifier Arguments

--pk --primary-key

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

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments

--provisioning-status --ps

Habilite ou desabilite a entrada de inscrição.

Propriedade	Valor
Valores aceites:	disabled, enabled

--reprovision-policy --rp

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

Propriedade	Valor
Valores aceites:	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.

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments

--secondary-key --sk

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

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments

--webhook-url --wh

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

Propriedade	Valor
Grupo de parâmetros:	Allocation Policy Arguments

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

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 --enrollment-id
                             [--auth-type {key, login}]
                             [--dps-name]
                             [--etag]
                             [--login]
                             [--resource-group]

Parâmetros Obrigatórios

--eid --enrollment-id

ID de inscrição de dispositivo individual.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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 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}.

Propriedade	Valor
Grupo de parâmetros:	Access Control Arguments
Default value:	key
Valores aceites:	key, login

--dps-name -n

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.

Propriedade	Valor
Grupo de parâmetros:	Device Provisioning Service Identifier Arguments

--etag -e

Etag ou entity tag correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.

--login -l

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.

Propriedade	Valor
Grupo de parâmetros:	Device Provisioning Service Identifier Arguments

--resource-group -g

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

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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 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}.

Propriedade	Valor
Grupo de parâmetros:	Access Control Arguments
Default value:	key
Valores aceites:	key, login

--dps-name -n

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.

Propriedade	Valor
Grupo de parâmetros:	Device Provisioning Service Identifier Arguments

--login -l

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.

Propriedade	Valor
Grupo de parâmetros:	Device Provisioning Service Identifier Arguments

--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 devolver. Use -1 para ilimitado.

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

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 --enrollment-id
                           [--auth-type {key, login}]
                           [--dps-name]
                           [--keys --show-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

--eid --enrollment-id

ID de inscrição de dispositivo individual.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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 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}.

Propriedade	Valor
Grupo de parâmetros:	Access Control Arguments
Default value:	key
Valores aceites:	key, login

--dps-name -n

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.

Propriedade	Valor
Grupo de parâmetros:	Device Provisioning Service Identifier Arguments

--keys --show-keys

Inclua chaves de atestado e informações nos resultados da inscrição.

Propriedade	Valor
Valores aceites:	false, true

--login -l

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.

Propriedade	Valor
Grupo de parâmetros:	Device Provisioning Service Identifier Arguments

--resource-group -g

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

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

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 --enrollment-id
                             [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                             [--api-version --av]
                             [--auth-type {key, login}]
                             [--certificate-path --cp]
                             [--cpn --credential-policy-name]
                             [--device-id]
                             [--device-information --info]
                             [--dps-name]
                             [--edge-enabled --ee {false, true}]
                             [--ek --endorsement-key]
                             [--etag]
                             [--ih --iot-hubs]
                             [--initial-twin-properties --props]
                             [--initial-twin-tags --tags]
                             [--login]
                             [--pk --primary-key]
                             [--provisioning-status --ps {disabled, enabled}]
                             [--rc --remove-certificate {false, true}]
                             [--remove-secondary-certificate --rsc {false, true}]
                             [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                             [--resource-group]
                             [--scp --secondary-certificate-path]
                             [--secondary-key --sk]
                             [--webhook-url --wh]

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-information "{'color':'red'}"

Atualize o registro '{enrollment_id}' no Serviço de Provisionamento de Dispositivo IoT do Azure '{dps_name}' para usar uma Política de Credenciais de Namespace ADR personalizada.

az iot dps enrollment update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --credential-policy-name {my_policy}

Parâmetros Obrigatórios

--eid --enrollment-id

ID de inscrição de dispositivo individual.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade	Valor
Grupo de parâmetros:	Allocation Policy Arguments
Valores aceites:	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 suportada: 2018-09-01-preview.

Propriedade	Valor
Grupo de parâmetros:	Allocation Policy Arguments

--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 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}.

Propriedade	Valor
Grupo de parâmetros:	Access Control Arguments
Default value:	key
Valores aceites:	key, login

--certificate-path --cp

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

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments

--cpn --credential-policy-name

Nome da Política de Credenciais de Namespace ADR.

Propriedade	Valor
Grupo de parâmetros:	ADR Credential Policy Arguments

--device-id -d

ID do dispositivo registrado no Hub IoT.

--device-information --info

Informações opcionais do dispositivo.

--dps-name -n

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.

Propriedade	Valor
Grupo de parâmetros:	Device Provisioning Service Identifier Arguments

--edge-enabled --ee

Sinalizador que indica a ativação da borda.

Propriedade	Valor
Valores aceites:	false, true

--ek --endorsement-key

Chave de endosso TPM para um dispositivo TPM.

--etag -e

Etag ou entity tag correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.

--ih --iot-hubs

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.

Propriedade	Valor
Grupo de parâmetros:	Allocation Policy Arguments

--initial-twin-properties --props

Propriedades gêmeas iniciais do dispositivo.

--initial-twin-tags --tags

Tags gêmeas iniciais do dispositivo.

--login -l

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.

Propriedade	Valor
Grupo de parâmetros:	Device Provisioning Service Identifier Arguments

--pk --primary-key

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

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments

--provisioning-status --ps

Habilite ou desabilite a entrada de inscrição.

Propriedade	Valor
Valores aceites:	disabled, enabled

--rc --remove-certificate

Sinalizar para remover o certificado primário atual.

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments
Valores aceites:	false, true

--remove-secondary-certificate --rsc

Sinalizador para remover o certificado secundário atual.

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments
Valores aceites:	false, true

--reprovision-policy --rp

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

Propriedade	Valor
Valores aceites:	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.

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments

--secondary-key --sk

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

Propriedade	Valor
Grupo de parâmetros:	Authentication Arguments

--webhook-url --wh

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

Propriedade	Valor
Grupo de parâmetros:	Allocation Policy Arguments

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False