az iot hub device-identity

Nota

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

Gerir dispositivos IoT.

Comandos

az iot hub device-identity children	Gerir relações de dispositivos subordinados para dispositivos IoT edge.
az iot hub device-identity children add	Adicione dispositivos como subordinados a um dispositivo edge de destino.
az iot hub device-identity children list	Produz a coleção de dispositivos subordinados atribuídos.
az iot hub device-identity children remove	Remova dispositivos subordinados de um dispositivo edge de destino.
az iot hub device-identity connection-string	Gerir a cadeia de ligação do dispositivo IoT.
az iot hub device-identity connection-string show	Mostrar uma determinada cadeia de ligação de dispositivo Hub IoT.
az iot hub device-identity create	Crie um dispositivo num Hub IoT.
az iot hub device-identity delete	Elimine um dispositivo Hub IoT.
az iot hub device-identity export	Exporte todas as identidades de dispositivos de um Hub IoT para um contentor de blobs do Armazenamento do Azure.
az iot hub device-identity import	Importar identidades de dispositivos para um Hub IoT a partir de um blob de contentor de armazenamento.
az iot hub device-identity list	Listar dispositivos numa Hub IoT.
az iot hub device-identity parent	Gerir relações de dispositivos principais para dispositivos IoT.
az iot hub device-identity parent set	Defina o dispositivo principal de um dispositivo de destino.
az iot hub device-identity parent show	Obtenha o dispositivo principal de um dispositivo de destino.
az iot hub device-identity renew-key	Renovar chaves de destino de um dispositivo Hub IoT com autenticação sas.
az iot hub device-identity show	Obtenha os detalhes de um dispositivo Hub IoT.
az iot hub device-identity update	Atualizar um dispositivo Hub IoT.

az iot hub device-identity create

Crie um dispositivo num Hub IoT.

Ao utilizar o método de autenticação de shared_private_key (também conhecido como chaves simétricas), se não forem fornecidas chaves personalizadas, o serviço irá gerá-las para o dispositivo.

