az iot dps 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 dps enrollment-group . Obtenga más información sobre las extensiones.
Administrar grupos de inscripción en una instancia de Azure IoT Hub Device Provisioning Service.
Comandos
Nombre | Description | Tipo | Estado |
---|---|---|---|
az iot dps enrollment-group compute-device-key |
Genere una clave SAS de dispositivo derivada para un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment-group create |
Cree un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment-group delete |
Elimine un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment-group list |
Enumera los grupos de inscripciones en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment-group registration |
Administrar registros de dispositivos del lado del servicio para un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment-group registration delete |
Elimine un registro de dispositivos para un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment-group registration list |
Enumere los registros de dispositivos de un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment-group registration show |
Obtenga un registro de dispositivos para un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment-group show |
Obtenga los detalles de un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment-group update |
Actualice un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning. |
Extensión | GA |
az iot dps enrollment-group compute-device-key
Genere una clave SAS de dispositivo derivada para un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning.
az iot dps enrollment-group compute-device-key --registration-id
[--auth-type {key, login}]
[--dps-name]
[--eid]
[--key]
[--login]
[--resource-group]
Ejemplos
Calcule la clave de dispositivo con la clave simétrica especificada.
az iot dps enrollment-group compute-device-key --key {enrollement_group_symmetric_key} --registration-id {registration_id}
Calcule la clave de dispositivo con el grupo de inscripción 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 requeridos
Identificador del registro de dispositivos.
Parámetros opcionales
Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Identificador del grupo de inscripción.
Clave de acceso compartido simétrica para el grupo de inscripción. Esto omite el registro de Device Provisioning Service y genera el token de SAS directamente desde la clave simétrica proporcionada sin ninguna validación adicional. Se omitirán todos los demás parámetros de comando aparte del identificador de registro.
Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --dps-name.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
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 dps enrollment-group create
Cree un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning.
Proporcione el formato de certificado mediante la codificación ASCII base64 y el certificado debe tener segmentos BEGIN y END coincidentes, por ejemplo: comience con "-----BEGIN CERTIFICATE-----" y termine con "-----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]
Ejemplos
Cree un grupo de inscripción '{enrollment_id}' en el servicio de aprovisionamiento de Azure IoT '{dps_name}' en el grupo de recursos '{resource_group_name} mediante un certificado intermedio 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
Cree un grupo de inscripción '{enrollment_id}' en el servicio de aprovisionamiento de Azure IoT '{dps_name}' en el grupo de recursos '{resource_group_name} mediante un certificado de ENTIDAD de certificación {certificate_name} como certificado secundario'.
az iot dps enrollment-group create -g {resource_group_name} --dps-name {dps_name} --enrollment-id {enrollment_id} --secondary-ca-name {certificate_name}
Cree un grupo de inscripción '{enrollment_id}' en el servicio de aprovisionamiento de Azure IoT 'MyDps' en el grupo de recursos '{resource_group_name}' con el estado de aprovisionamiento 'enabled', las propiedades iniciales del gemelo '{"location":{"region":"US"}}' y las etiquetas gemelas iniciales '{"version_dps":"1"}" mediante un certificado intermedio 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'}"
Cree un grupo de inscripción '{enrollment_id}' en el servicio de aprovisionamiento de Azure IoT '{dps_name}' en el grupo de recursos '{resource_group_name} con el tipo de atestación '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}
Crear un grupo de inscripción '{enrollment_id}' con la directiva de asignación 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 requeridos
Identificador del grupo de inscripción.
Parámetros opcionales
Tipo de directiva de asignación para determinar cómo se asigna un dispositivo a una instancia de IoT Hub. Si no se proporciona, la directiva de asignación será el valor predeterminado de la directiva de asignación actual establecida para la instancia de Device Provisioning Service.
La versión de API de los tipos de servicio de aprovisionamiento enviados en la solicitud de asignación personalizada. Versión mínima admitida: 2018-09-01-preview.
Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Nombre del certificado de entidad de certificación raíz principal. Si se desea la atestación con un certificado de entidad de certificación raíz, se debe proporcionar un nombre de ca raíz.
Ruta de acceso al archivo que contiene el certificado principal. Si se desea la atestación con un certificado intermedio, se debe proporcionar una ruta de acceso del certificado.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Marca que indica la habilitación del borde.
Nombre de host de IoT Hub de destino asociado a la directiva de asignación. Use la lista separada por espacios para varias instancias de IoT Hub.
Propiedades iniciales del dispositivo gemelo.
Etiquetas de dispositivo gemelo iniciales.
Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --dps-name.
Clave de acceso compartido simétrica principal almacenada en formato base64.
Habilite o deshabilite la entrada de inscripción.
Directiva para determinar cómo se deben controlar los datos del dispositivo al volver a aprovisionar en otra instancia de IoT Hub.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Nombre del certificado de entidad de certificación raíz secundaria. Si se desea la atestación con un certificado de entidad de certificación raíz, se debe proporcionar un nombre de ca raíz.
Ruta de acceso al archivo que contiene el certificado secundario. Si se desea la atestación con un certificado intermedio, se debe proporcionar una ruta de acceso del certificado.
Clave de acceso compartido simétrica secundaria almacenada en formato base64.
La dirección URL del webhook de Azure Functions que se usa para las solicitudes de asignación personalizadas.
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 dps enrollment-group delete
Elimine un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning.
az iot dps enrollment-group delete --eid
[--auth-type {key, login}]
[--dps-name]
[--etag]
[--login]
[--resource-group]
Parámetros requeridos
Identificador del grupo de inscripción.
Parámetros opcionales
Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.
Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --dps-name.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
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 dps enrollment-group list
Enumera los grupos de inscripciones en un servicio Azure IoT Hub Device Provisioning.
az iot dps enrollment-group list [--auth-type {key, login}]
[--dps-name]
[--login]
[--resource-group]
[--top]
Parámetros opcionales
Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --dps-name.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Número máximo de elementos que se van a devolver. Use -1 para ilimitado.
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 dps enrollment-group show
Obtenga los detalles de un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning.
az iot dps enrollment-group show --eid
[--auth-type {key, login}]
[--dps-name]
[--keys {false, true}]
[--login]
[--resource-group]
Ejemplos
Uso básico
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {enrollment_id}
Incluir información de atestación completa en los resultados de un grupo de inscripción de claves simétricas
az iot dps enrollment-group show --dps-name {dps_name} -g {resource_group} --enrollment-id {symmetric_key_enrollment_id} --show-keys
Parámetros requeridos
Identificador del grupo de inscripción.
Parámetros opcionales
Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Incluya claves de atestación e información en los resultados del grupo de inscripción.
Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --dps-name.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
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 dps enrollment-group update
Actualice un grupo de inscripción en un servicio Azure IoT Hub Device Provisioning.
Proporcione el formato de certificado mediante la codificación ASCII base64 y el certificado debe tener segmentos BEGIN y END coincidentes, por ejemplo: comience con "-----BEGIN CERTIFICATE-----" y termine con "-----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]
Ejemplos
Actualice el grupo de inscripción '{enrollment_id}' en el servicio de aprovisionamiento de Azure IoT '{dps_name}' del grupo de recursos '{resource_group_name}' con las propiedades iniciales del gemelo y las etiquetas de gemelo iniciales.
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=
Actualice el grupo de inscripción '{enrollment_id}' en el servicio de aprovisionamiento de Azure IoT '{dps_name}' en el grupo de recursos '{resource_group_name}' con el nuevo certificado intermedio principal y quite el certificado intermedio secundario 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=
Actualice el grupo de inscripción '{enrollment_id}' en el servicio de aprovisionamiento de Azure IoT '{dps_name}' en el grupo de recursos '{resource_group_name}' con el nuevo certificado de CA secundario '{certificate_name}' y quite el certificado de entidad de certificación principal 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=
Actualice el grupo de inscripción '{enrollment_id}' en el servicio de aprovisionamiento de Azure IoT '{dps_name}' en el grupo de recursos '{resource_group_name}' con la nueva clave principal.
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 requeridos
Identificador del grupo de inscripción.
Parámetros opcionales
Tipo de directiva de asignación para determinar cómo se asigna un dispositivo a una instancia de IoT Hub. Si no se proporciona, la directiva de asignación será el valor predeterminado de la directiva de asignación actual establecida para la instancia de Device Provisioning Service.
La versión de API de los tipos de servicio de aprovisionamiento enviados en la solicitud de asignación personalizada. Versión mínima admitida: 2018-09-01-preview.
Indica si la operación debe derivar automáticamente una clave de directiva o usar la sesión actual de Azure AD. Si el tipo de autenticación es login y se proporciona el nombre de host del recurso, se omitirá la búsqueda de recursos a menos que sea necesario. Puede configurar el valor predeterminado mediante az configure --defaults iotdps-data-auth-type=<auth-type-value>
.
Nombre del certificado de entidad de certificación raíz principal. Si se desea la atestación con un certificado de entidad de certificación raíz, se debe proporcionar un nombre de ca raíz.
Ruta de acceso al archivo que contiene el certificado principal. Si se desea la atestación con un certificado intermedio, se debe proporcionar una ruta de acceso del certificado.
Nombre o nombre de host del servicio Azure IoT Hub Device Provisioning. Obligatorio si no se proporciona --login.
Marca que indica la habilitación del borde.
Etag o etiqueta de entidad correspondiente al último estado del recurso. Si no se proporciona ninguna etag, se usa el valor '*'.
Nombre de host de IoT Hub de destino asociado a la directiva de asignación. Use la lista separada por espacios para varias instancias de IoT Hub.
Propiedades iniciales del dispositivo gemelo.
Etiquetas de dispositivo gemelo iniciales.
Este comando admite una entidad cadena de conexión con derechos para realizar la acción. Use para evitar el inicio de sesión de sesión a través de "az login". Si se proporcionan las cadena de conexión y el nombre de una entidad, el cadena de conexión tiene prioridad. Obligatorio si no se proporciona --dps-name.
Clave de acceso compartido simétrica principal almacenada en formato base64.
Habilite o deshabilite la entrada de inscripción.
Marca para quitar el certificado principal actual.
Marca para quitar el certificado secundario actual.
Directiva para determinar cómo se deben controlar los datos del dispositivo al volver a aprovisionar en otra instancia de IoT Hub.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Nombre del certificado de entidad de certificación raíz secundaria. Si se desea la atestación con un certificado de entidad de certificación raíz, se debe proporcionar un nombre de ca raíz.
Ruta de acceso al archivo que contiene el certificado secundario. Si se desea la atestación con un certificado intermedio, se debe proporcionar una ruta de acceso del certificado.
Clave de acceso compartido simétrica secundaria almacenada en formato base64.
La dirección URL del webhook de Azure Functions que se usa para las solicitudes de asignación personalizadas.
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.