az iot hub device-identity

Nota

Esta referência faz parte da extensão azure-iot para Azure CLI e requer a versão 2.17.1 ou superior. A extensão instala-se automaticamente na primeira vez que executar um comando de identidade de dispositivo az iot hub. Saiba mais sobre extensões.

Gerir dispositivos IoT.

Comandos

az iot hub device-identity children

Gerencie o dispositivo infantil do dispositivo IoT.

az iot hub device-identity children add

Adicione uma lista especificada de identificação do dispositivo separada do espaço como crianças de dispositivo de borda especificado.

az iot hub device-identity children list

Lista de saídas de dispositivos infantis atribuídos.

az iot hub device-identity children remove

Remova os dispositivos como crianças do dispositivo de borda especificado.

az iot hub device-identity connection-string

Gerencie a cadeia de ligação do dispositivo IoT.

az iot hub device-identity connection-string show

Mostre uma determinada cadeia de ligação do dispositivo IoT Hub.

az iot hub device-identity create

Crie um dispositivo num Hub IoT.

az iot hub device-identity delete

Elimine um dispositivo IoT Hub.

az iot hub device-identity export

Exporte todas as identidades do dispositivo de um Hub IoT para um recipiente de bolhas Azure Armazenamento. Para o recipiente blob inline ENTRADA SAS uri, por favor reveja as regras de entrada do seu ambiente.

az iot hub device-identity import

Importar identidades de dispositivos para um hub IoT de uma bolha. Para o recipiente blob inline ENTRADA SAS uri, por favor reveja as regras de entrada do seu ambiente.

az iot hub device-identity list

Listar dispositivos num hub IoT.

az iot hub device-identity parent

Gerencie o dispositivo-mãe do dispositivo IoT.

az iot hub device-identity parent set

Desa estale o dispositivo-mãe do dispositivo especificado.

az iot hub device-identity parent show

Obtenha o dispositivo principal do dispositivo especificado.

az iot hub device-identity renew-key

Renovar as teclas-alvo de um dispositivo IoT Hub com autenticação sas.

az iot hub device-identity show

Obtenha os detalhes de um dispositivo IoT Hub.

az iot hub device-identity update

Atualize um dispositivo IoT Hub.

az iot hub device-identity create

Crie um dispositivo num Hub IoT.

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

Exemplos

Crie um dispositivo IoT ativado por borda com autorização padrão (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 auto-assinada, gere um certificado válido por 10 dias e depois utilize a 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 auto-assinado, gere um certificado de expiração padrão (365 dias) e saída para 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 auto-assinado 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}

Criar um dispositivo IoT com autorização de CA raiz com estado e razão de desativado

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

Parâmetros Obrigatórios

--device-id -d

Dispositivo alvo.

Parâmetros Opcionais

--am --auth-method

O tipo 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 AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value> .

valores aceites: key, login
valor predefinido: key
--edge-enabled --ee

Sinalização indicando o habilitação da borda.

valores aceites: false, true
--hub-name -n

Nome IoT Hub.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos de realização de ação. Utilize para evitar o início de sessão através de "az login". Se tanto uma cadeia de ligação de entidade como o nome forem fornecidos, a cadeia de ligação tem prioridade.

--od --output-dir

Gere um certificado auto-assinado e use a sua impressão digital. Saída para diretório-alvo especificado.

--primary-thumbprint --ptp

Impressão digital de certificado auto-assinada explícita para usar para a chave primária.

--resource-group -g

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

--secondary-thumbprint --stp

Impressão digital de certificado auto-assinada explícita para usar para chave secundária.

--sta --status

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

valores aceites: disabled, enabled
valor predefinido: enabled
--star --status-reason

Descrição para o estado do dispositivo.

--valid-days --vd

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

az iot hub device-identity delete

Elimine um dispositivo IoT Hub.

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

Dispositivo alvo.

Parâmetros Opcionais

--auth-type

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

valores aceites: key, login
valor predefinido: key
--etag -e

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

--hub-name -n

Nome IoT Hub.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos de realização de ação. Utilize para evitar o início de sessão através de "az login". Se tanto uma cadeia de ligação de entidade como o nome forem fornecidos, a cadeia de ligação tem prioridade.

--resource-group -g

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

