Partilhar via

az iot central enrollment-group

  • Referência

Nota

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.46.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot central enrollment-group . Saiba mais sobre extensões.

Gerencie e configure o grupo de registro do IoT Central.

Comandos

Name Description Tipo Status
az iot central enrollment-group create

Crie um grupo de inscrição.

 Extensão GA
az iot central enrollment-group delete

Exclua um grupo de inscrição por ID.

 Extensão GA
az iot central enrollment-group generate-verification-code

Gere um código de verificação para o certificado x509 primário ou secundário de um grupo de inscrição.

 Extensão GA
az iot central enrollment-group list

Obtenha a lista de grupos de inscrição em um aplicativo.

 Extensão GA
az iot central enrollment-group show

Obtenha detalhes sobre um grupo de inscrição por ID.

 Extensão GA
az iot central enrollment-group update

Atualizar um grupo de inscrição.

 Extensão GA
az iot central enrollment-group verify-certificate

Verifique o certificado x509 primário ou secundário de um grupo de inscrição.

 Extensão GA

az iot central enrollment-group create

Crie um grupo de inscrição.

az iot central enrollment-group create --app-id
                                       --at {symmetricKey, x509}
                                       --display-name
                                       --group-id
                                       --type
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-path]
                                       [--etag]
                                       [--pk]
                                       [--provisioning-status {disabled, enabled}]
                                       [--scp]
                                       [--secondary-key]
                                       [--token]

Exemplos

Criar um grupo de inscrição

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at {attestation} --display-name {displayName} --type {type}

Criar um grupo de inscrição com certificação principal x509

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'x509' --display-name {displayName} --type {type} --cp {primayCertPath}

Criar um grupo de inscrição com determinada certificação de chave simétrica

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'symmetricKey' --display-name {displayName} --type {type} --pk {primaryKey} --sk {secondaryKey}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--at --attestation-type

O mecanismo de atestado para o grupo de inscrição. Apenas 'x509' ou 'symmetricKey' são permitidos. Por padrão, 'symmetricKey' será usado para atestado.

Valores aceites: symmetricKey, x509
Default value: symmetricKey
--display-name

Nome para exibição do grupo de inscrição.

--group-id --id

Identificador exclusivo para o grupo de inscrição.

--type

Tipo de dispositivos que se conectam através do grupo.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--certificate-path --cp

O caminho para o arquivo que contém o certificado primário.

--etag -e

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

--pk --primary-key

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

--provisioning-status --ps

Se os dispositivos que usam o grupo têm permissão para se conectar ao IoT Central. Verdadeiro ou Falso.

Valores aceites: disabled, enabled
Default value: enabled
--scp --secondary-certificate-path

O caminho para o arquivo que contém o certificado secundário.

--secondary-key --sk

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

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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
Default value: 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 central enrollment-group delete

Exclua um grupo de inscrição por ID.

az iot central enrollment-group delete --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

Exemplos

Excluir um grupo de inscrição por ID

az iot central enrollment-group delete --app-id {appid} --id {enrollmentGroupId}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--group-id --id

Identificador exclusivo para o grupo de inscrição.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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
Default value: 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 central enrollment-group generate-verification-code

Gere um código de verificação para o certificado x509 primário ou secundário de um grupo de inscrição.

az iot central enrollment-group generate-verification-code --app-id
                                                           --group-id
                                                           [--api-version {2022-06-30-preview, 2022-07-31}]
                                                           [--central-api-uri]
                                                           [--certificate-entry {primary, secondary}]
                                                           [--token]

Exemplos

Gerar um código de verificação para o certificado x509 primário de um grupo de inscrição

az iot central enrollment-group generate-verification-code --app-id {appid} --id {enrollmentGroupId} --entry 'primary'

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--group-id --id

Identificador exclusivo para o grupo de inscrição.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--certificate-entry --entry

Tipo de entrada do certificado x509 que só permite «primário» e «secundário».

Valores aceites: primary, secondary
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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
Default value: 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 central enrollment-group list

Obtenha a lista de grupos de inscrição em um aplicativo.

az iot central enrollment-group list --app-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--token]

Exemplos

Obter a lista de grupos de inscrição em um aplicativo

az iot central enrollment-group list --app-id {appid}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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
Default value: 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 central enrollment-group show

Obtenha detalhes sobre um grupo de inscrição por ID.

