Compartilhar via


az iot dps enrollment-group

Note

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.67.0 ou superior). A extensão instalará 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 Dispositivos no Hub IoT do Azure.

Extension GA
az iot dps enrollment-group create

Crie um grupo de registro em um Serviço de Provisionamento de Dispositivos do Hub IoT do Azure.

Extension GA
az iot dps enrollment-group delete

Exclua um grupo de registro em um Serviço de Provisionamento de Dispositivos do Hub IoT do Azure.

Extension GA
az iot dps enrollment-group list

Listar grupos de registros em um Serviço de Provisionamento de Dispositivos no Hub IoT do Azure.

Extension GA
az iot dps enrollment-group registration

Gerencie registros de dispositivo do lado do serviço para um grupo de registro em um Serviço de Provisionamento de Dispositivos no Hub IoT do Azure.

Extension 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 Dispositivos no Hub IoT do Azure.

Extension GA
az iot dps enrollment-group registration list

Listar registros de dispositivo para um grupo de registro em um Serviço de Provisionamento de Dispositivos no Hub IoT do Azure.

Extension 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 Dispositivos no Hub IoT do Azure.

Extension GA
az iot dps enrollment-group show

Obtenha os detalhes de um grupo de registro em um Serviço de Provisionamento de Dispositivos no Hub IoT do Azure.

Extension GA
az iot dps enrollment-group update

Atualize um grupo de registro em um Serviço de Provisionamento de Dispositivos do Hub IoT do Azure.

Extension 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 Dispositivos no Hub IoT do Azure.

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

Exemplos

Compute 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}

Compute a chave do dispositivo com o grupo de registro especificado.

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

--registration-id --rid

ID do registro do dispositivo.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja necessário. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Valor padrão: key
Valores aceitos: key, login
--dps-name -n

Nome ou nome do host do Serviço de Provisionamento de Dispositivos do Hub IoT do Azure. Necessário se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service Identifier Arguments
--eid --enrollment-id --gid --group-id

ID do grupo de registro.

--key --symmetric-key

A chave de acesso compartilhado simétrica para o grupo de registro. Isso ignora o registro do Serviço de Provisionamento de Dispositivos 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.

--login -l

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão tem prioridade. Obrigatório se --dps-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service 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 Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot dps enrollment-group create

