az iot central enrollment-group

Nota:

Esta referencia forma parte de la extensión azure-iot para la CLI de Azure (versión 2.37.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az iot central enrollment-group . Obtenga más información sobre las extensiones.

Administrar y configurar el grupo de inscripción de IoT Central.

Comandos

Nombre Description Tipo Estado
az iot central enrollment-group create

Cree un grupo de inscripción.

Extensión GA
az iot central enrollment-group delete

Elimine un grupo de inscripción por identificador.

Extensión GA
az iot central enrollment-group generate-verification-code

Genere un código de verificación para el certificado x509 principal o secundario de un grupo de inscripción.

Extensión GA
az iot central enrollment-group list

Obtenga la lista de grupos de inscripción en una aplicación.

Extensión GA
az iot central enrollment-group show

Obtenga detalles sobre un grupo de inscripción por identificador.

Extensión GA
az iot central enrollment-group update

Actualizar un grupo de inscripción.

Extensión GA
az iot central enrollment-group verify-certificate

Compruebe el certificado x509 principal o secundario de un grupo de inscripción.

Extensión GA

az iot central enrollment-group create

Cree un grupo de inscripción.

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]

Ejemplos

Creación de un grupo de inscripción

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

Creación de un grupo de inscripción con la certificación principal x509

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

Creación de un grupo de inscripción con una certificación de clave simétrica determinada

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--at --attestation-type

Mecanismo de atestación para el grupo de inscripción. Solo se permiten 'x509' o 'symmetricKey'. De forma predeterminada, se usará "symmetricKey" para la atestación.

valores aceptados: symmetricKey, x509
valor predeterminado: symmetricKey
--display-name

Nombre para mostrar del grupo de inscripción.

--group-id --id

Identificador único del grupo de inscripción.

--type

Tipo de dispositivos que se conectan a través del grupo.

Parámetros opcionales

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

valores aceptados: 2022-06-30-preview, 2022-07-31
valor predeterminado: 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

valor predeterminado: azureiotcentral.com
--certificate-path --cp

Ruta de acceso al archivo que contiene el certificado principal.

--etag -e

Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.

--pk --primary-key

Clave de acceso compartido simétrica principal almacenada en formato base64.

--provisioning-status --ps

Si los dispositivos que usan el grupo pueden conectarse a IoT Central. True o False.

valores aceptados: disabled, enabled
valor predeterminado: enabled
--scp --secondary-certificate-path

Ruta de acceso al archivo que contiene el certificado secundario.

--secondary-key --sk

Clave de acceso compartido simétrica secundaria almacenada en formato base64.

--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central enrollment-group delete

Elimine un grupo de inscripción por identificador.

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

Ejemplos

Eliminación de un grupo de inscripción por identificador

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--group-id --id

Identificador único del grupo de inscripción.

Parámetros opcionales

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

valores aceptados: 2022-06-30-preview, 2022-07-31
valor predeterminado: 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

valor predeterminado: azureiotcentral.com
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central enrollment-group generate-verification-code

Genere un código de verificación para el certificado x509 principal o secundario de un grupo de inscripción.

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]

Ejemplos

Generación de un código de verificación para el certificado x509 principal de un grupo de inscripción

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--group-id --id

Identificador único del grupo de inscripción.

Parámetros opcionales

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

valores aceptados: 2022-06-30-preview, 2022-07-31
valor predeterminado: 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

valor predeterminado: azureiotcentral.com
--certificate-entry --entry

Tipo de entrada del certificado x509 que solo permite "principal" y "secundario".

valores aceptados: primary, secondary
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central enrollment-group list

Obtenga la lista de grupos de inscripción en una aplicación.

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

Ejemplos

Obtener la lista de grupos de inscripción en una aplicación

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

Parámetros opcionales

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

valores aceptados: 2022-06-30-preview, 2022-07-31
valor predeterminado: 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

valor predeterminado: azureiotcentral.com
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central enrollment-group show

