Delen via

az automation runbook

  • Experimenteel

Note

Deze verwijzing maakt deel uit van de extensie automation voor de Azure CLI (versie 2.75.0 of hoger). De extensie installeert automatisch de eerste keer dat u een az automation runbook opdracht uitvoert. Meer informatie over uitbreidingen.

Deze opdrachtgroep is experimenteel en in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Automatiseringshandleiding.

Opdracht

Name Description Type Status
az automation runbook create

Maak het runbook dat is geïdentificeerd door de naam van het runbook.

 Extension Experimental
az automation runbook delete

Verwijder het runbook op naam.

 Extension Experimental
az automation runbook list

Haal een lijst met runbooks op.

 Extension Experimental
az automation runbook publish

Runbookconcept publiceren.

 Extension Experimental
az automation runbook replace-content

Vervang de inhoud van het runbook.

 Extension Experimental
az automation runbook revert-to-published

Herstel de runbookinhoud naar de laatst bekende gepubliceerde status.

 Extension Experimental
az automation runbook show

Haal het runbook op dat is geïdentificeerd door de naam van het runbook.

 Extension Experimental
az automation runbook start

Start het runbook.

 Extension Experimental
az automation runbook update

Werk het runbook bij dat is geïdentificeerd door de naam van het runbook.

 Extension Experimental
az automation runbook wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van het automation-runbook wordt voldaan.

 Extension Experimental

az automation runbook create

Experimenteel

Opdrachtgroep 'automation runbook' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Maak het runbook dat is geïdentificeerd door de naam van het runbook.

az automation runbook create --automation-account-name
                             --name --runbook-name
                             --resource-group
                             --type {Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script}
                             [--acquire-policy-token]
                             [--change-reference]
                             [--description]
                             [--location]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--tags]

Voorbeelden

Een runbook maken

az automation runbook create --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --type "PowerShell" --location "East US 2"

Vereiste parameters

--automation-account-name

De naam van het Automation-account.

--name --runbook-name -n

De naam van het runbook.

--resource-group -g

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

--type

Type runbook.

Eigenschap Waarde
Geaccepteerde waarden: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--description

Beschrijving van het runbook.

--location -l

Location. Waarden van: az account list-locations. U kunt de standaardlocatie configureren met behulp van az configure --defaults location=<location>.

--log-activity-trace

Traceringsopties op activiteitsniveau van het runbook.

--log-progress

Optie voortgangslogboek van het runbook.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--log-verbose

Uitgebreide logboekoptie van het runbook.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Eigenschap Waarde
Default value: False

az automation runbook delete

Experimenteel

Opdrachtgroep 'automation runbook' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Verwijder het runbook op naam.

az automation runbook delete [--acquire-policy-token]
                             [--automation-account-name]
                             [--change-reference]
                             [--ids]
                             [--name --runbook-name]
                             [--resource-group]
                             [--subscription]
                             [--yes]

Voorbeelden

Een runbook verwijderen

az automation runbook delete --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--automation-account-name

De naam van het Automation-account.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name --runbook-name -n

De naam van het runbook.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--yes -y

Niet vragen om bevestiging.

Eigenschap Waarde
Default value: False
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Eigenschap Waarde
Default value: False

az automation runbook list

Experimenteel

Opdrachtgroep 'automation runbook' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Haal een lijst met runbooks op.

az automation runbook list --automation-account-name
                           --resource-group

Voorbeelden

Runbooks weergeven op Automation-account

az automation runbook list --automation-account-name "myAutomationAccount" --resource-group "rg"

Vereiste parameters

--automation-account-name

De naam van het Automation-account.

--resource-group -g

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Eigenschap Waarde
Default value: False

az automation runbook publish

Experimenteel

Opdrachtgroep 'automation runbook' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Runbookconcept publiceren.

az automation runbook publish [--acquire-policy-token]
                              [--automation-account-name]
                              [--change-reference]
                              [--ids]
                              [--name --runbook-name]
                              [--no-wait]
                              [--resource-group]
                              [--subscription]

Voorbeelden

Runbookconcept publiceren

az automation runbook publish --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook"

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--automation-account-name

De naam van het Automation-account.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name --runbook-name -n

De parameters die zijn opgegeven voor de runbookbewerking publiceren.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Default value: False
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Eigenschap Waarde
Default value: False

az automation runbook replace-content

Experimenteel

Opdrachtgroep 'automation runbook' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Vervang de inhoud van het runbook.

az automation runbook replace-content --content
                                      [--acquire-policy-token]
                                      [--automation-account-name]
                                      [--change-reference]
                                      [--ids]
                                      [--name --runbook-name]
                                      [--no-wait]
                                      [--resource-group]
                                      [--subscription]

Voorbeelden

Inhoud van het runbook vervangen

az automation runbook replace-content --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook" --content @/path/to/script