Crie um grupo de registro em um Serviço de Provisionamento de Dispositivos 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 --enrollment-id --gid --group-id
                                   [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                                   [--api-version --av]
                                   [--auth-type {key, login}]
                                   [--ca-name --cn --root-ca-name]
                                   [--certificate-path --cp]
                                   [--cpn --credential-policy-name]
                                   [--dps-name]
                                   [--edge-enabled --ee {false, true}]
                                   [--ih --iot-hubs]
                                   [--initial-twin-properties --props]
                                   [--initial-twin-tags --tags]
                                   [--login]
                                   [--pk --primary-key]
                                   [--provisioning-status --ps {disabled, enabled}]
                                   [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                                   [--resource-group]
                                   [--scn --secondary-ca-name --secondary-root-ca-name]
                                   [--scp --secondary-certificate-path]
                                   [--secondary-key --sk]
                                   [--webhook-url --wh]

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 de IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name} usando um certificado de AC {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 o status de provisionamento 'habilitado', as propriedades gêmeas iniciais '{"location":{"region":"US"}}' e as marcas gêmeas iniciais '{"version_dps":"1"}' 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 --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 registro '{enrollment_id}' com a 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}

Crie um grupo de registro com uma Política de Credencial de Namespace do Registro de Dispositivo personalizada especificada.

az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --allocation-policy hashed --credential-policy-name {policy_name}

Parâmetros Exigidos

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

ID do grupo de registro.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--allocation-policy --ap

Tipo de política de alocação para determinar como um dispositivo é atribuído a um Hub IoT. Se não for fornecido, a política de alocação será o conjunto padrão da política de alocação atual para a instância do Serviço de Provisionamento de Dispositivos.

Propriedade Valor
Grupo de parâmetros: Allocation Policy Arguments
Valores aceitos: custom, geoLatency, hashed, static
--api-version --av

A versão da API dos tipos de serviço de provisionamento enviados na solicitação de alocação personalizada. Versão mínima com suporte: 2018-09-01-preview.

Propriedade Valor
Grupo de parâmetros: Allocation Policy Arguments
--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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja necessário. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Valor padrão: key
Valores aceitos: key, login
--ca-name --cn --root-ca-name

O nome do certificado de AC raiz primário. Se o atestado com um certificado de AC raiz for desejado, um nome de autoridade de certificação raiz deverá ser fornecido.

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--certificate-path --cp

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 deverá ser fornecido.

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--cpn --credential-policy-name

Nome da política de credencial do namespace de ADR.

Propriedade Valor
Grupo de parâmetros: ADR Credential Policy Arguments
--dps-name -n

Nome ou nome do host do Serviço de Provisionamento de Dispositivos do Hub IoT do Azure. Necessário se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service Identifier Arguments
--edge-enabled --ee

Sinalizador que indica a habilitação de borda.

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--ih --iot-hubs

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.

Propriedade Valor
Grupo de parâmetros: Allocation Policy Arguments
--initial-twin-properties --props

Propriedades iniciais do dispositivo gêmeo.

--initial-twin-tags --tags

Marcas de dispositivo gêmeo iniciais.

--login -l

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão tem prioridade. Obrigatório se --dps-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service Identifier Arguments
--pk --primary-key

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

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--provisioning-status --ps

Habilitar ou desabilitar a entrada de registro.

Propriedade Valor
Valores aceitos: disabled, enabled
--reprovision-policy --rp

Política para determinar como os dados do dispositivo devem ser tratados no reprovisionamento para um Hub IoT diferente.

Propriedade Valor
Valores aceitos: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

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

--scn --secondary-ca-name --secondary-root-ca-name

O nome do certificado de AC raiz secundário. Se o atestado com um certificado de AC raiz for desejado, um nome de autoridade de certificação raiz deverá ser fornecido.

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--scp --secondary-certificate-path

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 deverá ser fornecido.

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--secondary-key --sk

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

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--webhook-url --wh

A URL do webhook do Azure Function usada para solicitações de alocação personalizadas.

Propriedade Valor
Grupo de parâmetros: Allocation Policy Arguments
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot dps enrollment-group delete

Exclua um grupo de registro em um Serviço de Provisionamento de Dispositivos do Hub IoT do Azure.

az iot dps enrollment-group delete --eid --enrollment-id --gid --group-id
                                   [--auth-type {key, login}]
                                   [--dps-name]
                                   [--etag]
                                   [--login]
                                   [--resource-group]

Parâmetros Exigidos

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

ID do grupo de registro.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja necessário. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Valor padrão: key
Valores aceitos: key, login
--dps-name -n

Nome ou nome do host do Serviço de Provisionamento de Dispositivos do Hub IoT do Azure. Necessário se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service Identifier Arguments
--etag -e

Marca de etag ou entidade correspondente ao último estado do recurso. Se nenhuma etag for fornecida, o valor '*' será usado.

--login -l

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão tem prioridade. Obrigatório se --dps-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service 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 Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot dps enrollment-group list

Listar grupos de registros em um Serviço de Provisionamento de Dispositivos no Hub IoT do Azure.

az iot dps enrollment-group list [--auth-type {key, login}]
                                 [--dps-name]
                                 [--login]
                                 [--resource-group]
                                 [--top]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja necessário. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Valor padrão: key
Valores aceitos: key, login
--dps-name -n

Nome ou nome do host do Serviço de Provisionamento de Dispositivos do Hub IoT do Azure. Necessário se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service Identifier Arguments
--login -l

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão tem prioridade. Obrigatório se --dps-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service 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 serem retornados. Use -1 para ilimitado.

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot dps enrollment-group show

Obtenha os detalhes de um grupo de registro em um Serviço de Provisionamento de Dispositivos no Hub IoT do Azure.

az iot dps enrollment-group show --eid --enrollment-id --gid --group-id
                                 [--auth-type {key, login}]
                                 [--dps-name]
                                 [--keys --show-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 em resultados para 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

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

ID do grupo de registro.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja necessário. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Valor padrão: key
Valores aceitos: key, login
--dps-name -n

Nome ou nome do host do Serviço de Provisionamento de Dispositivos do Hub IoT do Azure. Necessário se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service Identifier Arguments
--keys --show-keys

Inclua chaves de atestado e informações nos resultados do grupo de registro.

Propriedade Valor
Valores aceitos: false, true
--login -l

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão tem prioridade. Obrigatório se --dps-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service 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 Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot dps enrollment-group update

Atualize um grupo de registro em um Serviço de Provisionamento de Dispositivos 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 --enrollment-id --gid --group-id
                                   [--allocation-policy --ap {custom, geoLatency, hashed, static}]
                                   [--api-version --av]
                                   [--auth-type {key, login}]
                                   [--ca-name --cn --root-ca-name]
                                   [--certificate-path --cp]
                                   [--cpn --credential-policy-name]
                                   [--dps-name]
                                   [--edge-enabled --ee {false, true}]
                                   [--etag]
                                   [--ih --iot-hubs]
                                   [--initial-twin-properties --props]
                                   [--initial-twin-tags --tags]
                                   [--login]
                                   [--pk --primary-key]
                                   [--provisioning-status --ps {disabled, enabled}]
                                   [--rc --remove-certificate {false, true}]
                                   [--remove-secondary-certificate --rsc {false, true}]
                                   [--reprovision-policy --rp {never, reprovisionandmigratedata, reprovisionandresetdata}]
                                   [--resource-group]
                                   [--scn --secondary-ca-name --secondary-root-ca-name]
                                   [--scp --secondary-certificate-path]
                                   [--secondary-key --sk]
                                   [--webhook-url --wh]

Exemplos

Atualize o grupo de registro '{enrollment_id}' no serviço de provisionamento de IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name}' com as propriedades do gêmeo inicial e as 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 de IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name}' com 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 de IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name}' com o novo certificado de AC secundário '{certificate_name}' e remova o certificado de AC 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 de IoT do Azure '{dps_name}' no grupo de recursos '{resource_group_name}' com a 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=

