az iot dps

Nota

Este grupo de comandos tem comandos definidos na CLI do Azure e em pelo menos uma extensão. Instale cada extensão para se beneficiar de seus recursos estendidos. Saiba mais sobre extensões.

Gerencie o Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Comandos

Name Description Tipo Estado
az iot dps certificate

Gerencie certificados para uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps certificate create

Crie/carregue um certificado para uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps certificate delete

Exclua um certificado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps certificate generate-verification-code

Gere um código de verificação para um certificado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps certificate list

Liste todos os certificados contidos em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps certificate show

Mostrar informações sobre um certificado específico em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps certificate update

Atualize um certificado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps certificate verify

Verifique um certificado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps compute-device-key

Gere uma chave SAS de dispositivo derivada.

Extensão Preterido
az iot dps connection-string

Gerencie cadeias de conexão para uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps connection-string show

Mostrar as cadeias de conexão para os Serviços de Provisionamento de Dispositivo especificados usando o nome e a chave da política fornecidos.

Extensão GA
az iot dps create

Crie uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps delete

Exclua uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps enrollment

Gerencie inscrições de dispositivos individuais em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group

Gerencie grupos de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group compute-device-key

Gere uma chave SAS de dispositivo derivada para um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group create

Crie um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group delete

Exclua um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group list

Listar grupos de inscrições em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group registration

Gerencie registros de dispositivos do lado do serviço para um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group registration delete

Exclua um registro de dispositivo para um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group registration list

Liste registros de dispositivo para um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group registration show

Obtenha um registro de dispositivo para um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group show

Obtenha os detalhes de um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment-group update

Atualize um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment create

Crie um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment delete

Exclua um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment list

Liste inscrições de dispositivos individuais em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment registration

Gerencie registros de dispositivos do lado do serviço para um registro individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment registration delete

Exclua um registro de dispositivo para um registro individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment registration show

Obtenha um registro de dispositivo para um registro individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment show

Obtenha detalhes de registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps enrollment update

Atualize um registro de dispositivo individual em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão GA
az iot dps linked-hub

Gerencie Hubs IoT vinculados em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps linked-hub create

Crie um hub IoT vinculado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps linked-hub delete

Atualize um hub IoT vinculado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps linked-hub list

Liste todos os hubs IoT vinculados em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps linked-hub show

Mostrar detalhes de um hub IoT vinculado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps linked-hub update

Atualize um hub IoT vinculado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps list

Liste instâncias do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps policy

Gerencie políticas de acesso compartilhado para uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps policy create

Crie uma nova política de acesso compartilhado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps policy delete

Exclua uma política de acesso compartilhado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps policy list

Liste todas as políticas de acesso compartilhado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps policy show

Mostrar detalhes de uma política de acesso compartilhado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps policy update

Atualize uma política de acesso compartilhado em uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps registration

Gerencie registros de dispositivo para um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão Preterido
az iot dps registration delete

Exclua um registro de dispositivo em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão Preterido
az iot dps registration list

Liste registros de dispositivo para um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão Preterido
az iot dps registration show

Obtenha um registro de dispositivo para um grupo de inscrição em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Extensão Preterido
az iot dps show

Obtenha os detalhes de uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA
az iot dps update

Atualize uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Principal GA

az iot dps compute-device-key

Preterido

Este comando foi preterido e será removido em uma versão futura. Use 'iot dps enrollment-group compute-device-key' em vez disso.

Gere uma chave SAS de dispositivo derivada.

Gere uma chave de dispositivo derivada para um grupo de registro DPS.

az iot dps compute-device-key --registration-id
                              [--auth-type {key, login}]
                              [--dps-name]
                              [--eid]
                              [--key]
                              [--login]
                              [--resource-group]

Exemplos

Calcule a chave do dispositivo com a chave simétrica fornecida.

az iot dps compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}

Calcule a chave do dispositivo com o grupo de inscrição fornecido.

az iot dps compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}

Parâmetros Obrigatórios

--registration-id

ID do registo do dispositivo.

Parâmetros Opcionais

--auth-type

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

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

Nome ou nome de host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.

--eid --enrollment-id --gid --group-id

ID do grupo de inscrição.

