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

IoT Central-planningstaak beheren en configureren.

Opdracht

Name	Description	Type	Status
az iot central scheduled-job create	Maak een geplande taak op id.	Toestel	GA
az iot central scheduled-job delete	Verwijder een bestaande geplande taak op id.	Toestel	GA
az iot central scheduled-job list	Haal de lijst met geplande taakdefinities op in een toepassing.	Toestel	GA
az iot central scheduled-job list-runs	Haal de lijst met taakexemplaren op voor een geplande taakdefinitie.	Toestel	GA
az iot central scheduled-job show	Meer informatie over een geplande taak op id.	Toestel	GA
az iot central scheduled-job update	Werk een geplande taak bij op id.	Toestel	GA

az iot central scheduled-job create

Maak een geplande taak op id.

--schedule en --content kunnen inline json of bestandspad zijn.

az iot central scheduled-job create --app-id
                                    --content
                                    --group-id
                                    --id
                                    --schedule
                                    [--api-version {2022-06-30-preview, 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 planningstaak maken met de naam

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule {jobScheduleJSONPatch} --content {jobDataJSONPath}

Maak een geplande taak met de naam en batchconfiguratie.

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule	{jobScheduleJSONPatch} --content {jobDataJSONPath} --batch {jobBatchValue} --batch-type {jobBatchType}

Maak een geplande taak met naam- en annuleringsdrempelconfiguratie zonder batch.

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule	{jobScheduleJSONPatch} --content {jobDataJSONPath} --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. 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.

--id --job-id

Unieke id voor de geplande taak.

--schedule

Het schema waarop de taak moet worden uitgevoerd. Geef het pad naar het JSON-bestand of onbewerkte JSON op.

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

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

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

standaardwaarde: 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

standaardwaarde: number

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

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

standaardwaarde: 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 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 scheduled-job delete

Verwijder een bestaande geplande taak op id.

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

Voorbeelden

Een bestaande geplande taak verwijderen op id

az iot central scheduled-job delete --app-id {appid} --id {scheduledJobId}

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.

--id --job-id

Unieke id voor de geplande taak.

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 scheduled-job list

Haal de lijst met geplande taakdefinities op in een toepassing.

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

Voorbeelden

De lijst met geplande taakdefinities in een toepassing ophalen

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

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 scheduled-job list-runs

Haal de lijst met taakexemplaren op voor een geplande taakdefinitie.

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

Voorbeelden

De lijst met takenexemplaren voor een geplande taakdefinitie ophalen

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

--id --job-id

Unieke id voor de geplande taak.

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 scheduled-job show

Meer informatie over een geplande taak op id.

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

Voorbeelden

Details ophalen over een geplande taak op id

az iot central scheduled-job show --app-id {appid} --id {scheduledJobId}

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.

--id --job-id

Unieke id voor de geplande taak.

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 scheduled-job update

Werk een geplande taak bij op id.

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

Voorbeelden

Een planningstaak bijwerken met de naam

az iot central scheduled-job update --app-id {appid} --job-id {jobId} --job-name {displayName}

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.

--id --job-id

Unieke id voor de geplande taak.

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

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

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

--cancellation-threshold-type --ctt

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

geaccepteerde waarden: number, percentage

standaardwaarde: number

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

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

standaardwaarde: azureiotcentral.com

--content -k

De taakgegevensdefinitie. Geef het pad naar het JSON-bestand of onbewerkte JSON op. De hoofdtekst van de aanvraag moet een matrix van JobData bevatten.

--desc --description

Gedetailleerde beschrijving van de taak.

--group-id -g

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

--job-name

Weergavenaam van de taak.

--schedule

Het schema waarop de taak moet worden uitgevoerd. Geef het pad naar het JSON-bestand of onbewerkte JSON op.

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