az vm run-command

  • Referentie

Run-opdrachten op een virtuele machine beheren.

Zie of https://docs.microsoft.com/azure/virtual-machines/linux/run-commandvoor meer informatiehttps://docs.microsoft.com/azure/virtual-machines/windows/run-command.

Opdracht

Name Description Type Status
az vm run-command create

De bewerking voor het maken van de opdracht uitvoeren.

 Basis GA
az vm run-command delete

De bewerking voor het verwijderen van de opdracht uitvoeren.

 Basis GA
az vm run-command invoke

Voer een specifieke run-opdracht uit op een virtuele machine.

 Basis GA
az vm run-command list

Voer opdrachten uit vanaf een virtuele machine of een locatie weergeven.

 Basis GA
az vm run-command show

Specifieke run-opdracht ophalen.

 Basis GA
az vm run-command update

De bewerking voor het bijwerken van de opdracht uitvoeren.

 Basis GA
az vm run-command wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van de opdracht res virtual-machine-run-run wordt voldaan.

 Basis GA

az vm run-command create

Bewerken

De bewerking voor het maken van de opdracht uitvoeren.

az vm run-command create --name
                         --resource-group
                         --vm-name
                         [--async-execution {false, true}]
                         [--command-id]
                         [--error-blob-uri]
                         [--location]
                         [--no-wait]
                         [--output-blob-uri]
                         [--parameters]
                         [--protected-parameters]
                         [--run-as-password]
                         [--run-as-user]
                         [--script]
                         [--script-uri]
                         [--tags]
                         [--timeout-in-seconds]

Voorbeelden

Maak een run-opdracht.

az vm run-command create --resource-group "myResourceGroup" --location "West US" --async-execution false --parameters arg1=param1 arg2=value1 --run-as-password "<runAsPassword>" --run-as-user "user1" --script "Write-Host Hello World!" --timeout-in-seconds 3600 --run-command-name "myRunCommand" --vm-name "myVM"

Maak een uitvoeringsopdracht met het uploaden van scriptuitvoerstroom naar Azure Storage Blob (SAS URI).

az vm run-command create --resource-group "myResourceGroup" --location "West US" --script "Write-Host Hello World!" --run-command-name "myRunCommand" --vm-name "myVM" --output-blob-uri "https://mystorageaccount.blob.core.windows.net/mycontainer/RuncommandOutput.txt?sp=racw&st=2022-10-17T19:02:15Z&se=2022-10-18T03:02:15Z&spr=https&sv=2021-06-08&sr=b&sig=3BxtEasfdasdfasdfdYki9yvYsqc60V0%3D"

Vereiste parameters

--name --run-command-name

De naam van de opdracht voor het uitvoeren van de virtuele machine.

--resource-group -g

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

--vm-name

De naam van de virtuele machine.

Optionele parameters

--async-execution

Optioneel. Als dit is ingesteld op true, wordt het inrichten voltooid zodra het script wordt gestart en wacht niet totdat het script is voltooid.

geaccepteerde waarden: false, true
--command-id

Geef een commandId van vooraf gedefinieerd ingebouwd script op.

--error-blob-uri

Geef de Azure Storage-blob op waar de scriptfoutstroom wordt geüpload.

--location -l

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

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--output-blob-uri

Geef de Azure Storage Blob (SAS URI) op waar de scriptuitvoerstroom wordt geüpload.

--parameters

De parameters die door het script worden gebruikt.

Gebruik: --parameters arg1=XX arg2=XX.

--protected-parameters

De parameters die door het script worden gebruikt.

Gebruik: --protected-parameters credentials=somefoo secret=somebar.

--run-as-password

Wachtwoord indien nodig voor het gebruik van de run-as-user-parameter. Het wordt versleuteld en niet geregistreerd.

--run-as-user

Het scriptproces wordt standaard uitgevoerd onder systeem-/hoofdgebruiker. Geef een aangepaste gebruiker op om het proces te hosten.

--script

Geef de scriptinhoud op die moet worden uitgevoerd op de virtuele machine.

--script-uri

Geef de downloadlocatie van het script op.

--tags

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

--timeout-in-seconds

De time-out in seconden om de run-opdracht uit te voeren.

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 vm run-command delete

Bewerken

De bewerking voor het verwijderen van de opdracht uitvoeren.

az vm run-command delete --name
                         [--ids]
                         [--no-wait]
                         [--resource-group]
                         [--subscription]
                         [--vm-name]
                         [--yes]

Voorbeelden

Verwijder een run-opdracht.

az vm run-command delete --resource-group "myResourceGroup" --run-command-name "myRunCommand" --vm-name "myVM"

Vereiste parameters

