Dela via


az vm run-command

Kommandon

Name Description Typ Status
az vm run-command create

Åtgärden för att skapa körningskommandot.

Core GA
az vm run-command delete

Åtgärden för att ta bort körningskommandot.

Core GA
az vm run-command invoke

Kör ett specifikt körningskommando på en virtuell dator.

Core GA
az vm run-command list

Visa en lista över körningskommandon från en virtuell dator eller en plats.

Core GA
az vm run-command show

Hämta ett specifikt körningskommando.

Core GA
az vm run-command update

Åtgärden för att uppdatera körningskommandot.

Core GA
az vm run-command wait

Placera CLI i vänteläge tills ett villkor för kommandot res virtual-machine-run-är uppfyllt.

Core GA

az vm run-command create

Åtgärden för att skapa körningskommandot.

az vm run-command create --name --run-command-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]

Exempel

Skapa ett körningskommando.

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"

Skapa ett körningskommando med uppladdning av skriptutdataström till 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"

Obligatoriska parametrar

--name --run-command-name

Namnet på kommandot för körning av virtuell dator.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--vm-name

Namnet på den virtuella datorn.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--async-execution

Optional. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras.

Egenskap Värde
Godkända värden: false, true
--command-id

Ange ett commandId för fördefinierat inbyggt skript.

--error-blob-uri

Ange den Azure Storage-blob där skriptfelströmmen ska laddas upp.

--location -l

Location. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap Värde
Standardvärde: False
--output-blob-uri

Ange den Azure Storage-blob (SAS-URI) där skriptutdataströmmen ska laddas upp.

--parameters

Parametrarna som används av skriptet.

Användning: --parameters arg1=XX arg2=XX.

--protected-parameters

Parametrarna som används av skriptet.

Användning: --protected-parameters credentials=somefoo secret=somebar.

--run-as-password

Lösenord om det behövs för att använda parametern kör som användare. Den krypteras och loggas inte.

--run-as-user

Som standard körs skriptprocessen under system-/rotanvändare. Ange anpassad användare som värd för processen.

--script

Ange det skriptinnehåll som ska köras på den virtuella datorn.

--script-uri

Ange platsen för nedladdning av skript.

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--timeout-in-seconds

Tidsgränsen i sekunder för att köra körningskommandot.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az vm run-command delete

Åtgärden för att ta bort körningskommandot.

az vm run-command delete [--ids]
                         [--name --run-command-name]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--subscription]
                         [--vm-name]
                         [--yes]

Exempel

Ta bort ett körningskommando.

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

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parameter group: Resource Id Arguments
--name --run-command-name -n

Namnet på VirtualMachineRunCommand.

Egenskap Värde
Parameter group: Resource Id Arguments
--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap Värde
Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parameter group: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parameter group: Resource Id Arguments
--vm-name

Namnet på VirtualMachine.

Egenskap Värde
Parameter group: Resource Id Arguments
--yes -y

Fråga inte efter bekräftelse.

Egenskap Värde
Standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az vm run-command invoke

Kör ett specifikt körningskommando på en virtuell dator.

az vm run-command show returnerar användbar information om varje körningskommando. Identifiera Kör kommando-ID:er via az vmss run-command list.

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

Exempel

Installera nginx på en virtuell Linux-dator.

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

Kör shell-kommandot på en virtuell Linux-dator med parametrar.

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

Kör PowerShell-skript på en virtuell Windows-dator med parametrar. Skriptet har angetts infogat. Var försiktig med att citera i 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'

Kör PowerShell-skript på en virtuell Windows-dator med parametrar. Skript som tillhandahålls från filen.

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

Obligatoriska parametrar

--command-id

Kommando-ID:t.

Egenskap Värde
Värde från: az vm run-command list

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parameter group: Resource Id Arguments
--name -n

Namnet på den virtuella datorn. Du kan konfigurera standardinställningen med .az configure --defaults vm=<name>

Egenskap Värde
Parameter group: Resource Id Arguments
--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap Värde
Standardvärde: False
--parameters

Blankstegsavgränsade parametrar i formatet [name=]value".

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parameter group: Resource Id Arguments
--scripts

Blankstegsavgränsade skriptrader. Använd @{file} för att läsa in skript från en fil.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parameter group: Resource Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az vm run-command list

Visa en lista över körningskommandon från en virtuell dator eller en plats.

Du kan ange "--resource-group" och "--vm-name" för att hämta alla körningskommandon för en virtuell dator. Eller så kan du ange "--location" för att visa alla tillgängliga körningskommandon för en prenumeration på en plats.

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

