az iot central device-group

Notitie

Deze verwijzing maakt deel uit van de Azure-iot-extensie voor de Azure CLI (versie 2.46.0 of hoger). De extensie installeert automatisch de eerste keer dat u een opdracht az iot central device-group uitvoert. Meer informatie over extensies.

IoT Central-apparaatgroepen beheren en configureren.

Opdracht

Name	Description	Type	Status
az iot central device-group create	Maak een apparaatgroep.	Toestel	GA
az iot central device-group delete	Een apparaatgroep verwijderen.	Toestel	GA
az iot central device-group list	Haal de lijst met apparaatgroepen voor een IoT Central-toepassing op.	Toestel	GA
az iot central device-group show	Haal de apparaatgroep op id op.	Toestel	GA
az iot central device-group update	Een bestaande apparaatgroep bijwerken.	Toestel	GA

az iot central device-group create

Maak een apparaatgroep.

Opmerking: er wordt momenteel slechts één organisatie ondersteund. Meerdere organisaties worden binnenkort ondersteund.

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]

Voorbeelden

Maak een apparaatgroep.

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}

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--device-group-id

Unieke id van de apparaatgroep.

--display-name

Weergavenaam van de apparaatgroep.

--filter

Query definiëren welke apparaten zich in deze groep moeten bevinden. [Voorbeeld van queryfilter: SELECT * FROM devices WHERE $template = "dtmi:modelDefinition:dtdlv2"].

Optionele parameters

--api-version --av

Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31

standaardwaarde: 2022-07-31

--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com

--description

Korte samenvatting van apparaatgroep.

--organizations

Lijst met organisatie-id's van de apparaatgroep.

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

standaardwaarde: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central device-group delete

Een apparaatgroep verwijderen.

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

Voorbeelden

Een apparaatgroep verwijderen

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--device-group-id

Unieke id van de apparaatgroep.

Optionele parameters

--api-version --av

Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31

standaardwaarde: 2022-07-31

--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

standaardwaarde: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central device-group list

Haal de lijst met apparaatgroepen voor een IoT Central-toepassing op.

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

Voorbeelden

Apparaatgroepen weergeven in een toepassing

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

Optionele parameters

--api-version --av

Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31

standaardwaarde: 2022-07-31

--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

standaardwaarde: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central device-group show

Haal de apparaatgroep op id op.

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

Voorbeelden

Haal de apparaatgroep op id op.

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--device-group-id

Unieke id van de apparaatgroep.

Optionele parameters

--api-version --av

Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31

standaardwaarde: 2022-07-31

--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

standaardwaarde: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az iot central device-group update

Een bestaande apparaatgroep bijwerken.

Opmerking: er wordt momenteel slechts één organisatie ondersteund. Meerdere organisaties worden binnenkort ondersteund.

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]

Voorbeelden

Een apparaatgroep bijwerken via patch

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

Vereiste parameters

--app-id -n

De app-id van de IoT Central-app die u wilt beheren. U vindt de app-id op de pagina Info voor uw toepassing onder het menu Help.

--device-group-id

Unieke id van de apparaatgroep.

Optionele parameters

--api-version --av

Afgeschaft

Het argument 'api_version' is afgeschaft en wordt in een toekomstige release verwijderd.

Deze opdrachtparameter is afgeschaft en wordt genegeerd. In de toekomstige release ondersteunen we alleen IoT Central-API's van de nieuwste GA-versie. Als er nog geen API beschikbaar is, roepen we de nieuwste preview-versie aan.

geaccepteerde waarden: 2022-06-30-preview, 2022-07-31

standaardwaarde: 2022-07-31

--central-api-uri --central-dns-suffix

Het DNS-achtervoegsel ioT Central dat is gekoppeld aan uw toepassing.

standaardwaarde: azureiotcentral.com

--description

Korte samenvatting van apparaatgroep.

--display-name

Weergavenaam van de apparaatgroep.

--filter

Query definiëren welke apparaten zich in deze groep moeten bevinden. [Voorbeeld van queryfilter: SELECT * FROM devices WHERE $template = "dtmi:modelDefinition:dtdlv2"].

--organizations

Lijst met organisatie-id's van de apparaatgroep.

--token

Als u liever uw aanvraag indient zonder verificatie bij de Azure CLI, kunt u een geldig gebruikerstoken opgeven om uw aanvraag te verifiëren. U moet het type sleutel opgeven als onderdeel van de aanvraag. Meer informatie op https://aka.ms/iotcentraldocsapi.

Globale parameters

--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc

standaardwaarde: json

--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.