az iot hub device-identity export

Exporte todas as identidades do dispositivo de um Hub IoT para um recipiente de bolhas Azure Armazenamento. Para o recipiente blob inline ENTRADA SAS uri, por favor reveja as regras de entrada do seu ambiente.

Para obter mais informações, consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

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

Exemplos

Exporte todas as identidades do dispositivo para um recipiente de bolhas configurado e inclua chaves do dispositivo. Usa um exemplo FIS uri 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 recipiente de bolhas configurado utilizando um caminho de arquivo que contenha o SAS uri.

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

Exporte todas as identidades do dispositivo para um recipiente de bolhas configurado e inclua chaves do dispositivo. Utiliza identidade atribuída ao sistema que tem Armazenamento funções de Contribuinte de Dados Blob para a conta de armazenamento. O uri do recipiente blob não precisa do símbolo SAS blob.

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

Exporte todas as identidades do dispositivo para um recipiente de bolhas configurado e inclua chaves do dispositivo. Utiliza a identidade gerida atribuída pelo utilizador que tem Armazenamento funções de Contribuinte de Dados Blob para a conta de armazenamento e colaborador do hub IoT. O uri do recipiente blob não precisa do símbolo SAS blob.

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

Parâmetros Obrigatórios

--bcu --blob-container-uri

Blob Shared Access Signature URI com escrever, ler e apagar o acesso a um recipiente blob. Isto é usado para obter o estado do trabalho e os resultados. Nota: ao utilizar a autenticação baseada na identidade ainda é necessário um https:// URI - mas não é necessário qualquer sinal SAS. A entrada para este argumento pode ser inline ou a partir de um caminho de arquivo.

--hub-name -n

Nome IoT Hub.

Parâmetros Opcionais

--auth-type --storage-authentication-type

Tipo de autenticação para comunicação com o recipiente de armazenamento.

valores aceites: identity, key
--identity

É utilizado um tipo de identidade gerido para determinar se o sistema atribuído à identidade gerida ou à identidade gerida atribuída pelo utilizador. Para o sistema atribuído identidade gerida, use [sistema]. Para a identidade gerida atribuída pelo utilizador, forneça ao utilizador o id de recursos de identidade geridos atribuídos. Esta identidade requer um Armazenamento funções de Contribuinte de Dados Blob para a Conta Armazenamento.

--ik --include-keys

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

valores aceites: false, true
--resource-group -g

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

az iot hub device-identity import

Importar identidades de dispositivos para um hub IoT de uma bolha. Para o recipiente blob inline ENTRADA SAS uri, por favor reveja as regras de entrada do seu ambiente.

Para obter mais informações, consulte https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.

az iot hub device-identity import --hub-name
                                  --ibcu
                                  --obcu
                                  [--auth-type {identity, key}]
                                  [--identity]
                                  [--resource-group]

Exemplos

Importe todas as identidades do dispositivo a partir de uma bolha usando um SAS uri inline.

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

Importe todas as identidades do dispositivo a partir de uma bolha usando um caminho de arquivo que contenha SAS uri.

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

Importar todas as identidades do dispositivo a partir de uma bolha utilizando identidade atribuída ao sistema que tem Armazenamento funções de Contribuinte de Dados Blob para ambas as contas de armazenamento. O uri do recipiente blob não precisa do símbolo SAS blob.

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

Importar todas as identidades do dispositivo a partir de uma bolha utilizando a identidade gerida do utilizador que tem Armazenamento funções de Contribuinte de Dados Blob tanto para contas de armazenamento como para o contribuinte para o hub IoT. O uri do recipiente blob não precisa do símbolo SAS blob.

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

Parâmetros Obrigatórios

--hub-name -n

Nome IoT Hub.

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

Blob Shared Access Signature URI com acesso lido a um recipiente blob. Esta bolha contém as operações a serem realizadas no registo de identidade. Nota: ao utilizar a autenticação baseada na identidade ainda é necessário um https:// URI - mas não é necessário qualquer sinal SAS. A entrada para este argumento pode ser inline ou a partir de um caminho de arquivo.

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

Blob Shared Access Signature URI com acesso de escrita a um recipiente blob. Isto é usado para obter o estado do trabalho e os resultados. Nota: ao utilizar a autenticação baseada na identidade, continua a ser necessário um https:// URI sem o token SAS. A entrada para este argumento pode ser inline ou a partir de um caminho de arquivo.

