az iot hub module-identity

Nota

Esta referência faz parte da extensão azure-iot para o Azure CLI (versão 2.24.1 ou superior). A extensão instalará automaticamente a primeira vez que executar um comando de identidade de módulo az iot hub . Saiba mais sobre extensões.

Gerir módulos de dispositivo ioT.

Comandos

az iot hub module-identity connection-string

Gerir a cadeia de ligação do módulo de dispositivo IoT.

az iot hub module-identity connection-string show

Mostrar uma cadeia de ligação do módulo do dispositivo IoT alvo.

az iot hub module-identity create

Crie um módulo num dispositivo IoT alvo num Hub IoT.

az iot hub module-identity delete

Elimine um dispositivo num Hub IoT.

az iot hub module-identity list

Listar módulos localizados num dispositivo IoT num Hub IoT.

az iot hub module-identity renew-key

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

az iot hub module-identity show

Obtenha os detalhes de um módulo de dispositivo IoT em Hub IoT.

az iot hub module-identity update

Atualize um módulo de dispositivo Hub IoT.

az iot hub module-identity create

Crie um módulo num dispositivo IoT alvo num Hub IoT.

Ao utilizar o método auth de shared_private_key (também conhecido como teclas simétricas), se não forem fornecidas teclas personalizadas, o serviço irá gere-las para o módulo.

az iot hub module-identity create --device-id
                                  --module-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--valid-days]

Parâmetros Obrigatórios

--device-id -d

Dispositivo alvo.

--module-id -m

Módulo alvo.

Parâmetros Opcionais

--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
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
--hub-name -n

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--od --output-dir

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

--pk --primary-key

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

--primary-thumbprint --ptp

Impressão digital auto-assinada do certificado para usar para a impressão digital primária.

--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 auto-assinada do certificado para usar para a impressão digital secundária.

--valid-days --vd

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

az iot hub module-identity delete

Elimine um dispositivo num Hub IoT.

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

Parâmetros Obrigatórios

--device-id -d

Dispositivo alvo.

--module-id -m

Módulo 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 utilizado qualquer etiqueta etag, o valor '*» é utilizado.

--hub-name -n

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--resource-group -g

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

az iot hub module-identity list

Listar módulos localizados num dispositivo IoT num Hub IoT.

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

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

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--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 module-identity renew-key

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

az iot hub module-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     --module-id
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

Exemplos

Renovar a chave primária.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt primary

Troque as chaves primárias e secundárias.

az iot hub module-identity renew-key -m {module_name} -d {device_id} -n {iothub_name} --kt swap

Parâmetros Obrigatórios

--device-id -d

Dispositivo alvo.

--hub-name -n

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

--key-type --kt

Tipo chave-alvo para regenerar.

valores aceites: primary, secondary, swap
--module-id -m

Módulo 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 utilizado qualquer etiqueta etag, o valor '*» é utilizado.

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--resource-group -g

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

az iot hub module-identity show

Obtenha os detalhes de um módulo de dispositivo IoT em Hub IoT.

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

Parâmetros Obrigatórios

--device-id -d

Dispositivo alvo.

--module-id -m

Módulo 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

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

--resource-group -g

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

az iot hub module-identity update

Atualize um módulo de dispositivo Hub IoT.

Use --conjunto seguido de atribuição de propriedade para atualizar um módulo. As propriedades de alavancagem devolvidas do "iot hub módulo-identidade show".

az iot hub module-identity update --device-id
                                  --module-id
                                  [--add]
                                  [--auth-type {key, login}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--remove]
                                  [--resource-group]
                                  [--set]

Exemplos

Chaves de autenticação simétrica do módulo regenerador

az iot hub module-identity update -m {module_name} -d {device_id} -n {iothub_name} --set authentication.symmetricKey.primaryKey="" authentication.symmetricKey.secondaryKey=""

Parâmetros Obrigatórios

--device-id -d

Dispositivo alvo.

--module-id -m

Módulo 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.

--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 utilizado qualquer etiqueta 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

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

--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para realizar a ação. Utilize para evitar o login de sessão através de "az login". Se uma cadeia de ligação de entidade e o nome forem fornecidos, a cadeia de ligação tem prioridade. Necessário se não for fornecido o nome do hub.

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

--set

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