--name --run-command-name

De naam van de opdracht voor het uitvoeren van de virtuele machine.

Optionele parameters

--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. Geef de argumenten --id's of andere resource-id's op.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--resource-group -g

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

--subscription

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

--vm-name

De naam van de virtuele machine.

--yes -y

Niet vragen om bevestiging.

standaardwaarde: False
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 vm run-command invoke

Bewerken

Voer een specifieke run-opdracht uit op een virtuele machine.

az vm run-command show retourneert nuttige informatie over elke run-command. Ontdek de opdracht-id's uitvoeren via az vmss run-command list.

az vm run-command invoke --command-id
                         [--ids]
                         [--name]
                         [--no-wait]
                         [--parameters]
                         [--resource-group]
                         [--scripts]
                         [--subscription]

Voorbeelden

Installeer nginx op een linux-VM.

az vm run-command invoke -g MyResourceGroup -n MyVm --command-id RunShellScript --scripts "sudo apt-get update && sudo apt-get install -y nginx"

Voer de shell-opdracht uit op een linux-VM met parameters.

az vm run-command invoke -g MyResourceGroup -n MyVm --command-id RunShellScript --scripts 'echo $1 $2' --parameters hello world

Voer een PowerShell-script uit op een Windows-VM met parameters. Script dat inline is opgegeven. Wees voorzichtig met single-quoting in CMD.exe.

az vm run-command invoke  --command-id RunPowerShellScript --name win-vm -g my-resource-group  \
    --scripts 'param([string]$arg1,[string]$arg2)' \
    'Write-Host This is a sample script with parameters $arg1 and $arg2' \
    --parameters 'arg1=somefoo' 'arg2=somebar'

Voer een PowerShell-script uit op een Windows-VM met parameters. Script dat is opgegeven uit bestand.

# script.ps1
#   param(
#       [string]$arg1,
#       [string]$arg2
#   )
#   Write-Host This is a sample script with parameters $arg1 and $arg2

az vm run-command invoke  --command-id RunPowerShellScript --name win-vm -g my-resource-group \
    --scripts @script.ps1 --parameters "arg1=somefoo" "arg2=somebar"

Vereiste parameters

--command-id

De opdracht-id.

waarde vanaf: az vm run-command list

Optionele parameters

--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. Geef de argumenten --id's of andere resource-id's op.

--name -n

De naam van de virtuele machine. U kunt de standaardinstelling configureren met behulp van az configure --defaults vm=<name>.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--parameters

Door spaties gescheiden parameters in de notatie van '[name=]value'.

--resource-group -g

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

--scripts

Door spaties gescheiden scriptregels. Gebruik @{file} om een script uit een bestand te laden.

--subscription

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

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 vm run-command list

Bewerken

Voer opdrachten uit vanaf een virtuele machine of een locatie weergeven.

U kunt '--resource-group' en '--vm-name' opgeven om alle uitvoeringsopdrachten van een virtuele machine op te halen. U kunt ook '--location' opgeven om alle beschikbare uitvoeringsopdrachten voor een abonnement op een locatie weer te geven.

az vm run-command list [--expand]
                       [--location]
                       [--resource-group]
                       [--vm-name]

Voorbeelden

Voer opdrachten weer in een virtuele machine.

az vm run-command list --resource-group "myResourceGroup" --vm-name "myVM"

Geef alle beschikbare uitvoeringsopdrachten voor een abonnement op een locatie weer.

az vm run-command list --location "SoutheastAsia"

Optionele parameters

--expand

De uitvouwexpressie die moet worden toegepast op de bewerking.

--location -l

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

--resource-group -g

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

--vm-name

De naam van de virtuele machine.

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 vm run-command show

Bewerken

Specifieke run-opdracht ophalen.

U kunt '--resource-group', '--run-command-name' en '--vm-name' opgeven om de opdracht uitvoeren op een virtuele machine op te halen. U kunt ook '--command-id' en '--location' opgeven om de opdracht voor een abonnement op een locatie op te halen.

az vm run-command show [--command-id]
                       [--ids]
                       [--instance-view]
                       [--location]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--vm-name]

Voorbeelden

Haal de uitvoeringsopdrachten op een virtuele machine op.

az vm run-command show --resource-group "myResourceGroup" --run-command-name "myRunCommand" --vm-name "myVM"

Krijg een specifieke uitvoeringsopdracht voor een abonnement op een locatie.

az vm run-command show --command-id "RunPowerShellScript" --location "SoutheastAsia"

Optionele parameters

--command-id

De opdracht-id.

--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. Geef de argumenten --id's of andere resource-id's op.

--instance-view

De exemplaarweergave van een uitvoeringsopdracht.

