az iot central job

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 central job opdracht uitvoert. Meer informatie over extensies.

Taken voor een IoT Central-toepassing beheren en configureren.

Opdracht

Name	Description	Type	Status
az iot central job create	Een taak maken en uitvoeren via de bijbehorende taakdefinitie.	Uitbreiding	GA
az iot central job get-devices	Taakapparaatstatussen ophalen.	Uitbreiding	GA
az iot central job list	Haal de lijst met taken voor een IoT Central-toepassing op.	Uitbreiding	GA
az iot central job rerun	Voer een taak opnieuw uit op alle mislukte apparaten.	Uitbreiding	GA
az iot central job resume	Een gestopte taak hervatten.	Uitbreiding	GA
az iot central job show	Haal de details van een taak op id op.	Uitbreiding	GA
az iot central job stop	Stop een actieve taak.	Uitbreiding	GA

az iot central job create

Een taak maken en uitvoeren via de bijbehorende taakdefinitie.

az iot central job create --app-id
                          --content
                          --group-id
                          --job-id
                          [--api-version {2022-07-31}]
                          [--batch]
                          [--batch-type {number, percentage}]
                          [--cancellation-threshold]
                          [--cancellation-threshold-batch]
                          [--cancellation-threshold-type {number, percentage}]
                          [--central-api-uri]
                          [--desc]
                          [--job-name]
                          [--token]

Voorbeelden

Een taak met de naam maken

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath}

Maak een taak met de naam en batchconfiguratie.

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath} --batch {jobBatchValue} --batch-type {jobBatchType}

Maak een taak met naam- en annuleringsdrempelconfiguratie zonder batch.

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath} --cancellation-threshold {jobCancellationThresholdValue} --cancellation-threshold-type {jobCancellationThresholdType} --description {jobDesc}

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.

--content -k

De taakgegevensdefinitie. Geef het pad naar het JSON-bestand of onbewerkte JSON op. [Voorbeeld van bestandspad:./path/to/file.json] [Voorbeeld van getekende JSON:[{Job Data JSON}]. De hoofdtekst van de aanvraag moet een matrix van JobData bevatten.

--group-id -g

De id van de apparaatgroep waarop de taak moet worden uitgevoerd.

--job-id -j

Unieke id voor de taak.

Optionele parameters

--api-version --av

Afgeschaft

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

De API-versie voor de aangevraagde bewerking.

Geaccepteerde waarden: 2022-07-31

Default value: 2022-07-31

--batch -b

Het aantal of het percentage apparaten waarop batchverwerking wordt uitgevoerd.

--batch-type --bt

Geef op of batchverwerking wordt uitgevoerd op een aantal apparaten of een percentage van het totaal.

Geaccepteerde waarden: number, percentage

Default value: number

--cancellation-threshold --cth

Het aantal of het percentage apparaten waarop de annuleringsdrempel wordt toegepast.

--cancellation-threshold-batch --ctb

Of de annuleringsdrempel per batch of op de algehele taak van toepassing is.

Default value: number

--cancellation-threshold-type --ctt

Geef op of de annuleringsdrempel geldt voor een aantal apparaten of een percentage van het totaal.

Geaccepteerde waarden: number, percentage

Default value: number

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

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

Default value: azureiotcentral.com

--desc --description

Gedetailleerde beschrijving van de taak.

--job-name

Weergavenaam van de taak.

--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 vindt u 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

Default value: json

--query

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

--subscription

Naam of id van 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 job get-devices

Taakapparaatstatussen ophalen.

az iot central job get-devices --app-id
                               --job-id
                               [--api-version {2022-07-31}]
                               [--central-api-uri]
                               [--token]

Voorbeelden

De lijst met afzonderlijke apparaatstatussen ophalen op taak-id

az iot central job get-devices --app-id {appid} --job-id {jobId}

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.

--job-id -j

Unieke id voor de taak.

Optionele parameters

--api-version --av

Afgeschaft

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

De API-versie voor de aangevraagde bewerking.

Geaccepteerde waarden: 2022-07-31

Default value: 2022-07-31

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

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

Default value: 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 vindt u 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

Default value: json

--query

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

--subscription

Naam of id van 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 job list

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

az iot central job list --app-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Voorbeelden

Taken in een toepassing weergeven

az iot central job 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.

De API-versie voor de aangevraagde bewerking.

Geaccepteerde waarden: 2022-07-31

Default value: 2022-07-31

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

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

Default value: 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 vindt u 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

Default value: json

--query

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

--subscription

Naam of id van 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 job rerun

Voer een taak opnieuw uit op alle mislukte apparaten.

az iot central job rerun --app-id
                         --job-id
                         --rerun-id
                         [--api-version {2022-07-31}]
                         [--central-api-uri]
                         [--token]

Voorbeelden

Een taak opnieuw uitvoeren

az iot central job rerun --app-id {appid} --job-id {jobId} --rerun-id {rerunId}

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.

--job-id -j

Unieke id voor de taak.

--rerun-id

Unieke id voor opnieuw uitvoeren.

Optionele parameters

--api-version --av

Afgeschaft

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

De API-versie voor de aangevraagde bewerking.

Geaccepteerde waarden: 2022-07-31

Default value: 2022-07-31

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

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

Default value: 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 vindt u 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

Default value: json

--query

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

--subscription

Naam of id van 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 job resume

Een gestopte taak hervatten.

az iot central job resume --app-id
                          --job-id
                          [--api-version {2022-07-31}]
                          [--central-api-uri]
                          [--token]

Voorbeelden

Een taak hervatten

az iot central job resume --app-id {appid} --job-id {jobId}

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.

--job-id -j

Unieke id voor de taak.

Optionele parameters

--api-version --av

Afgeschaft

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

De API-versie voor de aangevraagde bewerking.

Geaccepteerde waarden: 2022-07-31

Default value: 2022-07-31

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

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

Default value: 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 vindt u 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

Default value: json

--query

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

--subscription

Naam of id van 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 job show

Haal de details van een taak op id op.

az iot central job show --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Voorbeelden

Details van taak ophalen

az iot central job show --app-id {appid} --job-id {jobId}

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.

--job-id -j

Unieke id voor de taak.

Optionele parameters

--api-version --av

Afgeschaft

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

De API-versie voor de aangevraagde bewerking.

Geaccepteerde waarden: 2022-07-31

Default value: 2022-07-31

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

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

Default value: 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 vindt u 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

Default value: json

--query

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

--subscription

Naam of id van 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 job stop

Stop een actieve taak.

az iot central job stop --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Voorbeelden

Een taak stoppen

az iot central job stop --app-id {appid} --job-id {jobId}

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.

--job-id -j

Unieke id voor de taak.

Optionele parameters

--api-version --av

Afgeschaft

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

De API-versie voor de aangevraagde bewerking.

Geaccepteerde waarden: 2022-07-31

Default value: 2022-07-31

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

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

Default value: 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 vindt u 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

Default value: json

--query

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

--subscription

Naam of id van 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.