az iot central enrollment-group show --app-id
                                     --group-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--certificate-entry {primary, secondary}]
                                     [--token]

Exemplos

Obter detalhes sobre um grupo de inscrição por ID

az iot central enrollment-group show --app-id {appid} --id {enrollmentGroupId}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--group-id --id

Identificador exclusivo para o grupo de inscrição.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--certificate-entry --entry

Tipo de entrada do certificado x509 que só permite «primário» e «secundário».

Valores aceites: primary, secondary
--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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
Default value: 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 central enrollment-group update

Atualizar um grupo de inscrição.

az iot central enrollment-group update --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-entry {primary, secondary}]
                                       [--certificate-path]
                                       [--display-name]
                                       [--etag]
                                       [--provisioning-status {disabled, enabled}]
                                       [--remove-x509 {false, true}]
                                       [--scp]
                                       [--token]
                                       [--type]

Exemplos

Atualizar um grupo de inscrição

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --display-name {displayName} --type {type} --ps {enabled}

Remover certificado primário x509 de um grupo de inscrição

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --remove-x509 'true' --entry 'primary'

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--group-id --id

Identificador exclusivo para o grupo de inscrição.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--certificate-entry --entry

Tipo de entrada do certificado x509 que só permite «primário» e «secundário».

Valores aceites: primary, secondary
--certificate-path --cp

O caminho para o arquivo que contém o certificado primário.

--display-name

Nome para exibição do grupo de inscrição.

--etag

ETag usado para evitar conflitos nas atualizações do grupo de inscrição.

--provisioning-status --ps

Se os dispositivos que usam o grupo têm permissão para se conectar ao IoT Central. Verdadeiro ou Falso.

Valores aceites: disabled, enabled
Default value: enabled
--remove-x509

Se o certificado x509 deve ser removido do grupo. Verdadeiro ou Falso.

Valores aceites: false, true
--scp --secondary-certificate-path

O caminho para o arquivo que contém o certificado secundário.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

--type

Tipo de dispositivos que se conectam através do grupo.

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
Default value: 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 central enrollment-group verify-certificate

Verifique o certificado x509 primário ou secundário de um grupo de inscrição.

Verifique o certificado x509 primário ou secundário de um grupo de inscrição fornecendo um certificado com o código de verificação assinado.

Observe que, se um grupo de inscrição foi criado com um certificado x509 não verificado, um certificado de verificação precisará ser criado usando o certificado x509 não verificado e um código de verificação antes de usar este comando. Um código de verificação pode ser gerado via cli usando o comando 'enrollment-group generate-verification-code'. Saiba mais sobre como criar certificados de verificação usando o código de verificação em https://learn.microsoft.com/en-us/azure/iot-central/core/how-to-connect-devices-x509.

az iot central enrollment-group verify-certificate --app-id
                                                   --group-id
                                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                                   [--central-api-uri]
                                                   [--certificate-path]
                                                   [--scp]
                                                   [--token]

Exemplos

Verificar o certificado x509 primário de um grupo de inscrição

az iot central enrollment-group verify-certificate --app-id {appid} --id {enrollmentGroupId} --cp {primayCertPath}

Parâmetros Obrigatórios

--app-id -n

A ID do aplicativo IoT Central que você deseja gerenciar. Você pode encontrar o ID do aplicativo na página "Sobre" do seu aplicativo no menu de ajuda.

--group-id --id

Identificador exclusivo para o grupo de inscrição.

Parâmetros Opcionais

--api-version --av
Preterido

O argumento 'api_version' foi preterido e será removido em uma versão futura.

Este parâmetro de comando foi preterido e será ignorado. Na versão futura, só suportaremos APIs do IoT Central a partir da versão mais recente do GA. Se alguma API ainda não for GA, chamaremos a versão de visualização mais recente.

Valores aceites: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

O sufixo DNS do IoT Central associado ao seu aplicativo.

Default value: azureiotcentral.com
--certificate-path --cp

O caminho para o arquivo que contém o certificado primário.

--scp --secondary-certificate-path

O caminho para o arquivo que contém o certificado secundário.

--token

Se preferir enviar sua solicitação sem autenticar na CLI do Azure, você pode especificar um token de usuário válido para autenticar sua solicitação. Você deve especificar o tipo de chave como parte da solicitação. Saiba mais em https://aka.ms/iotcentraldocsapi.

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
Default value: 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.