Se for fornecido um âmbito de dispositivo para um dispositivo edge, o valor será automaticamente convertido num âmbito principal.

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 preparado para edge com autorização predefinida (chave privada partilhada).

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 durante 10 dias e, em seguida, utilize o thumbprint.

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 predefinida (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 thumbprints primários e secundários.

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 de raiz com o estado e o motivo desativados.

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 âmbito de dispositivo.

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

Parâmetros Obrigatórios

--device-id -d

ID do Dispositivo de Destino.

Parâmetros Opcionais

--am --auth-method

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

valores aceites: shared_private_key, x509_ca, x509_thumbprint

valor predefinido: shared_private_key

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão de Azure AD atual. Pode configurar a predefinição com az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login

valor predefinido: key

--device-scope

O âmbito do dispositivo. Para dispositivos edge, isto é gerado automaticamente e imutável. Para dispositivos de folha, defina esta opção para criar uma relação subordinada/principal.

--edge-enabled --ee

Sinalizador que indica a ativação do limite.

valores aceites: false, true

valor predefinido: False

--hub-name -n

Hub IoT nome. Necessário se --login não for fornecido.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--od --output-dir

Gere o certificado autoassinado e utilize o thumbprint. Saída para o diretório de destino especificado.

--pk --primary-key

A chave de acesso partilhado simétrica principal armazenada no formato base64.

--primary-thumbprint --ptp

Thumbprint de certificado autoassinado a utilizar para o thumbprint primário.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido com az configure --defaults group=<name>.

--secondary-key --sk

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

--secondary-thumbprint --stp

Thumbprint de certificado autoassinado a utilizar para o thumbprint secundário.

--sta --status

Defina o estado do dispositivo após a criação.

valores aceites: disabled, enabled

valor predefinido: enabled

--star --status-reason

Descrição do estado do dispositivo.

--valid-days --vd

Gere o certificado autoassinado e utilize o thumbprint. Válido para o número especificado de dias. Predefinição: 365.

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.

az iot hub device-identity delete

Elimine um dispositivo Hub IoT.

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

Parâmetros Obrigatórios

--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 utilizar a sessão de Azure AD atual. Pode configurar a predefinição com az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login

valor predefinido: key

--etag -e

Etag ou etiqueta de entidade correspondente ao último estado do recurso. Se não for fornecido nenhum etag, é utilizado o valor '*'.

--hub-name -n

Hub IoT nome. Necessário se --login não for fornecido.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido com az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.

az iot hub device-identity export

Exporte todas as identidades de dispositivos de um Hub IoT para um contentor de blobs do Armazenamento do Azure.

O blob de saída que contém identidades de dispositivo é um ficheiro de texto com o nome "devices.txt".

Permissões necessárias – Hub IoT política de acesso partilhado que suporte "Escrita do Registo de Leitura & do Registo" ou um principal com a função "Contribuidor de Dados Hub IoT" no Hub IoT.

O nome da conta de armazenamento e os parâmetros do nome do contentor de blobs só podem ser utilizados quando a conta de armazenamento estiver na mesma subscrição que a entrada Hub IoT. Para obter a entrada uri sas do contentor de blobs inline, reveja 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 do dispositivo para um contentor de blobs configurado e inclua chaves de dispositivo. O nome do contentor de blobs 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 contentor de blobs configurado e inclua chaves de dispositivo. Utiliza um exemplo de uri de SAS inline.

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 contentor de blobs configurado com um caminho de ficheiro que contenha o uri de SAS.

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

Exporte todas as identidades do dispositivo para um contentor de blobs configurado e inclua chaves de dispositivo. Utiliza a identidade atribuída pelo sistema que tem funções de Contribuidor de Dados de Blobs de Armazenamento para a conta de armazenamento. O nome do contentor de blobs 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 contentor de blobs configurado e inclua chaves de dispositivo. Utiliza a identidade atribuída pelo sistema que tem funções de Contribuidor de Dados de Blobs de Armazenamento para a conta de armazenamento. O uri do contentor de blobs não precisa do token de SAS do 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 contentor de blobs configurado e inclua chaves de dispositivo. Utiliza a identidade gerida atribuída pelo utilizador que tem a função Contribuidor de Dados do Blob de Armazenamento para a conta de armazenamento. O nome do contentor de blobs 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 contentor de blobs configurado e inclua chaves de dispositivo. Utiliza a identidade gerida atribuída pelo utilizador que tem a função Contribuidor de Dados do Blob de Armazenamento para a conta de armazenamento. O uri do contentor de blobs não precisa do token de SAS do 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 utilizar a sessão de Azure AD atual. Pode configurar a predefinição com az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login

valor predefinido: key

--bc --blob-container

Este contentor de blobs é utilizado para produzir o estado da tarefa de importação de identidade do dispositivo e os resultados. O parâmetro é ignorado quando é fornecido blob_container_uri. O acesso de escrita, leitura e eliminação é necessário para este contentor de blobs.

--bcu --blob-container-uri

URI de Assinatura de Acesso Partilhado de Blobs com acesso de escrita, leitura e eliminação a um contentor de blobs. Isto é utilizado para produzir o estado da tarefa e os resultados. Nota: ao utilizar a autenticação baseada em identidade, ainda é necessário um URI de https://, mas não é necessário nenhum token de SAS. A entrada para este argumento pode ser inline ou a partir de um caminho de ficheiro.

--hub-name -n

Hub IoT nome. Necessário se --login não for fornecido.

--identity

Tipo de identidade gerida para determinar se é utilizada a identidade gerida atribuída pelo sistema ou a identidade gerida atribuída pelo utilizador. Para a identidade gerida atribuída pelo sistema, utilize [sistema]. Para a identidade gerida atribuída pelo utilizador, forneça o ID de recurso de identidade gerida atribuído pelo utilizador. Esta identidade requer funções de Contribuidor de Dados de Blobs de Armazenamento para a Conta de Armazenamento.

--ik --include-keys

Se estiver definido, as chaves são exportadas normalmente. Caso contrário, as chaves são definidas como nulas na saída de exportação.

valores aceites: false, true

valor predefinido: False

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido com az configure --defaults group=<name>.

--sa --storage-account

Nome da conta de Armazenamento do Azure que contém o contentor de blobs de saída. O parâmetro é ignorado quando é fornecido blob_container_uri. O acesso de escrita, leitura e eliminação é necessário.

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.

az iot hub device-identity import

Importar identidades de dispositivos para um Hub IoT a partir de um blob de contentor de armazenamento.

O ficheiro de entrada esperado que contém identidades de dispositivo deve ter o nome "devices.txt". O ficheiro de registo de saída "importErrors.log" está vazio quando a importação é efetuada com êxito e contém registos de erros em caso de falha de importação.

Permissões necessárias – Hub IoT política de acesso partilhado que suporte "Escrita do Registo de Leitura & do Registo" ou um principal com a função "Contribuidor de Dados Hub IoT" no Hub IoT.

O nome da conta de armazenamento e os parâmetros do nome do contentor de blobs só podem ser utilizados quando a conta de armazenamento estiver na mesma subscrição que a entrada Hub IoT. Para obter a entrada uri sas do contentor de blobs inline, reveja 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 dispositivos de um blob ao fornecer parâmetros de comando para o contentor de blobs de entrada e conta de armazenamento, bem como o contentor de blobs 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 dispositivos de um blob com um uri de SAS inline.

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

Importe todas as identidades de dispositivos de um blob com um caminho de ficheiro que contenha o uri de 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 dispositivos de um blob com a identidade atribuída pelo sistema que tenha funções de Contribuidor de Dados de Blobs de Armazenamento para ambas as contas de armazenamento. O contentor de blobs de entrada e a conta de armazenamento, bem como o contentor de blobs 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 dispositivos de um blob com a identidade atribuída pelo sistema que tenha funções de Contribuidor de Dados de Blobs de Armazenamento para ambas as contas de armazenamento. O uri do contentor de blobs não precisa do token de SAS do 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 dispositivos de um blob com a identidade gerida atribuída pelo utilizador que tenha funções de Contribuidor de Dados de Blobs de Armazenamento para ambas as contas de armazenamento. O contentor de blobs de entrada e a conta de armazenamento, bem como o contentor de blobs 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 dispositivos de um blob com a identidade gerida atribuída pelo utilizador que tenha funções de Contribuidor de Dados de Blobs de Armazenamento para ambas as contas de armazenamento. O uri do contentor de blobs não precisa do token de SAS do 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 utilizar a sessão de Azure AD atual. Pode configurar a predefinição com az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login

valor predefinido: key

--hub-name -n

Hub IoT nome. Necessário se --login não for fornecido.

--ibc --input-blob-container

Este contentor de blobs armazena o ficheiro que define as operações a realizar no registo de identidade. O parâmetro é ignorado quando é fornecido input_blob_container_uri. O acesso de leitura é necessário para este contentor de blobs.

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

URI de Assinatura de Acesso Partilhado de Blobs com acesso de leitura a um contentor de blobs. Este blob contém as operações a realizar no registo de identidade. Nota: ao utilizar a autenticação baseada em identidade, ainda é necessário um URI de https://, mas não é necessário nenhum token de SAS. A entrada para este argumento pode ser inline ou a partir de um caminho de ficheiro.

--identity

Tipo de identidade gerida para determinar se é utilizada a identidade gerida atribuída pelo sistema ou a identidade gerida atribuída pelo utilizador. Para a identidade gerida atribuída pelo sistema, utilize [sistema]. Para a identidade gerida atribuída pelo utilizador, forneça o ID de recurso de identidade gerida atribuído pelo utilizador. Esta identidade requer uma função Contribuidor de Dados de Blobs de Armazenamento para a função de Contribuidor e Conta de Armazenamento de destino para o Hub IoT.

--input-storage-account --isa

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--obc --output-blob-container

Este contentor de blobs é utilizado para produzir o estado da tarefa de importação de identidade do dispositivo e os resultados. Só é necessário quando não é fornecido input_blob_container_uri. O acesso de escrita é necessário para este contentor de blobs.

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

URI de Assinatura de Acesso Partilhado de Blobs com acesso de escrita a um contentor de blobs. Isto é utilizado para exportar o estado da tarefa e os resultados. Nota: ao utilizar a autenticação baseada em identidade, continua a ser necessário um URI de https:// sem o token de SAS. A entrada para este argumento pode estar inline ou a partir de um caminho de ficheiro.

--osa --output-storage-account

Nome da conta de Armazenamento do Azure que contém o contentor de blobs de saída. O parâmetro é ignorado quando output_blob_container_uri é fornecido. É necessário acesso de escrita.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido com az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.

az iot hub device-identity list

Listar dispositivos num Hub IoT.

Este comando é um alias para az iot hub device-twin list, que é altamente recomendado através deste comando. No futuro, este 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 utilizar a sessão de Azure AD atual. Pode configurar a predefinição com az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login

valor predefinido: key

--edge-enabled --ee

Sinalizador que indica a ativação do limite.

valores aceites: false, true

valor predefinido: False

--hub-name -n

Hub IoT nome. Necessário se --login não for fornecido.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido com az configure --defaults group=<name>.

--top

Número máximo de elementos a devolver. Utilize -1 para ilimitado.

valor predefinido: 1000

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.

az iot hub device-identity renew-key

Renove as chaves de destino de um dispositivo 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árias e secundárias.

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

Parâmetros Obrigatórios

--device-id -d

ID do Dispositivo de Destino.

--hub-name -n

Hub IoT nome. Necessário se --login não for fornecido.

--key-type --kt

Tipo de chave de destino a regenerar.

valores aceites: primary, secondary, swap

Parâmetros Opcionais

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão de Azure AD atual. Pode configurar a predefinição com az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login

valor predefinido: key

--etag -e

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido com az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.

az iot hub device-identity show

Obtenha os detalhes de um dispositivo Hub IoT.

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

Parâmetros Obrigatórios

--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 utilizar a sessão de Azure AD atual. Pode configurar a predefinição com az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login

valor predefinido: key

--hub-name -n

Hub IoT nome. Necessário se --login não for fornecido.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido com az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.

az iot hub device-identity update

Atualizar um dispositivo Hub IoT.

Utilize --set seguido de atribuições de propriedades para atualizar um dispositivo. Tire partido dos parâmetros devolvidos 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 as capacidades do Edge para o dispositivo

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

Ative as capacidades do edge para o dispositivo através do argumento de conveniência.

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

Desativar o estado do dispositivo

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

Desative o estado do dispositivo com o argumento de conveniência.

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

Num comando

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

Parâmetros Obrigatórios

--device-id -d

ID do Dispositivo de Destino.

Parâmetros Opcionais

--add

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

valor predefinido: []

--am --auth-method

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

valores aceites: shared_private_key, x509_ca, x509_thumbprint

--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou utilizar a sessão de Azure AD atual. Pode configurar a predefinição com az configure --defaults iothub-data-auth-type=<auth-type-value>.

valores aceites: key, login

valor predefinido: key

--edge-enabled --ee

Sinalizador que indica a ativação do limite.

valores aceites: false, true

--etag -e

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

--force-string

Ao utilizar "set" ou "add", preserve os literais de cadeia em vez de tentar converter em JSON.

valor predefinido: False

--hub-name -n

Hub IoT nome. Necessário se --login não for fornecido.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar a ação. Utilize para evitar o início de sessão através de "az login". Se for fornecida uma cadeia de ligação de entidade e um nome, a cadeia de ligação tem prioridade. Necessário se --hub-name não for fornecido.

--pk --primary-key

A chave de acesso partilhado simétrica principal armazenada no formato base64.

--primary-thumbprint --ptp

Thumbprint do certificado autoassinado a utilizar para o thumbprint principal.

--remove

Remover uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OR --remove propertyToRemove.

valor predefinido: []

--resource-group -g

o nome do grupo de recursos. Pode configurar o grupo predefinido com az configure --defaults group=<name>.

--secondary-key --sk

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

--secondary-thumbprint --stp

Thumbprint do certificado autoassinado a utilizar para o thumbprint secundário.

--set

Atualize um objeto ao especificar um caminho de propriedade e um valor a definir. Exemplo: --set property1.property2=.

valor predefinido: []

--sta --status

Defina o estado do dispositivo após a criação.

valores aceites: disabled, enabled

--star --status-reason

Descrição do estado do dispositivo.

Parâmetros de Globais

--debug

Aumente a verbosidade do registo para mostrar todos os registos 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.

--query

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

--subscription

o nome ou o ID da subscrição. Pode configurar a subscrição predefinida com az account set -s NAME_OR_ID.

--verbose

Aumentar a verbosidade do registo. Utilize --debug para registos de depuração completos.