Parâmetros Opcionais

--auth-type --storage-authentication-type

Tipo de autenticação para comunicação com o recipiente de armazenamento.

valores aceites: identity, key
--identity

É utilizado um tipo de identidade gerido para determinar se o sistema atribuído à identidade gerida ou à identidade gerida atribuída pelo utilizador. Para o sistema atribuído identidade gerida, use [sistema]. Para a identidade gerida atribuída pelo utilizador, forneça ao utilizador o id de recursos de identidade geridos atribuídos. Esta identidade requer um papel de contribuinte de dados blob Armazenamento para o papel de Armazenamento Conta e Colaborador para o IoT Hub.

--resource-group -g

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

az iot hub device-identity list

Listar dispositivos num hub IoT.

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 AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value> .

valores aceites: key, login
valor predefinido: key
--edge-enabled --ee

Sinalização indicando o habilitação da borda.

valores aceites: false, true
--hub-name -n

Nome IoT Hub.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos de realização de ação. Utilize para evitar o início de sessão através de "az login". Se tanto uma cadeia de ligação de entidade como o nome forem fornecidos, a cadeia de ligação tem prioridade.

--resource-group -g

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

--top

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

valor predefinido: 1000

az iot hub device-identity renew-key

Renovar as teclas-alvo de um dispositivo IoT Hub 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

Renovar 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

Dispositivo alvo.

--hub-name -n

Nome IoT Hub.

--key-type --kt

Tipo chave-alvo para 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 AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value> .

valores aceites: key, login
valor predefinido: key
--etag -e

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos de realização de ação. Utilize para evitar o início de sessão através de "az login". Se tanto uma cadeia de ligação de entidade como o nome forem fornecidos, a cadeia de ligação tem prioridade.

--resource-group -g

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

az iot hub device-identity show

Obtenha os detalhes de um dispositivo IoT Hub.

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

Parâmetros Obrigatórios

--device-id -d

Dispositivo alvo.

Parâmetros Opcionais

--auth-type

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

valores aceites: key, login
valor predefinido: key
--hub-name -n

Nome IoT Hub.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos de realização de ação. Utilize para evitar o início de sessão através de "az login". Se tanto uma cadeia de ligação de entidade como o nome forem fornecidos, a cadeia de ligação tem prioridade.

--resource-group -g

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

az iot hub device-identity update

Atualize um dispositivo IoT Hub.

Use --conjunto seguido de atribuições de propriedade para atualizar um dispositivo. Os parâmetros de alavancagem devolvidos do "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

Ligue as capacidades de borda para dispositivo

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

Ligue as capacidades de borda para o dispositivo utilizando o 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 utilizando 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 Obrigatórios

--device-id -d

Dispositivo alvo.

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor chave. Exemplo: --adicionar propriedade.listProperty <chave=valor, string ou> de cadeia JSON.

--am --auth-method

O tipo de autorização com que 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 AD Azure atual. Pode configurar o padrão utilizando az configure --defaults iothub-data-auth-type=<auth-type-value> .

valores aceites: key, login
valor predefinido: key
--edge-enabled --ee

Sinalização indicando o habilitação da borda.

valores aceites: false, true
--etag -e

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

--force-string

Ao utilizar 'set' ou 'add', preserve as cordas literais em vez de tentar converter-se em JSON.

--hub-name -n

Nome IoT Hub.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos de realização de ação. Utilize para evitar o início de sessão através de "az login". Se tanto uma cadeia de ligação de entidade como o nome forem fornecidos, a cadeia de ligação tem prioridade.

--pk --primary-key

A chave de acesso compartilhado simétrico primário armazenada no formato base64.

--primary-thumbprint --ptp

Impressão digital de certificado auto-assinada explícita para usar para a chave primária.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remover propriedade.list OR --remover propriedadeToRemove.

--resource-group -g

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

--secondary-key --sk

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

--secondary-thumbprint --stp

Impressão digital de certificado auto-assinada explícita para usar para chave secundária.

--set

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

--sta --status

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

valores aceites: disabled, enabled
--star --status-reason

Descrição para o estado do dispositivo.