Partilhar via

az iot hub module-identity

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot hub module-identity. Learn more about extensions.

Gerencie módulos de dispositivos IoT.

Comandos

Name Description Tipo Status
az iot hub module-identity connection-string

Gerencie a cadeia de conexão do módulo de dispositivo IoT.

 Extension disponibilidade geral
az iot hub module-identity connection-string show

Mostrar uma cadeia de conexão do módulo de dispositivo IoT de destino.

 Extension disponibilidade geral
az iot hub module-identity create

Crie um módulo em um dispositivo IoT de destino em um Hub IoT.

 Extension disponibilidade geral
az iot hub module-identity delete

Exclua um dispositivo em um Hub IoT.

 Extension disponibilidade geral
az iot hub module-identity list

Liste módulos localizados em um dispositivo IoT em um Hub IoT.

 Extension disponibilidade geral
az iot hub module-identity renew-key

Renove as chaves de destino dos módulos de dispositivo do Hub IoT com autenticação sas.

 Extension disponibilidade geral
az iot hub module-identity show

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

 Extension disponibilidade geral
az iot hub module-identity update

Atualize um módulo de dispositivo do Hub IoT.

 Extension disponibilidade geral

az iot hub module-identity create

Crie um módulo em um dispositivo IoT de destino 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 módulo.

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

Parâmetros Obrigatórios

--device-id -d

ID do dispositivo de destino.

--module-id -m

ID do módulo de destino.

Parâmetros Opcionais

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

--am --auth-method

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

Propriedade Valor
Default value: shared_private_key
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 usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de 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}.

Propriedade Valor
Parameter group: Access Control Arguments
Default value: key
Valores aceites: key, login
--hub-name -n

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

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--od --output-dir

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

Propriedade Valor
Parameter group: X.509 Arguments
--pk --primary-key

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

Propriedade Valor
Parameter group: Symmetric Key Arguments
--primary-thumbprint --ptp

Impressão digital de certificado auto-assinada a ser usada para a impressão digital principal.

Propriedade Valor
Parameter group: X.509 Arguments
--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.

Propriedade Valor
Parameter group: Symmetric Key Arguments
--secondary-thumbprint --stp

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

Propriedade Valor
Parameter group: X.509 Arguments
--valid-days --vd

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

Propriedade Valor
Parameter group: X.509 Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az iot hub module-identity delete

Exclua um dispositivo em um 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

ID do dispositivo de destino.

--module-id -m

ID do módulo de destino.

Parâmetros Opcionais

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

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

Propriedade Valor
Parameter group: Access Control Arguments
Default value: key
Valores aceites: key, login
--etag -e

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

--hub-name -n

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

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az iot hub module-identity list

Liste módulos localizados em um dispositivo IoT em um 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

ID do dispositivo de destino.

Parâmetros Opcionais

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

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

Propriedade Valor
Parameter group: Access Control Arguments
Default value: key
Valores aceites: key, login
--hub-name -n

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

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--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 devolver. Use -1 para ilimitado.

Propriedade Valor
Default value: 1000
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az iot hub module-identity renew-key

Renove as chaves de destino dos módulos de dispositivo do Hub IoT com autenticação sas.

Atualmente, etags e tipo swap de chave não são suportados para regeneração de chave em massa. A regeneração de chave em massa terá um formato de saída diferente da regeneração de chave de módulo único.

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

Exemplos

Renove 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ária e secundária.

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

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

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

Renove ambas as teclas para todos os módulos do dispositivo.

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

Parâmetros Obrigatórios

--device-id -d

ID do dispositivo de destino.

--hub-name -n

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

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--key-type --kt

Tipo de chave de destino para regeneração.

Propriedade Valor
Valores aceites: both, primary, secondary, swap
--module-id -m

Lista separada por espaço de IDs de módulo de destino. Use * para todos os módulos.

Parâmetros Opcionais

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

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

Propriedade Valor
Parameter group: Access Control Arguments
Default value: key
Valores aceites: key, login
--etag -e

Etag ou entity tag correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado. Este argumento só se aplica a swap.

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--no-progress

Oculte a barra de progresso para regeneração de chave em massa.

Propriedade Valor
Valores aceites: false, true
--resource-group -g

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az iot hub module-identity show

Obtenha os detalhes de um módulo de dispositivo IoT em um 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

ID do dispositivo de destino.

--module-id -m

ID do módulo de destino.

Parâmetros Opcionais

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

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

Propriedade Valor
Parameter group: Access Control Arguments
Default value: key
Valores aceites: key, login
--hub-name -n

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

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--resource-group -g

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az iot hub module-identity update

Atualize um módulo de dispositivo do Hub IoT.

Use --set seguido de atribuições de propriedade para atualizar um módulo. Aproveite as propriedades retornadas de 'iot hub module-identity 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

Regenerar chaves de autenticação simétricas do módulo

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

ID do dispositivo de destino.

--module-id -m

ID do módulo de destino.

Parâmetros Opcionais

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

--add

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

Propriedade Valor
Parameter group: Generic Update Arguments
Default value: []
--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 de 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}.

Propriedade Valor
Parameter group: Access Control Arguments
Default value: key
Valores aceites: key, login
--etag -e

Etag ou entity tag 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 string em vez de tentar converter para JSON.

Propriedade Valor
Parameter group: Generic Update Arguments
Default value: False
--hub-name -n

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

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade Valor
Parameter group: IoT Hub Identifier Arguments
--remove

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

Propriedade Valor
Parameter group: Generic Update Arguments
Default value: []
--resource-group -g

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

--set

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

Propriedade Valor
Parameter group: Generic Update Arguments
Default value: []
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Output format.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False