az iot hub device-identity

Comandos

Nome	Description	Tipo	Status
az iot hub device-identity children	Gerenciar relações de dispositivos filhos para dispositivos IoT Edge.	Extension	GA
az iot hub device-identity children add	Adicione dispositivos como filhos a um dispositivo de borda de destino.	Extension	GA
az iot hub device-identity children list	Gera a coleção de dispositivos filho atribuídos.	Extension	GA
az iot hub device-identity children remove	Remova dispositivos filhos de um dispositivo de borda de destino.	Extension	GA
az iot hub device-identity connection-string	Gerencie a cadeia de conexão do dispositivo IoT.	Extension	GA
az iot hub device-identity connection-string show	Mostre uma determinada cadeia de conexão do dispositivo Hub IoT.	Extension	GA
az iot hub device-identity create	Crie um dispositivo em um Hub IoT.	Extension	GA
az iot hub device-identity delete	Exclua um dispositivo do Hub IoT.	Extension	GA
az iot hub device-identity export	Exporte todas as identidades de dispositivo de um Hub IoT para um contêiner de blob do Armazenamento do Azure.	Extension	GA
az iot hub device-identity import	Importe identidades de dispositivo para um Hub IoT de um blob de contêiner de armazenamento.	Extension	GA
az iot hub device-identity list	Listar dispositivos em um Hub IoT.	Extension	GA
az iot hub device-identity parent	Gerencie relacionamentos de dispositivos pai para dispositivos IoT.	Extension	GA
az iot hub device-identity parent set	Defina o dispositivo pai de um dispositivo de destino.	Extension	GA
az iot hub device-identity parent show	Obtenha o dispositivo pai de um dispositivo de destino.	Extension	GA
az iot hub device-identity renew-key	Renove as chaves de destino de dispositivos do Hub IoT com autenticação sas.	Extension	GA
az iot hub device-identity show	Obtenha os detalhes de um dispositivo do Hub IoT.	Extension	GA
az iot hub device-identity update	Atualize um dispositivo do Hub IoT.	Extension	GA

az iot hub device-identity create --device-id
                                  [--am --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled --ee {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od --output-dir]
                                  [--pk --primary-key]
                                  [--primary-thumbprint --ptp]
                                  [--resource-group]
                                  [--secondary-key --sk]
                                  [--secondary-thumbprint --stp]
                                  [--sta --status {disabled, enabled}]
                                  [--star --status-reason]
                                  [--valid-days --vd]

Exemplos

Crie um dispositivo IoT habilitado para borda com autorização padrão (chave privada compartilhada).

az iot hub device-identity create -n {iothub_name} -d {device_id} --ee

Crie um dispositivo IoT com autorização de certificado autoassinado, gere um certificado válido por 10 dias e use sua impressão digital.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10

Crie um dispositivo IoT com autorização de certificado autoassinado, gere um certificado de expiração padrão (365 dias) e saída para o diretório de destino.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output

Crie um dispositivo IoT com autorização de certificado autoassinado e forneça explicitamente impressões digitais primárias e secundárias.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}

Crie um dispositivo IoT com autorização de AC raiz com o status e o motivo desabilitados.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'

Crie um dispositivo IoT com um escopo de dispositivo.

az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'

Parâmetros Exigidos

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 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.

Propriedade	Valor
Valor padrão:	False

az iot hub device-identity delete --device-id
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

Parâmetros Exigidos

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 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.

Propriedade	Valor
Valor padrão:	False

az iot hub device-identity export [--auth-type {key, login}]
                                  [--bc --blob-container]
                                  [--bcu --blob-container-uri]
                                  [--hub-name]
                                  [--identity]
                                  [--ik --include-keys {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa --storage-account]

Exemplos

Exporte todas as identidades do dispositivo para um contêiner de blob configurado e inclua chaves de dispositivo. O nome do contêiner de blob e o nome da conta de armazenamento são fornecidos como parâmetros para o comando.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}

Exporte todas as identidades do dispositivo para um contêiner de blob configurado e inclua chaves de dispositivo. Usa um exemplo de uri SAS embutido.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices?sv=2019-02-02&st=2020-08-23T22%3A35%3A00Z&se=2020-08-24T22%3A35%3A00Z&sr=c&sp=rwd&sig=VrmJ5sQtW3kLzYg10VqmALGCp4vtYKSLNjZDDJBSh9s%3D'

Exporte todas as identidades do dispositivo para um contêiner de blob configurado usando um caminho de arquivo que contém o uri sas.

az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}

Exporte todas as identidades do dispositivo para um contêiner de blob configurado e inclua chaves de dispositivo. Usa a identidade atribuída pelo sistema que tem funções de Colaborador de Dados de Blob de Armazenamento para a conta de armazenamento. O nome do contêiner de blob e o nome da conta de armazenamento são fornecidos como parâmetros para o comando.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]

Exporte todas as identidades do dispositivo para um contêiner de blob configurado e inclua chaves de dispositivo. Usa a identidade atribuída pelo sistema que tem funções de Colaborador de Dados de Blob de Armazenamento para a conta de armazenamento. O uri do contêiner de blob não precisa do token SAS de blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity [system]

