az iot hub configuration

Notitie

Deze verwijzing maakt deel uit van de azure-iot-extensie voor Azure CLI en vereist versie 2.17.1 of hoger. De extensie wordt automatisch geïnstalleerd wanneer u de eerste keer een opdracht az iot hub configuration hebt uitgevoerd. Meer informatie over extensies.

Automatische configuratie van IoT-apparaatbeheer op schaal beheren.

Opdracht

az iot hub configuration create

Maak een automatische IoT-configuratie voor apparaatbeheer in een IoT Hub.

az iot hub configuration delete

Een IoT-apparaatconfiguratie verwijderen.

az iot hub configuration list

IoT-configuraties voor automatisch apparaatbeheer in een IoT Hub.

az iot hub configuration show

De details van een automatische IoT-configuratie voor apparaatbeheer op halen.

az iot hub configuration show-metric

Evalueer de metrische gegevens van een doelgebruiker of -systeem die zijn gedefinieerd in een IoT-apparaatconfiguratie.

az iot hub configuration update

De opgegeven eigenschappen van een automatische IoT-apparaatbeheerconfiguratie 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', 'metrische gegevens', 'prioriteit' en 'targetCondition'.

az iot hub configuration create

Maak een automatische IoT-configuratie voor apparaatbeheer in een IoT Hub.

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

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

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

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

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

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--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 dat 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

Een apparaatconfiguratie met labels maken en inline metrische gegevens van gebruikers verstrekken (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 met labels maken en inline metrische gegevens van gebruikers verstrekken (voorbeeld van cmd-syntaxis)

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'\"}}}"

Een moduleconfiguratie maken met inline inhoud en metrische gegevens van gebruikers (voorbeeld van powershell-syntaxis)

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''\"}}}'

Vereiste parameters

--config-id -c

Configuratienaam van doelapparaat.

--content -k

Apparaatconfiguratie-inhoud. Geef het bestandspad of de onbewerkte json op.

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--lab --labels

Kaart van labels die moeten worden toegepast op de doelconfiguratie. Voorbeeld van indeling: {"key0":"value0", "key1":"value1"}.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--metrics -m

Definities van metrische gegevens voor apparaatconfiguratie. Geef het bestandspad of de onbewerkte json op.

--pri --priority

Het gewicht van de apparaatconfiguratie in het geval van concurrerende regels (hoogste winst).

--resource-group -g

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

--target-condition --tc -t

Doelvoorwaarde waarop een apparaatconfiguratie van toepassing is.

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

Configuratienaam van doelapparaat.

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--etag -e

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

--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--resource-group -g

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

az iot hub configuration list

IoT-configuraties voor automatisch apparaatbeheer in een IoT Hub.

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

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--resource-group -g

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

--top

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

az iot hub configuration show

De details van een automatische IoT-configuratie voor apparaatbeheer op halen.

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

Vereiste parameters

--config-id -c

Configuratienaam van doelapparaat.

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--resource-group -g

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

az iot hub configuration show-metric

Evalueer de metrische gegevens van een doelgebruiker of -systeem die zijn 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

Door de gebruiker gedefinieerde metriek 'warningLimit' evalueren

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

De metrische gegevens '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

Configuratienaam van doelapparaat.

--metric-id -m

Doelmetrische gegevens voor evaluatie.

Optionele parameters

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--metric-type --mt

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

geaccepteerde waarden: system, user
standaardwaarde: user
--resource-group -g

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

az iot hub configuration update

De opgegeven eigenschappen van een automatische IoT-apparaatbeheerconfiguratie 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', 'metrische gegevens', 'prioriteit' 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

Configuratienaam van doelapparaat.

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 of JSON string>.

--auth-type

Geeft aan of de bewerking automatisch een beleidssleutel moet afleiden of de huidige Azure AD-sessie moet gebruiken. U kunt de standaardinstelling configureren met az configure --defaults iothub-data-auth-type=<auth-type-value> behulp van .

geaccepteerde waarden: key, login
standaardwaarde: key
--etag -e

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

--force-string

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

--hub-name -n

IoT Hub naam.

--login -l

Deze opdracht ondersteunt een entiteitsgroep connection string rechten om actie uit te voeren. Gebruik om sessie-aanmelding via 'az login' te voorkomen. Als zowel een entiteits-connection string als de naam zijn opgegeven, heeft connection string prioriteit.

--remove

Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.

--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 moeten worden ingesteld. Voorbeeld: --set property1.property2=.