Delen via

az iot hub configuration

  • Referentie

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 az iot hub-configuratieopdracht uitvoert. Meer informatie over extensies.

Automatische configuratie van IoT-apparaatbeheer op schaal beheren.

Opdracht

Name Description Type Status
az iot hub configuration create

Maak een configuratie voor automatisch IoT-apparaatbeheer in een IoT-doel-IoT Hub.

 Toestel GA
az iot hub configuration delete

Een IoT-apparaatconfiguratie verwijderen.

 Toestel GA
az iot hub configuration list

Maak een lijst met configuraties voor automatisch apparaatbeheer van IoT in een IoT Hub.

 Toestel GA
az iot hub configuration show

De details van een configuratie voor automatisch apparaatbeheer van IoT ophalen.

 Toestel GA
az iot hub configuration show-metric

Evalueer een doelgebruiker of systeemmetriek die is gedefinieerd in een IoT-apparaatconfiguratie.

 Toestel GA
az iot hub configuration update

De opgegeven eigenschappen van een configuratie voor automatisch apparaatbeheer van IoT bijwerken.

 Toestel GA

az iot hub configuration create

Maak een configuratie voor automatisch IoT-apparaatbeheer in een IoT-doel-IoT Hub.

Configuratie-inhoud is json en enigszins varieert op basis van de intentie van het apparaat of de module.

Apparaatconfiguraties hebben de vorm van {"deviceContent":{...}} of {"content":{"deviceContent":{...}}}

Moduleconfiguraties hebben de vorm van {"moduleContent":{...}} of {"content":{"moduleContent":{...}}}

Configuraties kunnen worden gedefinieerd met metrische gegevens van de gebruiker voor evaluatie op aanvraag. Metrische gegevens van gebruikers zijn json en in de vorm van {"query's":{...}} of {"metrics":{"query's":{...}}}.

Opmerking: Doelvoorwaarde voor modules moet beginnen met 'vanaf devices.modules where'.

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl]
                                [--cmq]
                                [--hub-name]
                                [--lab]
                                [--login]
                                [--metrics]
                                [--pri]
                                [--resource-group]
                                [--target-condition]

Voorbeelden

Maak een apparaatconfiguratie met een prioriteit van 3 die van toepassing is op voorwaarde wanneer een apparaat wordt gelabeld in gebouw 9 en de omgeving 'test' is.

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Maak een apparaatconfiguratie met labels en geef inline metrische gegevens van gebruikers op (voorbeeld van bash-syntaxis).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

Een moduleconfiguratie maken met labels en inline gebruikersgegevens opgeven (cmd-syntaxisvoorbeeld)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

Maak een moduleconfiguratie met inline inhoud en metrische gegevens van gebruikers (powershell-syntaxisvoorbeeld).

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

Maak een apparaatconfiguratie met een alternatieve invoerstijl voor labels en metrische gegevens (shell-agnostisch).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Vereiste parameters

--config-id -c

Naam van doelapparaatconfiguratie. Kleine letters en de volgende speciale tekens zijn toegestaan: [-+%_*!].

--content -k

Apparaatconfiguratie-inhoud. Geef bestandspad of onbewerkte json op.

Optionele parameters

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login
Default value: key
--cl --custom-labels

Een alternatieve invoerstijl (spatie gescheiden sleutel-waardeparen) voor --labels en bedoeld om deze in de toekomst te vervangen. Voorbeeld van indeling: key1=value1 key2="dit is mijn waarde".

--cmq --custom-metric-queries

Een alternatieve invoerstijl (spatie gescheiden sleutel-waardeparen) voor --metrische gegevens en bedoeld om deze in de toekomst te vervangen. Voorbeeld van indeling: metric1="select deviceId from devices where tags.location='US'" metric2="select *".

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--lab --labels

Toewijzing van labels die moeten worden toegepast op de doelconfiguratie. Het gebruik van --custom-labels in plaats van --labels wordt aanbevolen. Voorbeeld van indeling: {"key0":"value0", "key1":"value1"}.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--metrics -m

Metrische definities voor apparaatconfiguratie. Geef bestandspad of onbewerkte json op. Het gebruik van --custom-metric-query's in plaats van --metrics wordt aanbevolen.

--pri --priority

Gewicht van de apparaatconfiguratie in het geval van concurrerende regels (hoogste overwinningen).