standaardwaarde: False
--location -l

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

--name --run-command-name

De naam van de opdracht voor het uitvoeren van de virtuele machine.

--resource-group -g

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

--subscription

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

--vm-name

De naam van de virtuele machine.

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 vm run-command update

Bewerken

De bewerking voor het bijwerken van de opdracht uitvoeren.

az vm run-command update --name
                         [--async-execution {false, true}]
                         [--command-id]
                         [--error-blob-uri]
                         [--ids]
                         [--location]
                         [--no-wait]
                         [--output-blob-uri]
                         [--parameters]
                         [--protected-parameters]
                         [--resource-group]
                         [--run-as-password]
                         [--run-as-user]
                         [--script]
                         [--script-uri]
                         [--subscription]
                         [--tags]
                         [--timeout-in-seconds]
                         [--vm-name]

Voorbeelden

Een uitvoeringsopdracht bijwerken.

az vm run-command update --resource-group "myResourceGroup" --location "West US" --async-execution false --parameters arg1=param1 arg2=value1 --run-as-password "<runAsPassword>" --run-as-user "user1" --script "Write-Host Hello World!" --timeout-in-seconds 3600 --run-command-name "myRunCommand" --vm-name "myVM"

Werk een uitvoeringsopdracht bij met het uploaden van scriptuitvoerstroom naar Azure Storage Blob (SAS URI).

az vm run-command update --resource-group "myResourceGroup" --location "West US" --script "Write-Host Hello World!" --run-command-name "myRunCommand" --vm-name "myVM" --output-blob-uri "https://mystorageaccount.blob.core.windows.net/mycontainer/RuncommandOutput.txt?sp=racw&st=2022-10-17T19:02:15Z&se=2022-10-18T03:02:15Z&spr=https&sv=2021-06-08&sr=b&sig=3BxtEasfdasdfasdfdYki9yvYsqc60V0%3D"

Vereiste parameters

--name --run-command-name

De naam van de opdracht voor het uitvoeren van de virtuele machine.

Optionele parameters

--async-execution

Optioneel. Als dit is ingesteld op true, wordt het inrichten voltooid zodra het script wordt gestart en wacht niet totdat het script is voltooid.

geaccepteerde waarden: false, true
--command-id

Geef een commandId van vooraf gedefinieerd ingebouwd script op.

--error-blob-uri

Geef de Azure Storage-blob op waar de scriptfoutstroom wordt geüpload.

--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. Geef de argumenten --id's of andere resource-id's op.

--location -l

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

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--output-blob-uri

Geef de Azure Storage Blob (SAS URI) op waar de scriptuitvoerstroom wordt geüpload.

--parameters

De parameters die door het script worden gebruikt.

Gebruik: --parameters arg1=XX arg2=XX.

--protected-parameters

De parameters die door het script worden gebruikt.

Gebruik: --protected-parameters credentials=somefoo secret=somebar.

--resource-group -g

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

--run-as-password

Wachtwoord indien nodig voor het gebruik van de run-as-user-parameter. Het wordt versleuteld en niet geregistreerd.

--run-as-user

Het scriptproces wordt standaard uitgevoerd onder systeem-/hoofdgebruiker. Geef een aangepaste gebruiker op om het proces te hosten.

--script

Geef de scriptinhoud op die moet worden uitgevoerd op de virtuele machine.

--script-uri

Geef de downloadlocatie van het script op.

--subscription

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

--tags

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

--timeout-in-seconds

De time-out in seconden om de run-opdracht uit te voeren.

--vm-name

De naam van de virtuele machine.

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 vm run-command wait

Bewerken

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van de opdracht res virtual-machine-run-run wordt voldaan.

az vm run-command wait [--command-id]
                       [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--ids]
                       [--instance-view]
                       [--interval]
                       [--location]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--timeout]
                       [--updated]
                       [--vm-name]

Optionele parameters

--command-id

De opdracht-id.

--created

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

standaardwaarde: False
--custom

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

--deleted

Wacht totdat deze is verwijderd.

standaardwaarde: False
--exists

Wacht tot de resource bestaat.

standaardwaarde: 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. Geef de argumenten --id's of andere resource-id's op.

--instance-view

De exemplaarweergave van een uitvoeringsopdracht.

standaardwaarde: False
--interval

Polling-interval in seconden.

standaardwaarde: 30
--location -l

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

--name --run-command-name

De naam van de opdracht voor het uitvoeren van de virtuele machine.

--resource-group -g

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

--subscription

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

--timeout

Maximale wachttijd in seconden.

standaardwaarde: 3600
--updated

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

standaardwaarde: False
--vm-name

De naam van de virtuele machine.

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.