--key --symmetric-key

A chave de acesso compartilhado simétrica para o grupo de inscrição. Isso ignora o registro do Serviço de Provisionamento de Dispositivo e gera o token SAS diretamente da chave simétrica fornecida sem validação adicional. Todos os outros parâmetros de comando, além do ID de registro, serão ignorados.

--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 --dps-name não for fornecido.

--resource-group -g

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az iot dps create

Crie uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

Para obter uma introdução ao Serviço de Provisionamento de Dispositivo do Hub IoT do Azure, consulte https://docs.microsoft.com/azure/iot-dps/about-iot-dps.

az iot dps create --name
                  --resource-group
                  [--edr {false, true}]
                  [--location]
                  [--sku {S1}]
                  [--tags]
                  [--unit]

Exemplos

Crie um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure com a camada de preço padrão S1, na região do grupo de recursos.

az iot dps create --name MyDps --resource-group MyResourceGroup

Crie um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure com a camada de preço padrão S1, na região 'eastus'.

az iot dps create --name MyDps --resource-group MyResourceGroup --location eastus

Crie um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure com residência de dados imposta. Isso desativará a recuperação de desastres entre regiões.

az iot dps create --name MyDps --resource-group MyResourceGroup --edr

Parâmetros Obrigatórios

--name -n

Nome do Serviço de Provisionamento de Dispositivo do Hub IoT.

--resource-group -g

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

Parâmetros Opcionais

--edr --enforce-data-residency

Imponha a residência de dados para este Serviço de Provisionamento de Dispositivo do Hub IoT desabilitando a recuperação de desastres entre pares geográficos. Esta propriedade é imutável uma vez definida no recurso. Disponível apenas em regiões selecionadas. Saiba mais em https://aka.ms/dpsdr.

valores aceites: false, true
--location -l

Localização do seu Serviço de Provisionamento de Dispositivo do Hub IoT. O padrão é o local do grupo de recursos de destino.

--sku

Nível de preço para o Serviço de Provisionamento de Dispositivos do Hub IoT.

valores aceites: S1
valor predefinido: S1
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--unit

Unidades no seu Serviço de Provisionamento de Dispositivo do Hub IoT.

valor predefinido: 1
Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az iot dps delete

Exclua uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

az iot dps delete [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

Exemplos

Excluir um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure 'MyDps'

az iot dps delete --name MyDps --resource-group MyResourceGroup

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome do Serviço de Provisionamento de Dispositivo do Hub IoT.

--resource-group -g

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

--subscription

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az iot dps list

Liste instâncias do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

az iot dps list [--resource-group]

Exemplos

Liste todos os Serviços de Provisionamento de Dispositivo do Hub IoT do Azure em uma assinatura.

az iot dps list

Listar todos os Serviços de Provisionamento de Dispositivo do Hub IoT do Azure no grupo de recursos 'MyResourceGroup'

az iot dps list --resource-group MyResourceGroup

Parâmetros Opcionais

--resource-group -g

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az iot dps show

Obtenha os detalhes de uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

az iot dps show [--ids]
                [--name]
                [--resource-group]
                [--subscription]

Exemplos

Mostrar detalhes de um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure 'MyDps'

az iot dps show --name MyDps --resource-group MyResourceGroup

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome do Serviço de Provisionamento de Dispositivo do Hub IoT.

--resource-group -g

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

--subscription

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

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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

az iot dps update

Atualize uma instância do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.

az iot dps update [--add]
                  [--force-string]
                  [--ids]
                  [--name]
                  [--remove]
                  [--resource-group]
                  [--set]
                  [--subscription]
                  [--tags]

Exemplos

Atualizar a política de alocação para 'GeoLatency' de um serviço de provisionamento de dispositivo do Hub IoT do Azure 'MyDps'

az iot dps update --name MyDps --resource-group MyResourceGroup --set properties.allocationPolicy="GeoLatency"

Parâmetros Opcionais

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

valor predefinido: []
--force-string

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

valor predefinido: False
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome do Serviço de Provisionamento de Dispositivo do Hub IoT.

--remove

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

valor predefinido: []
--resource-group -g

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

valor predefinido: []
--subscription

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

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

Parâmetros de Globais
--debug

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

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

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

--subscription

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

--verbose

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