az iot hub device-identity

Observação

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.37.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot hub device-identity . Saiba mais sobre extensões.

Gerenciar dispositivos IoT.

Comandos

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

az iot hub device-identity create

Crie um dispositivo em um Hub IoT.

Ao usar o método de autenticação de shared_private_key (também conhecido como chaves simétricas), se nenhuma chave personalizada for fornecida, o serviço as gerará para o dispositivo.

Se um escopo de dispositivo for fornecido para um dispositivo de borda, o valor será convertido automaticamente em um escopo pai.

az iot hub device-identity create --device-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--sta {disabled, enabled}]
                                  [--star]
                                  [--valid-days]

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 autoassinada, gere um certificado de expiração padrão (365 dias) e envie 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 autoassinada 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 CA raiz com status e 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

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--am --auth-method

O método de autorização com o qual uma entidade deve ser criada.

valores aceitos: shared_private_key, x509_ca, x509_thumbprint

valor padrão: shared_private_key

--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 do 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 iothub-data-auth-type=<auth-type-value>o .

valores aceitos: key, login

valor padrão: key

--device-scope

O escopo do dispositivo. Para dispositivos de borda, isso é gerado automaticamente e imutável. Para dispositivos folha, defina isso para criar uma relação filho/pai.

--edge-enabled --ee

Sinalizador indicando habilitação de borda.

valores aceitos: false, true

valor padrão: False

--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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 --hub-name não for fornecido.

--od --output-dir

Gere um certificado autoassinado e use sua impressão digital. Saída para o diretório de destino especificado.

--pk --primary-key

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

--primary-thumbprint --ptp

Impressão digital de certificado auto-assinada para usar na impressão digital primária.

--resource-group -g

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

--secondary-key --sk

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

--secondary-thumbprint --stp

Impressão digital de certificado auto-assinada para usar para a impressão digital secundária.

--sta --status

Defina o status do dispositivo na criação.

valores aceitos: disabled, enabled

valor padrão: enabled

--star --status-reason

Descrição do status do dispositivo.

--valid-days --vd

Gere um certificado autoassinado e use sua impressão digital. Válido para o número especificado de dias. Padrão: 365.

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub device-identity delete

Exclua um dispositivo do Hub IoT.

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

Parâmetros Exigidos

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do 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 iothub-data-auth-type=<auth-type-value>o .

valores aceitos: key, login

valor padrão: key

--etag -e

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

--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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 --hub-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>.

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub device-identity export

Exporte todas as identidades de dispositivo de um Hub IoT para um contêiner de blob de Armazenamento do Azure.

O blob de saída que contém identidades de dispositivo é um arquivo de texto chamado 'devices.txt'.

Permissões necessárias - Política de acesso compartilhado do Hub IoT com suporte para 'Leitura do Registro e Gravação do Registro' OU uma entidade com a função 'Colaborador de Dados do Hub IoT' no Hub IoT.

Os parâmetros de nome da conta de armazenamento e nome do contêiner de blob só podem ser usados quando a conta de armazenamento estiver na mesma assinatura do Hub IoT de entrada. Para entrada de uri SAS de contêiner de blob embutido, revise as regras de entrada do seu ambiente.

Para obter mais informações, consulte https://aka.ms/iothub-device-exportimport.

