Compartir a través de


az iot central device-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 device-group . Obtenga más información sobre las extensiones.

Administrar y configurar grupos de dispositivos de IoT Central.

Comandos

Nombre Description Tipo Estado
az iot central device-group create

Cree un grupo de dispositivos.

Extensión GA
az iot central device-group delete

Eliminar un grupo de dispositivos.

Extensión GA
az iot central device-group list

Obtenga la lista de grupos de dispositivos para una aplicación de IoT Central.

Extensión GA
az iot central device-group show

Obtenga el grupo de dispositivos por identificador.

Extensión GA
az iot central device-group update

Actualice un grupo de dispositivos existente.

Extensión GA

az iot central device-group create

Cree un grupo de dispositivos.

Nota: Actualmente solo se admite una organización, se admitirán próximamente varias organizaciones.

az iot central device-group create --app-id
                                   --device-group-id
                                   --display-name
                                   --filter
                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--description]
                                   [--organizations]
                                   [--token]

Ejemplos

Cree un grupo de dispositivos.

az iot central device-group create --app-id {appid} --device-group-id {devicegroupid} --display-name "DeviceGroup1" --filter "SELECT * FROM devices WHERE $provisioned = true" --description "This is a default device group." --organizations {organization}

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.

--device-group-id

Identificador único del grupo de dispositivos.

--display-name

Nombre para mostrar del grupo de dispositivos.

--filter

Consulta que define qué dispositivos deben estar en este grupo. [Ejemplo de filtro de consulta: SELECT * FROM devices WHERE $template = "dtmi:modelDefinition:dtdlv2"].

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
--description

Resumen breve del grupo de dispositivos.

--organizations

Lista de identificadores de organización del grupo de dispositivos.

--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 device-group delete

Eliminar un grupo de dispositivos.

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

Ejemplos

Eliminación de un grupo de dispositivos

az iot central device-group delete --app-id {appid} --device-group-id {devicegroupid}

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.

--device-group-id

Identificador único del grupo de dispositivos.

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 device-group list

Obtenga la lista de grupos de dispositivos para una aplicación de IoT Central.

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

Ejemplos

Enumeración de grupos de dispositivos en una aplicación

az iot central device-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 device-group show

Obtenga el grupo de dispositivos por identificador.

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

Ejemplos

Obtenga el grupo de dispositivos por identificador.

az iot central device-group show --app-id {appid} --device-group-id {devicegroupid}

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.

--device-group-id

Identificador único del grupo de dispositivos.

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 device-group update

Actualice un grupo de dispositivos existente.

Nota: Actualmente solo se admite una organización, se admitirán próximamente varias organizaciones.

az iot central device-group update --app-id
                                   --device-group-id
                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--description]
                                   [--display-name]
                                   [--filter]
                                   [--organizations]
                                   [--token]

Ejemplos

Actualización de un grupo de dispositivos a través de la revisión

az iot central device-group update --app-id {appid} --device-group-id {devicegroupid} --display-name {displayname} --filter {filter} --description {description} --organizations {organization}

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.

--device-group-id

Identificador único del grupo de dispositivos.

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
--description

Resumen breve del grupo de dispositivos.

--display-name

Nombre para mostrar del grupo de dispositivos.

--filter

Consulta que define qué dispositivos deben estar en este grupo. [Ejemplo de filtro de consulta: SELECT * FROM devices WHERE $template = "dtmi:modelDefinition:dtdlv2"].

--organizations

Lista de identificadores de organización del grupo de dispositivos.

--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.