az iot dps enrollment-group
Observação
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 dps enrollment-group . Saiba mais sobre extensões.
Gerenciar grupos de registro em um Serviço de Provisionamento de Dispositivos no Hub IoT do Azure.
Comandos
Nome | Description | Tipo | Status |
---|---|---|---|
az iot dps enrollment-group compute-device-key |
Gere uma chave SAS de dispositivo derivada para um grupo de registro 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 registro 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 registro 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 registros em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. |
Extensão | GA |
az iot dps enrollment-group registration |
Gerenciar registros de dispositivo do lado do serviço para um grupo de registro 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 registro em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. |
Extensão | GA |
az iot dps enrollment-group registration list |
Listar registros de dispositivo para um grupo de registro 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 registro 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 registro 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 registro em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
az iot dps enrollment-group 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 enrollment-group compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}
Calcule a chave do dispositivo com o grupo de registro fornecido.
az iot dps enrollment-group compute-device-key -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --registration-id {registration_id}
Parâmetros Exigidos
ID do registro do dispositivo.
Parâmetros Opcionais
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 do 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>
o .
Nome ou nome do host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
ID do grupo de inscrição.
A chave de acesso compartilhada 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 da ID de registro, serão ignorados.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot dps enrollment-group create
Crie um grupo de registro em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
Forneça o formato do certificado usando a codificação ASCII Base64 e o certificado deve ter segmentos BEGIN e END correspondentes, por exemplo: comece com '-----BEGIN CERTIFICATE-----' e termine com '-----END CERTIFICATE-----'.
az iot dps enrollment-group create --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--ca-name]
[--certificate-path]
[--dps-name]
[--edge-enabled {false, true}]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Exemplos
Crie um grupo de registro '{enrollment_id}' no serviço de provisionamento de IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name} usando um certificado intermediário como certificado primário'.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem
Crie um grupo de registro '{enrollment_id}' no serviço de provisionamento do Azure IoT '{dps_name}' no grupo de recursos '{resource_group_name} usando um certificado de CA {certificate_name} como certificado secundário'.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name}
Crie um grupo de registro '{enrollment_id}' no serviço de provisionamento de IoT do Azure 'MyDps' no grupo de recursos '{resource_group_name}' com status de provisionamento 'habilitado', propriedades gêmeas iniciais '{"location":{"region":"US"}}' e marcas gêmeas iniciais '{"version_dps":"1"}' usando um certificado intermediário como certificado principal.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/Certificate.pem --provisioning-status enabled --initial-twin-properties "{'location':{'region':'US'}}" --initial-twin-tags "{'version_dps':'1'}"
Crie um grupo de registro '{enrollment_id}' no serviço de provisionamento de IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name} com o tipo de atestado 'symmetrickey'.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {primary_key} --secondary-key {secondary_key}
Criar um grupo de inscrição '{enrollment_id}' com política de alocação personalizada,
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy custom --webhook-url {webhook_url} --api-version {api_version}
Parâmetros Exigidos
ID do grupo de inscrição.
Parâmetros Opcionais
Tipo de política de alocação para determinar como um dispositivo é atribuído a um Hub IoT. Se não for fornecida, a política de alocação será a política de alocação atual definida como padrão para a instância do Serviço de Provisionamento de Dispositivo.
A versão da API dos tipos de serviço de provisionamento enviados na solicitação de alocação personalizada. Versão mínima suportada: 2018-09-01-preview.
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 do 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>
o .
O nome do certificado de autoridade de certificação raiz primário. Se o atestado com um certificado de autoridade de certificação raiz for desejado, um nome de autoridade de certificação raiz deverá ser fornecido.
O caminho para o arquivo que contém o certificado primário. Se o atestado com um certificado intermediário for desejado, um caminho de certificado deve ser fornecido.
Nome ou nome do host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
Sinalizador indicando habilitação de borda.
Nome do host do Hub IoT de destino associado à política de alocação. Use a lista separada por espaço para vários Hubs IoT.
Propriedades gêmeas iniciais do dispositivo.
Tags gêmeas iniciais do dispositivo.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
A chave de acesso compartilhada simétrica primária armazenada no formato base64.
Habilitar ou desabilitar a entrada de registro.
Política para determinar como os dados do dispositivo devem ser tratados no reprovisionamento para um Hub IoT diferente.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome do certificado de autoridade de certificação raiz secundário. Se o atestado com um certificado de autoridade de certificação raiz for desejado, um nome de autoridade de certificação raiz deverá ser fornecido.
O caminho para o arquivo que contém o certificado secundário. Se o atestado com um certificado intermediário for desejado, um caminho de certificado deve ser fornecido.
A chave de acesso compartilhada simétrica secundária armazenada no formato base64.
A URL de webhook da Função do Azure usada para solicitações de alocação personalizadas.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot dps enrollment-group delete
Exclua um grupo de registro em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
az iot dps enrollment-group delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Parâmetros Exigidos
ID do grupo de inscrição.
Parâmetros Opcionais
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 do 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>
o .
Nome ou nome do host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
Etag ou tag de entidade correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot dps enrollment-group list
Listar grupos de registros em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
az iot dps enrollment-group list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
Parâmetros Opcionais
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 do 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>
o .
Nome ou nome do host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Número máximo de elementos a serem retornados. Use -1 para ilimitado.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
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.
az iot dps enrollment-group show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]
Exemplos
Uso básico
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Incluir informações completas de atestado nos resultados de um grupo de registro de chave simétrica
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Parâmetros Exigidos
ID do grupo de inscrição.
Parâmetros Opcionais
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 do 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>
o .
Nome ou nome do host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
Inclua chaves de atestado e informações nos resultados do grupo de inscrição.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az iot dps enrollment-group update
Atualize um grupo de registro em um Serviço de Provisionamento de Dispositivo do Hub IoT do Azure.
Forneça o formato do certificado usando a codificação ASCII Base64 e o certificado deve ter segmentos BEGIN e END correspondentes, por exemplo: comece com '-----BEGIN CERTIFICATE-----' e termine com '-----END CERTIFICATE-----'.
az iot dps enrollment-group update --eid
[--allocation-policy {custom, geoLatency, hashed, static}]
[--api-version]
[--auth-type {key, login}]
[--ca-name]
[--certificate-path]
[--dps-name]
[--edge-enabled {false, true}]
[--etag]
[--ih]
[--initial-twin-properties]
[--initial-twin-tags]
[--login]
[--pk]
[--provisioning-status {disabled, enabled}]
[--rc {false, true}]
[--remove-secondary-certificate {false, true}]
[--reprovision-policy {never, reprovisionandmigratedata, reprovisionandresetdata}]
[--resource-group]
[--scn]
[--scp]
[--secondary-key]
[--webhook-url]
Exemplos
Atualize o grupo de registro '{enrollment_id}' no serviço de provisionamento do Azure IoT '{dps_name}' no grupo de recursos '{resource_group_name}' com propriedades gêmeas iniciais e marcas gêmeas iniciais.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --initial-twin-properties "{'location':{'region':'USA'}}" --initial-twin-tags "{'version_dps':'2'}" --etag AAAAAAAAAAA=
Atualize o grupo de registro '{enrollment_id}' no serviço de provisionamento do Azure IoT '{dps_name}' no grupo de recursos '{resource_group_name}' com o novo certificado intermediário primário e remova o certificado intermediário secundário existente.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --certificate-path /certificates/NewCertificate.pem --remove-secondary-certificate --etag AAAAAAAAAAA=
Atualize o grupo de registro '{enrollment_id}' no serviço de provisionamento do Azure IoT '{dps_name}' no grupo de recursos '{resource_group_name}' com o novo certificado de CA secundário '{certificate_name}' e remova o certificado de CA primário existente.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name} --remove-certificate --etag AAAAAAAAAAA=
Atualize o grupo de registro '{enrollment_id}' no serviço de provisionamento do Azure IoT '{dps_name}' no grupo de recursos '{resource_group_name}' com nova chave primária.
az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --primary-key {new_primary_key} --etag AAAAAAAAAAA=
Parâmetros Exigidos
ID do grupo de inscrição.
Parâmetros Opcionais
Tipo de política de alocação para determinar como um dispositivo é atribuído a um Hub IoT. Se não for fornecida, a política de alocação será a política de alocação atual definida como padrão para a instância do Serviço de Provisionamento de Dispositivo.
A versão da API dos tipos de serviço de provisionamento enviados na solicitação de alocação personalizada. Versão mínima suportada: 2018-09-01-preview.
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 do 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>
o .
O nome do certificado de autoridade de certificação raiz primário. Se o atestado com um certificado de autoridade de certificação raiz for desejado, um nome de autoridade de certificação raiz deverá ser fornecido.
O caminho para o arquivo que contém o certificado primário. Se o atestado com um certificado intermediário for desejado, um caminho de certificado deve ser fornecido.
Nome ou nome do host do Serviço de Provisionamento de Dispositivo do Hub IoT do Azure. Obrigatório se --login não for fornecido.
Sinalizador indicando habilitação de borda.
Etag ou tag de entidade correspondente ao último estado do recurso. Se nenhum etag for fornecido, o valor '*' será usado.
Nome do host do Hub IoT de destino associado à política de alocação. Use a lista separada por espaço para vários Hubs IoT.
Propriedades gêmeas iniciais do dispositivo.
Tags gêmeas iniciais do dispositivo.
Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. Use para evitar o login da 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.
A chave de acesso compartilhada simétrica primária armazenada no formato base64.
Habilitar ou desabilitar a entrada de registro.
Sinalizador para remover o certificado primário atual.
Sinalizador para remover o certificado secundário atual.
Política para determinar como os dados do dispositivo devem ser tratados no reprovisionamento para um Hub IoT diferente.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome do certificado de autoridade de certificação raiz secundário. Se o atestado com um certificado de autoridade de certificação raiz for desejado, um nome de autoridade de certificação raiz deverá ser fornecido.
O caminho para o arquivo que contém o certificado secundário. Se o atestado com um certificado intermediário for desejado, um caminho de certificado deve ser fornecido.
A chave de acesso compartilhada simétrica secundária armazenada no formato base64.
A URL de webhook da Função do Azure usada para solicitações de alocação personalizadas.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.