az iot hub device-identity export [--auth-type {key, login}]
                                  [--bc]
                                  [--bcu]
                                  [--hub-name]
                                  [--identity]
                                  [--ik {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa]

Exemplos

Exporte todas as identidades de 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 de 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 de 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 de dispositivo para um contêiner de blob configurado e inclua chaves de dispositivo. Usa a identidade atribuída ao 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 de dispositivo para um contêiner de blob configurado e inclua chaves de dispositivo. Usa a identidade atribuída ao 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 de 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 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 {managed_identity_resource_id}

Exporte todas as identidades de 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 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 {managed_identity_resource_id}

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do 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 iothub-data-auth-type=<auth-type-value>o .

valores aceitos: key, login

valor padrão: key

--bc --blob-container

Esse contêiner de blob é usado para gerar o status do trabalho de importação de identidade do dispositivo e os resultados. O parâmetro é ignorado quando blob_container_uri é fornecido. O acesso de gravação, leitura e exclusão é necessário para esse contêiner de blob.

--bcu --blob-container-uri

URI de assinatura de acesso compartilhado de blob com acesso de gravação, leitura e exclusão a um contêiner de blob. Isso é usado para gerar o status do trabalho e os resultados. Nota: ao usar a autenticação baseada em identidade, um URI de https:// ainda é necessário - mas nenhum token SAS é necessário. A entrada para esse argumento pode ser embutida ou de um caminho de arquivo.

--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--identity

Tipo de identidade gerenciada para determinar se a identidade gerenciada atribuída ao sistema ou a identidade gerenciada atribuída ao usuário é usada. Para identidade gerenciada atribuída ao sistema, use [system]. Para a identidade gerenciada atribuída ao usuário, forneça a ID do recurso de identidade gerenciada atribuída ao usuário. Essa identidade requer funções de Colaborador de Dados de Blob de Armazenamento para a Conta de Armazenamento.

--ik --include-keys

Se definidas, as chaves serão exportadas normalmente. Caso contrário, as chaves serão definidas como null na saída de exportação.

valores aceitos: false, true

valor padrão: False

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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 --hub-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>.

--sa --storage-account

Nome da conta de Armazenamento do Azure que contém o contêiner de blob de saída. O parâmetro é ignorado quando blob_container_uri é fornecido. O acesso de gravação, leitura e exclusão é necessário.

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub device-identity import

Importe identidades de dispositivo para um Hub IoT de um blob de contêiner de armazenamento.

O arquivo de entrada esperado contendo identidades de dispositivo deve ser nomeado 'devices.txt'. O arquivo de log de saída 'importErrors.log' fica vazio quando a importação é bem-sucedida e contém logs de erro em caso de falha na importação.

Permissões necessárias - Política de acesso compartilhado do Hub IoT com suporte para 'Leitura do Registro e Gravação do Registro' OU uma entidade com a função 'Colaborador de Dados do Hub IoT' no Hub IoT.

Os parâmetros de nome da conta de armazenamento e nome do contêiner de blob só podem ser usados quando a conta de armazenamento estiver na mesma assinatura do Hub IoT de entrada. Para entrada de uri SAS de contêiner de blob embutido, revise as regras de entrada do seu ambiente.

Para obter mais informações, consulte https://aka.ms/iothub-device-exportimport.

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

Exemplos

Importe todas as identidades de dispositivo de um blob fornecendo parâmetros de comando para contêiner de blob de entrada e conta de armazenamento, bem como contêiner de blob de saída e 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 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 ao sistema 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 [system]

Importe todas as identidades de dispositivo de um blob usando a identidade atribuída ao sistema 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 [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

--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 do 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 iothub-data-auth-type=<auth-type-value>o .

valores aceitos: key, login

valor padrão: key

--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--ibc --input-blob-container

Esse contêiner de blob armazena o arquivo que define as operações a serem executadas no registro de identidade. O parâmetro é ignorado quando input_blob_container_uri é fornecido. O acesso de leitura é necessário para esse contêiner de blob.

--ibcu --input-blob-container-uri

URI de assinatura de acesso compartilhado de blob com acesso de leitura a um contêiner de blob. Esse blob contém as operações a serem executadas no registro de identidade. Nota: ao usar a autenticação baseada em identidade, um URI de https:// ainda é necessário - mas nenhum token SAS é necessário. A entrada para esse argumento pode ser embutida ou de um caminho de arquivo.

--identity

Tipo de identidade gerenciada para determinar se a identidade gerenciada atribuída ao sistema ou a identidade gerenciada atribuída ao usuário é usada. Para identidade gerenciada atribuída ao sistema, use [system]. Para a identidade gerenciada atribuída ao usuário, forneça a ID do recurso de identidade gerenciada atribuída ao usuário. Essa identidade requer uma função de Colaborador de Dados de Blob de Armazenamento para a Conta de Armazenamento de destino e uma função de Colaborador para o Hub IoT.

--input-storage-account --isa

Nome da conta de Armazenamento do Azure que contém o contêiner de blob de entrada. Só é necessário quando input_blob_container_uri não é fornecido. O acesso de leitura é necessário.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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 --hub-name não for fornecido.

--obc --output-blob-container

Esse contêiner de blob é usado para gerar o status do trabalho de importação de identidade do dispositivo e os resultados. Só é necessário quando input_blob_container_uri não é fornecido. O acesso de gravação é necessário para esse contêiner de blob.

--obcu --output-blob-container-uri

URI de assinatura de acesso compartilhado de blob com acesso de gravação a um contêiner de blob. Isso é usado para gerar o status do trabalho e os resultados. Nota: ao usar a autenticação baseada em identidade, um URI de https:// sem o token SAS ainda é necessário. A entrada para esse argumento pode ser embutida ou de um caminho de arquivo.

--osa --output-storage-account

Nome da conta de Armazenamento do Azure que contém o contêiner de blob de saída. O parâmetro é ignorado quando output_blob_container_uri é fornecido. O acesso de gravação é necessário.

--resource-group -g

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

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub device-identity list

Listar dispositivos em um Hub IoT.

Esse comando é um alias para az iot hub device-twin list, que é altamente recomendado sobre esse comando. No futuro, esse az iot hub device-identity list comando pode ser alterado ou preterido.

az iot hub device-identity list [--auth-type {key, login}]
                                [--edge-enabled {false, true}]
                                [--hub-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 atual do Azure AD. Se o tipo de autenticação for login e o nome do 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 iothub-data-auth-type=<auth-type-value>o .

valores aceitos: key, login

valor padrão: key

--edge-enabled --ee

Sinalizador indicando habilitação de borda.

valores aceitos: false, true

valor padrão: False

--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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 --hub-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.

valor padrão: 1000

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub device-identity renew-key

Renove as chaves de destino de um dispositivo do Hub IoT com autenticação sas.

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--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

Parâmetros Exigidos

--device-id -d

ID do dispositivo de destino.

--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--key-type --kt

Tipo de chave de destino a ser regenerado.

valores aceitos: primary, secondary, swap

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do 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 iothub-data-auth-type=<auth-type-value>o .

valores aceitos: key, login

valor padrão: key

--etag -e

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

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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 --hub-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>.

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub device-identity show

Obtenha os detalhes de um dispositivo do Hub IoT.

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

Parâmetros Exigidos

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome do 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 iothub-data-auth-type=<auth-type-value>o .

valores aceitos: key, login

valor padrão: key

--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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 --hub-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>.

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az iot hub device-identity update

Atualize um dispositivo do Hub IoT.

Use --set seguido de atribuições de propriedade para atualizar um dispositivo. Aproveite os parâmetros retornados de 'iot hub device-identity show'.

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

Exemplos

Ativar recursos de borda para 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

Desativar o status do dispositivo

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

Desative 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

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

valor padrão: []

--am --auth-method

O método de autorização com o qual uma entidade deve ser criada.

valores aceitos: shared_private_key, x509_ca, x509_thumbprint

--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 do 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 iothub-data-auth-type=<auth-type-value>o .

valores aceitos: key, login

valor padrão: key

--edge-enabled --ee

Sinalizador indicando habilitação de borda.

valores aceitos: false, true

--etag -e

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

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

valor padrão: False

--hub-name -n

Nome do Hub IoT ou nome do host. Obrigatório se --login não for fornecido.

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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 --hub-name não for fornecido.

--pk --primary-key

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

--primary-thumbprint --ptp

Impressão digital de certificado auto-assinada para usar na impressão digital primária.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

valor padrão: []

--resource-group -g

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

--secondary-key --sk

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

--secondary-thumbprint --stp

Impressão digital de certificado auto-assinada para usar para a impressão digital secundária.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>.

valor padrão: []

--sta --status

Defina o status do dispositivo na criação.

valores aceitos: disabled, enabled

--star --status-reason

Descrição do status do dispositivo.

Parâmetros Globais

--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc

valor padrão: json

--query

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

--subscription

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

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.