Exporte todas as identidades do dispositivo para um contêiner de blob configurado e inclua chaves de dispositivo. Usa a identidade gerenciada atribuída pelo usuário que tem a função Colaborador de Dados do Blob de Armazenamento para a conta de armazenamento. O nome do contêiner de blob e o nome da conta de armazenamento são fornecidos como parâmetros para o comando.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}

Exporte todas as identidades do dispositivo para um contêiner de blob configurado e inclua chaves de dispositivo. Usa a identidade gerenciada atribuída pelo usuário que tem a função Colaborador de Dados do Blob de Armazenamento para a conta de armazenamento. O uri do contêiner de blob não precisa do token SAS de blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity {managed_identity_resource_id}

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 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.

Propriedade	Valor
Valor padrão:	False

az iot hub device-identity import [--auth-type {key, login}]
                                  [--hub-name]
                                  [--ibc --input-blob-container]
                                  [--ibcu --input-blob-container-uri]
                                  [--identity]
                                  [--input-storage-account --isa]
                                  [--login]
                                  [--obc --output-blob-container]
                                  [--obcu --output-blob-container-uri]
                                  [--osa --output-storage-account]
                                  [--resource-group]

Exemplos

Importe todas as identidades de dispositivo de um blob fornecendo parâmetros de comando para o contêiner de blob de entrada e a conta de armazenamento, bem como o contêiner de blob de saída e a conta de armazenamento.

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name}

Importe todas as identidades de dispositivo de um blob usando um uri de SAS embutido.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}

Importe todas as identidades de dispositivo de um blob usando um caminho de arquivo que contém o uri sas.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}

Importe todas as identidades de dispositivo de um blob usando a identidade atribuída pelo sistema que tem funções de Colaborador de Dados de Blob de Armazenamento para ambas as contas de armazenamento. O contêiner de blob de entrada e a conta de armazenamento, bem como o contêiner de blob de saída e a conta de armazenamento são fornecidos como parâmetros para o comando

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity [system]

Importe todas as identidades de dispositivo de um blob usando a identidade atribuída pelo sistema que tem funções de Colaborador de Dados de Blob de Armazenamento para ambas as contas de armazenamento. O uri do contêiner de blob não precisa do token SAS de blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity [system]

Importe todas as identidades de dispositivo de um blob usando a identidade gerenciada atribuída pelo usuário que tenha funções de Colaborador de Dados de Blob de Armazenamento para ambas as contas de armazenamento. O contêiner de blob de entrada e a conta de armazenamento, bem como o contêiner de blob de saída e a conta de armazenamento são fornecidos como parâmetros para o comando

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity {managed_identity_resource_id}

Importe todas as identidades de dispositivo de um blob usando a identidade gerenciada atribuída pelo usuário que tenha funções de Colaborador de Dados de Blob de Armazenamento para ambas as contas de armazenamento. O uri do contêiner de blob não precisa do token SAS de blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity {managed_identity_resource_id}

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 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.

Propriedade	Valor
Valor padrão:	False

az iot hub device-identity list [--auth-type {key, login}]
                                [--edge-enabled --ee {false, true}]
                                [--hub-name]
                                [--login]
                                [--resource-group]
                                [--top]

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 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.

Propriedade	Valor
Valor padrão:	False

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type --kt {both, primary, secondary, swap}
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--im --include-modules {false, true}]
                                     [--login]
                                     [--no-progress {false, true}]
                                     [--resource-group]

Exemplos

Renove a chave primária.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary

Troque as chaves primária e secundária.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap

Renove a chave secundária para dois dispositivos e seus módulos.

az iot hub device-identity renew-key -d {device_id} {device_id} -n {iothub_name} --kt secondary --include-modules

Renove as duas chaves para todos os dispositivos dentro do hub.

az iot hub device-identity renew-key -d * -n {iothub_name} --kt both

Parâmetros Exigidos

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 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.

Propriedade	Valor
Valor padrão:	False

az iot hub device-identity show --device-id
                                [--auth-type {key, login}]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parâmetros Exigidos

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 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.

Propriedade	Valor
Valor padrão:	False

az iot hub device-identity update --device-id
                                  [--add]
                                  [--am --auth-method {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled --ee {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk --primary-key]
                                  [--primary-thumbprint --ptp]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key --sk]
                                  [--secondary-thumbprint --stp]
                                  [--set]
                                  [--sta --status {disabled, enabled}]
                                  [--star --status-reason]

Exemplos

Ativar recursos de borda para o dispositivo

az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true

Ative os recursos de borda para o dispositivo usando o argumento de conveniência.

az iot hub device-identity update -d {device_id} -n {iothub_name} --ee

Desabilitar o status do dispositivo

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled

Desabilite o status do dispositivo usando o argumento de conveniência.

az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled

Em um comando

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true

Parâmetros Exigidos

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 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.

Propriedade	Valor
Valor padrão:	False