Vereiste parameters

--content

De runbookinhoud.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--automation-account-name

De naam van het Automation-account.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name --runbook-name -n

De naam van het runbook.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

Eigenschap Waarde
Default value: False
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Eigenschap Waarde
Default value: False

az automation runbook revert-to-published

Experimenteel

Opdrachtgroep 'automation runbook' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Herstel de runbookinhoud naar de laatst bekende gepubliceerde status.

az automation runbook revert-to-published [--acquire-policy-token]
                                          [--automation-account-name]
                                          [--change-reference]
                                          [--ids]
                                          [--name --runbook-name]
                                          [--resource-group]
                                          [--subscription]

Voorbeelden

Inhoud van het runbook vervangen

az automation runbook revert-to-published --automation-account-name "myAutomationAccount"                --resource-group "rg" --name "myRunbook"

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--automation-account-name

De naam van het Automation-account.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name --runbook-name -n

De naam van het runbook.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Eigenschap Waarde
Default value: False

az automation runbook show

Experimenteel

Opdrachtgroep 'automation runbook' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Haal het runbook op dat is geïdentificeerd door de naam van het runbook.

az automation runbook show [--automation-account-name]
                           [--ids]
                           [--name --runbook-name]
                           [--resource-group]
                           [--subscription]

Voorbeelden

Runbook ophalen

az automation runbook show --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--automation-account-name

De naam van het Automation-account.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name --runbook-name -n

De naam van het runbook.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Eigenschap Waarde
Default value: False

az automation runbook start

Experimenteel

Opdrachtgroep 'automation runbook' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Start het runbook.

az automation runbook start [--acquire-policy-token]
                            [--automation-account-name]
                            [--change-reference]
                            [--ids]
                            [--name --runbook-name]
                            [--parameters]
                            [--resource-group]
                            [--run-on]
                            [--subscription]

Voorbeelden

Het runbook starten

az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--automation-account-name

De naam van het Automation-account.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name --runbook-name -n

De naam van het runbook.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--parameters

Parameters van de taak. Verwachte waarde: KEY1=VALUE1 KEY2=VALUE2 ...

--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--run-on

RunOn waarmee de groepsnaam wordt opgegeven waar de taak moet worden uitgevoerd.

--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Eigenschap Waarde
Default value: False

az automation runbook update

Experimenteel

Opdrachtgroep 'automation runbook' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Werk het runbook bij dat is geïdentificeerd door de naam van het runbook.

az automation runbook update [--acquire-policy-token]
                             [--automation-account-name]
                             [--change-reference]
                             [--description]
                             [--ids]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--name --runbook-name]
                             [--resource-group]
                             [--subscription]
                             [--tags]

Voorbeelden

Een runbook bijwerken

az automation runbook update --automation-account-name "myAutomationAccount" --description                "Runbook Description" --log-activity-trace 1 --log-progress true --log-verbose false                --resource-group "rg" --runbook-name "myRunbook"

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--automation-account-name

De naam van het Automation-account.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--description

Beschrijving van het runbook.

--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--log-activity-trace

Traceringsopties op activiteitsniveau van het runbook.

--log-progress

Optie voortgangslogboek van het runbook.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--log-verbose

Uitgebreide logboekoptie van het runbook.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--name --runbook-name -n

De naam van het runbook.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Eigenschap Waarde
Default value: False

az automation runbook wait

Experimenteel

Opdrachtgroep 'automation runbook' is experimenteel en wordt in ontwikkeling. Referentie- en ondersteuningsniveaus: https://aka.ms/CLI_refstatus

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van het automation-runbook wordt voldaan.

az automation runbook wait [--acquire-policy-token]
                           [--automation-account-name]
                           [--change-reference]
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--name --runbook-name]
                           [--resource-group]
                           [--subscription]
                           [--timeout]
                           [--updated]

Voorbeelden

Pauzeer het uitvoeren van de volgende regel van het CLI-script totdat het automation-runbook is gemaakt.

az automation runbook wait --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --created

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--acquire-policy-token

Automatisch een Azure Policy token verkrijgen voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--automation-account-name

De naam van het Automation-account.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--change-reference

De gerelateerde wijzigingsverwijzings-id voor deze resourcebewerking.

Eigenschap Waarde
Parametergroep: Global Policy Arguments
--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--custom

Wacht tot de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
--deleted

Wacht totdat deze is verwijderd.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--exists

Wacht tot de resource bestaat.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--interval

Polling-interval in seconden.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: 30
--name --runbook-name -n

De naam van het runbook.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

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

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--timeout

Maximale wachttijd in seconden.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: 3600
--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

Eigenschap Waarde
Parametergroep: Wait Condition Arguments
Default value: False
Globale parameters
--debug

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

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Eigenschap Waarde
Default value: False