Obtenga detalles sobre un grupo de inscripción por identificador.

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]

Ejemplos

Obtención de detalles sobre un grupo de inscripción por identificador

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--group-id --id

Identificador único del grupo de inscripción.

Parámetros opcionales

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

valores aceptados: 2022-06-30-preview, 2022-07-31
valor predeterminado: 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

valor predeterminado: azureiotcentral.com
--certificate-entry --entry

Tipo de entrada del certificado x509 que solo permite "principal" y "secundario".

valores aceptados: primary, secondary
--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central enrollment-group update

Actualizar un grupo de inscripción.

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]

Ejemplos

Actualización de un grupo de inscripción

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

Eliminación del certificado principal x509 de un grupo de inscripción

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--group-id --id

Identificador único del grupo de inscripción.

Parámetros opcionales

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

valores aceptados: 2022-06-30-preview, 2022-07-31
valor predeterminado: 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

valor predeterminado: azureiotcentral.com
--certificate-entry --entry

Tipo de entrada del certificado x509 que solo permite "principal" y "secundario".

valores aceptados: primary, secondary
--certificate-path --cp

Ruta de acceso al archivo que contiene el certificado principal.

--display-name

Nombre para mostrar del grupo de inscripción.

--etag

ETag usado para evitar conflictos en las actualizaciones del grupo de inscripción.

--provisioning-status --ps

Si los dispositivos que usan el grupo pueden conectarse a IoT Central. True o False.

valores aceptados: disabled, enabled
valor predeterminado: enabled
--remove-x509

Si el certificado x509 debe quitarse del grupo. True o False.

valores aceptados: false, true
--scp --secondary-certificate-path

Ruta de acceso al archivo que contiene el certificado secundario.

--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

--type

Tipo de dispositivos que se conectan a través del grupo.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az iot central enrollment-group verify-certificate

Compruebe el certificado x509 principal o secundario de un grupo de inscripción.

Compruebe el certificado x509 principal o secundario de un grupo de inscripción proporcionando un certificado con el código de verificación firmado.

Tenga en cuenta que si se creó un grupo de inscripción con un certificado x509 no comprobado, deberá crearse un certificado de verificación con el certificado x509 no comprobado y un código de verificación antes de usar este comando. Se puede generar un código de verificación a través de la cli mediante el comando "enrollment-group generate-verification-code". Obtenga más información sobre cómo crear certificados de verificación mediante código de verificación en 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]

Ejemplos

Comprobación del certificado x509 principal de un grupo de inscripción

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

Parámetros requeridos

--app-id -n

El identificador de aplicación de la aplicación de IoT Central que quiere administrar. Puede encontrar el identificador de aplicación en la página "Acerca de" de la aplicación en el menú de ayuda.

--group-id --id

Identificador único del grupo de inscripción.

Parámetros opcionales

--api-version --av
Obsoleto

El argumento "api_version" está en desuso y se quitará en una versión futura.

Este parámetro de comando está en desuso y se omitirá. En la versión futura, solo se admitirán las API de IoT Central desde la versión más reciente de disponibilidad general. Si alguna API aún no está disponible, llamaremos a la versión preliminar más reciente.

valores aceptados: 2022-06-30-preview, 2022-07-31
valor predeterminado: 2022-07-31
--central-api-uri --central-dns-suffix

Sufijo DNS de IoT Central asociado a la aplicación.

valor predeterminado: azureiotcentral.com
--certificate-path --cp

Ruta de acceso al archivo que contiene el certificado principal.

--scp --secondary-certificate-path

Ruta de acceso al archivo que contiene el certificado secundario.

--token

Si prefiere enviar la solicitud sin autenticarse en la CLI de Azure, puede especificar un token de usuario válido para autenticar la solicitud. Debe especificar el tipo de clave como parte de la solicitud. Obtenga más información en https://aka.ms/iotcentraldocsapi.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.