Exempel

Visa en lista över körningskommandon på en virtuell dator.

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

Visa en lista över alla tillgängliga körningskommandon för en prenumeration på en plats.

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

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--expand

Det expanderingsuttryck som ska tillämpas på åtgärden.

--location -l

Location. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--vm-name

Namnet på den virtuella datorn.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az vm run-command show

Hämta ett specifikt körningskommando.

Du kan ange "--resource-group", "--run-command-name" och "--vm-name" för att hämta körningskommandot på en virtuell dator. Du kan också ange "--command-id" och "--location" för att hämta körningskommandot för en prenumeration på en plats.

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

Exempel

Hämta körningskommandona på en virtuell dator.

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

Hämta ett specifikt körningskommando för en prenumeration på en plats.

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

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--command-id

Kommando-ID:t.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parameter group: Resource Id Arguments
--instance-view

Instansvyn för ett körningskommando.

Egenskap Värde
Standardvärde: False
--location -l

Location. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

--name --run-command-name

Namnet på kommandot för körning av virtuell dator.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parameter group: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parameter group: Resource Id Arguments
--vm-name

Namnet på den virtuella datorn.

Egenskap Värde
Parameter group: Resource Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az vm run-command update

Åtgärden för att uppdatera körningskommandot.

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

Exempel

Uppdatera ett körningskommando.

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"

Uppdatera ett körningskommando med uppladdning av skriptutdataström till 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"

Obligatoriska parametrar

--name --run-command-name

Namnet på kommandot för körning av virtuell dator.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--async-execution

Optional. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras.

Egenskap Värde
Godkända värden: false, true
--command-id

Ange ett commandId för fördefinierat inbyggt skript.

--error-blob-uri

Ange den Azure Storage-blob där skriptfelströmmen ska laddas upp.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parameter group: Resource Id Arguments
--location -l

Location. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

Egenskap Värde
Standardvärde: False
--output-blob-uri

Ange den Azure Storage-blob (SAS-URI) där skriptutdataströmmen ska laddas upp.

--parameters

Parametrarna som används av skriptet.

Användning: --parameters arg1=XX arg2=XX.

--protected-parameters

Parametrarna som används av skriptet.

Användning: --protected-parameters credentials=somefoo secret=somebar.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parameter group: Resource Id Arguments
--run-as-password

Lösenord om det behövs för att använda parametern kör som användare. Den krypteras och loggas inte.

--run-as-user

Som standard körs skriptprocessen under system-/rotanvändare. Ange anpassad användare som värd för processen.

--script

Ange det skriptinnehåll som ska köras på den virtuella datorn.

--script-uri

Ange platsen för nedladdning av skript.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parameter group: Resource Id Arguments
--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--timeout-in-seconds

Tidsgränsen i sekunder för att köra körningskommandot.

--vm-name

Namnet på den virtuella datorn.

Egenskap Värde
Parameter group: Resource Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az vm run-command wait

Placera CLI i vänteläge tills ett villkor för kommandot res virtual-machine-run-är uppfyllt.

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

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--command-id

Kommando-ID:t.

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

Egenskap Värde
Parameter group: Wait Condition Arguments
Standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Egenskap Värde
Parameter group: Wait Condition Arguments
--deleted

Vänta tills den har tagits bort.

Egenskap Värde
Parameter group: Wait Condition Arguments
Standardvärde: False
--exists

Vänta tills resursen finns.

Egenskap Värde
Parameter group: Wait Condition Arguments
Standardvärde: False
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om 'resurs-ID' argumenten. Du bör ange antingen --id eller andra "Resurs-ID"-argument.

Egenskap Värde
Parameter group: Resource Id Arguments
--instance-view

Instansvyn för ett körningskommando.

Egenskap Värde
Standardvärde: False
--interval

Avsökningsintervall i sekunder.

Egenskap Värde
Parameter group: Wait Condition Arguments
Standardvärde: 30
--location -l

Location. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

--name --run-command-name

Namnet på kommandot för körning av virtuell dator.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Egenskap Värde
Parameter group: Resource Id Arguments
--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

Egenskap Värde
Parameter group: Resource Id Arguments
--timeout

Maximal väntetid i sekunder.

Egenskap Värde
Parameter group: Wait Condition Arguments
Standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

Egenskap Värde
Parameter group: Wait Condition Arguments
Standardvärde: False
--vm-name

Namnet på den virtuella datorn.

Egenskap Värde
Parameter group: Resource Id Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False