az iot central enrollment-group
Nota:
Esta referencia forma parte de la extensión azure-iot para la CLI de Azure (versión 2.46.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
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.
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.
Nombre para mostrar del grupo de inscripción.
Identificador único del grupo de inscripción.
Tipo de dispositivos que se conectan a través del grupo.
Parámetros opcionales
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.
Sufijo DNS de IoT Central asociado a la aplicación.
Ruta de acceso al archivo que contiene el certificado principal.
Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.
Clave de acceso compartido simétrica principal almacenada en formato base64.
Si los dispositivos que usan el grupo pueden conectarse a IoT Central. Verdadero o Falso.
Ruta de acceso al archivo que contiene el certificado secundario.
Clave de acceso compartido simétrica secundaria almacenada en formato base64.
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
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
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
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.
Identificador único del grupo de inscripción.
Parámetros opcionales
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.
Sufijo DNS de IoT Central asociado a la aplicación.
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
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
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
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.
Identificador único del grupo de inscripción.
Parámetros opcionales
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.
Sufijo DNS de IoT Central asociado a la aplicación.
Tipo de entrada del certificado x509 que solo permite "principal" y "secundario".
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
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
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
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
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.
Sufijo DNS de IoT Central asociado a la aplicación.
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
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
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
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.
Identificador único del grupo de inscripción.
Parámetros opcionales
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.
Sufijo DNS de IoT Central asociado a la aplicación.
Tipo de entrada del certificado x509 que solo permite "principal" y "secundario".
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
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
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
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.
Identificador único del grupo de inscripción.
Parámetros opcionales
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.
Sufijo DNS de IoT Central asociado a la aplicación.
Tipo de entrada del certificado x509 que solo permite "principal" y "secundario".
Ruta de acceso al archivo que contiene el certificado principal.
Nombre para mostrar del grupo de inscripción.
ETag usado para evitar conflictos en las actualizaciones del grupo de inscripción.
Si los dispositivos que usan el grupo pueden conectarse a IoT Central. Verdadero o Falso.
Si el certificado x509 debe quitarse del grupo. Verdadero o Falso.
Ruta de acceso al archivo que contiene el certificado secundario.
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.
Tipo de dispositivos que se conectan a través del grupo.
Parámetros globales
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
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
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.
Identificador único del grupo de inscripción.
Parámetros opcionales
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.
Sufijo DNS de IoT Central asociado a la aplicación.
Ruta de acceso al archivo que contiene el certificado principal.
Ruta de acceso al archivo que contiene el certificado secundario.
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
Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.
Muestre este mensaje de ayuda y salga.
Mostrar solo los errores y suprimir las advertencias.
Formato de salida.
Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.
Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.