Atualize o grupo de registro '{enrollment_id}' no Serviço de Provisionamento de Dispositivos IoT do Azure '{dps_name}' para usar uma Política de Credencial de Namespace ADR personalizada.

az iot dps enrollment-group update -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --credential-policy-name {my_policy}

Parâmetros Exigidos

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

ID do grupo de registro.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--allocation-policy --ap

Tipo de política de alocação para determinar como um dispositivo é atribuído a um Hub IoT. Se não for fornecido, a política de alocação será o conjunto padrão da política de alocação atual para a instância do Serviço de Provisionamento de Dispositivos.

Propriedade Valor
Grupo de parâmetros: Allocation Policy Arguments
Valores aceitos: custom, geoLatency, hashed, static
--api-version --av

A versão da API dos tipos de serviço de provisionamento enviados na solicitação de alocação personalizada. Versão mínima com suporte: 2018-09-01-preview.

Propriedade Valor
Grupo de parâmetros: Allocation Policy Arguments
--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 logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja necessário. Você pode configurar o padrão usando az configure --defaults iotdps-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Valor padrão: key
Valores aceitos: key, login
--ca-name --cn --root-ca-name

O nome do certificado de AC raiz primário. Se o atestado com um certificado de AC raiz for desejado, um nome de autoridade de certificação raiz deverá ser fornecido.

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--certificate-path --cp

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 deverá ser fornecido.

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--cpn --credential-policy-name

Nome da política de credencial do namespace de ADR.

Propriedade Valor
Grupo de parâmetros: ADR Credential Policy Arguments
--dps-name -n

Nome ou nome do host do Serviço de Provisionamento de Dispositivos do Hub IoT do Azure. Necessário se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service Identifier Arguments
--edge-enabled --ee

Sinalizador que indica a habilitação de borda.

Propriedade Valor
Valores aceitos: false, true
--etag -e

Marca de etag ou entidade correspondente ao último estado do recurso. Se nenhuma etag for fornecida, o valor '*' será usado.

--ih --iot-hubs

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.

Propriedade Valor
Grupo de parâmetros: Allocation Policy Arguments
--initial-twin-properties --props

Propriedades iniciais do dispositivo gêmeo.

--initial-twin-tags --tags

Marcas de dispositivo gêmeo iniciais.

--login -l

Esse comando dá suporte a uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão tem prioridade. Obrigatório se --dps-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: Device Provisioning Service Identifier Arguments
--pk --primary-key

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

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--provisioning-status --ps

Habilitar ou desabilitar a entrada de registro.

Propriedade Valor
Valores aceitos: disabled, enabled
--rc --remove-certificate

Sinalizador para remover o certificado primário atual.

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
Valores aceitos: false, true
--remove-secondary-certificate --rsc

Sinalizador para remover o certificado secundário atual.

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
Valores aceitos: false, true
--reprovision-policy --rp

Política para determinar como os dados do dispositivo devem ser tratados no reprovisionamento para um Hub IoT diferente.

Propriedade Valor
Valores aceitos: never, reprovisionandmigratedata, reprovisionandresetdata
--resource-group -g

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

--scn --secondary-ca-name --secondary-root-ca-name

O nome do certificado de AC raiz secundário. Se o atestado com um certificado de AC raiz for desejado, um nome de autoridade de certificação raiz deverá ser fornecido.

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--scp --secondary-certificate-path

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 deverá ser fornecido.

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--secondary-key --sk

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

Propriedade Valor
Grupo de parâmetros: Authentication Arguments
--webhook-url --wh

A URL do webhook do Azure Function usada para solicitações de alocação personalizadas.

Propriedade Valor
Grupo de parâmetros: Allocation Policy Arguments
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False