Default value: 0
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--target-condition --tc -t

Doelvoorwaarde waarop een apparaat- of moduleconfiguratie van toepassing is. Configuraties zonder doelvoorwaarde zijn gericht op geen apparaat of module. Gebruik de volgende indeling: 'tags.environment='test'.

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
Default value: 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 hub configuration delete

Een IoT-apparaatconfiguratie verwijderen.

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Vereiste parameters

--config-id -c

Naam van doelapparaatconfiguratie. Kleine letters en de volgende speciale tekens zijn toegestaan: [-+%_*!].

Optionele parameters

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login
Default value: key
--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

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
Default value: 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 hub configuration list

Maak een lijst met configuraties voor automatisch apparaatbeheer van IoT in een IoT Hub.

az iot hub configuration list [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]
                              [--top]

Optionele parameters

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login
Default value: key
--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--top

Maximum aantal configuraties dat moet worden geretourneerd. Standaard worden alle configuraties geretourneerd.

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
Default value: 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 hub configuration show

De details van een configuratie voor automatisch apparaatbeheer van IoT ophalen.

az iot hub configuration show --config-id
                              [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]

Vereiste parameters

--config-id -c

Naam van doelapparaatconfiguratie. Kleine letters en de volgende speciale tekens zijn toegestaan: [-+%_*!].

Optionele parameters

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login
Default value: key
--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

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
Default value: 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 hub configuration show-metric

Evalueer een doelgebruiker of systeemmetriek die is gedefinieerd in een IoT-apparaatconfiguratie.

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type {system, user}]
                                     [--resource-group]

Voorbeelden

De door de gebruiker gedefinieerde metrische waarde 'warningLimit' evalueren

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

De meetwaarde 'appliedCount' van het systeem evalueren

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

Vereiste parameters

--config-id -c

Naam van doelapparaatconfiguratie. Kleine letters en de volgende speciale tekens zijn toegestaan: [-+%_*!].

--metric-id -m

Doelmetriek voor evaluatie.

Optionele parameters

--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login
Default value: key
--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--metric-type --mt

Geeft aan welke verzameling metrische gegevens moet worden gebruikt om een metrische waarde op te zoeken.

Geaccepteerde waarden: system, user
Default value: user
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

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
Default value: 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 hub configuration update

De opgegeven eigenschappen van een configuratie voor automatisch apparaatbeheer van IoT bijwerken.

Gebruik --set gevolgd door eigenschapstoewijzingen voor het bijwerken van een configuratie.

Opmerking: configuratie-inhoud is onveranderbaar. Configuratie-eigenschappen die kunnen worden bijgewerkt, zijn 'labels', 'metrics', 'priority' en 'targetCondition'.

az iot hub configuration update --config-id
                                [--add]
                                [--auth-type {key, login}]
                                [--etag]
                                [--force-string]
                                [--hub-name]
                                [--login]
                                [--remove]
                                [--resource-group]
                                [--set]

Voorbeelden

De prioriteit van een apparaatconfiguratie wijzigen en de doelvoorwaarde bijwerken

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

Vereiste parameters

--config-id -c

Naam van doelapparaatconfiguratie. Kleine letters en de volgende speciale tekens zijn toegestaan: [-+%_*!].

Optionele parameters

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--auth-type

Hiermee wordt aangegeven of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. Als het verificatietype aanmelding is en de hostnaam van de resource wordt opgegeven, wordt het opzoeken van resources overgeslagen, tenzij dat nodig is. U kunt de standaardinstelling configureren met behulp van az configure --defaults iothub-data-auth-type=<auth-type-value>.

Geaccepteerde waarden: key, login
Default value: key
--etag -e

Etag of entiteitstag die overeenkomt met de laatste status van de resource. Als er geen etag wordt opgegeven, wordt de waarde *gebruikt.

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

Default value: False
--hub-name -n

Naam of hostnaam van IoT Hub. Vereist als --login niet is opgegeven.

--login -l

Deze opdracht ondersteunt een entiteit verbindingsreeks met rechten om actie uit te voeren. Gebruik dit om sessieaanmelding te voorkomen via 'az login'. Als zowel een entiteit verbindingsreeks als de naam wordt opgegeven, heeft de verbindingsreeks prioriteit. Vereist als --hub-name niet is opgegeven.

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Default value: []
--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

Default value: []
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
Default value: 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.