Virtual Machine Run Commands - Update
Åtgärden för att uppdatera körningskommandot.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}?api-version=2024-03-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Namnet på resursgruppen. |
run
|
path | True |
string |
Namnet på den virtuella datorn kör kommandot. |
subscription
|
path | True |
string |
Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop. |
vm
|
path | True |
string |
Namnet på den virtuella dator där körningskommandot ska uppdateras. |
api-version
|
query | True |
string |
Klient-API-version. |
Begärandetext
Media Types: "application/json", "text/json"
Name | Typ | Description |
---|---|---|
properties.asyncExecution |
boolean |
Valfritt. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras. |
properties.errorBlobManagedIdentity |
Användartilldelad hanterad identitet som har åtkomst till errorBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Contributor". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged |
|
properties.errorBlobUri |
string |
Anger den Azure Storage-blob där skriptfelströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern errorBlobManagedIdentity. |
properties.outputBlobManagedIdentity |
Användartilldelad hanterad identitet som har åtkomst till outputBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Contributor". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged |
|
properties.outputBlobUri |
string |
Anger den Azure Storage-blob där skriptutdataströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern outputBlobManagedIdentity. |
properties.parameters |
De parametrar som används av skriptet. |
|
properties.protectedParameters |
De parametrar som används av skriptet. |
|
properties.runAsPassword |
string |
Anger lösenordet för användarkontot på den virtuella datorn när körningskommandot körs. |
properties.runAsUser |
string |
Anger användarkontot på den virtuella datorn när körningskommandot körs. |
properties.source |
Källan till körningskommandoskriptet. |
|
properties.timeoutInSeconds |
integer |
Tidsgränsen i sekunder för att köra körningskommandot. |
properties.treatFailureAsDeploymentFailure |
boolean |
Valfritt. Om värdet är sant misslyckas eventuella fel i skriptet och ProvisioningState markeras som Misslyckad. Om värdet är falskt skulle ProvisioningState bara återspegla om körningskommandot kördes eller inte av tilläggsplattformen. Det skulle inte ange om skriptet misslyckades vid skriptfel. Se instansvyn för körningskommandot vid skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results |
tags |
object |
Resurstaggar |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK Media Types: "application/json", "text/json" |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. Media Types: "application/json", "text/json" |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Update a run command.
Sample Request
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand?api-version=2024-03-01
{
"properties": {
"source": {
"script": "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt"
},
"parameters": [
{
"name": "param1",
"value": "value1"
},
{
"name": "param2",
"value": "value2"
}
],
"asyncExecution": false,
"runAsUser": "user1",
"runAsPassword": "<runAsPassword>",
"timeoutInSeconds": 3600,
"outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri",
"errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt",
"errorBlobManagedIdentity": {
"objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072"
}
}
}
Sample Response
{
"name": "myRunCommand",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand",
"type": "Microsoft.Compute/virtualMachines/runCommands",
"location": "westus",
"tags": {
"tag1": "value1",
"tag2": "value2"
},
"properties": {
"source": {
"script": "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt"
},
"parameters": [
{
"name": "param1",
"value": "value1"
},
{
"name": "param2",
"value": "value2"
}
],
"asyncExecution": false,
"treatFailureAsDeploymentFailure": false,
"runAsUser": "user1",
"timeoutInSeconds": 3600,
"provisioningState": "Updating",
"outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
"errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
}
}
Definitioner
Name | Description |
---|---|
Api |
API-fel. |
Api |
Api-felbas. |
Cloud |
Ett felsvar från Beräkningstjänsten. |
Execution |
Skriptkörningsstatus. |
Inner |
Inre felinformation. |
Instance |
Status för instansvy. |
Run |
Beskriver egenskaperna för en körningskommandoparameter. |
Run |
Innehåller clientId eller objectId (använd bara ett, inte båda) för en användartilldelad hanterad identitet som har åtkomst till lagringsblob som används i Kör kommandot. Använd ett tomt RunCommandManagedIdentity-objekt vid systemtilldelad identitet. Kontrollera att Azure Storage-bloben finns i händelse av scriptUri och att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Reader" med scriptUri-blob och "Storage Blob Data Contributor" för Tilläggsblobbar (outputBlobUri, errorBlobUri). När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och Kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged. |
Status |
Nivåkoden. |
Virtual |
Beskriver ett körningskommando för virtuell dator. |
Virtual |
Instansvyn för ett virtuellt datorkörningskommando. |
Virtual |
Beskriver skriptkällorna för körningskommandot. Använd bara ett skript, scriptUri, commandId. |
Virtual |
Beskriver ett körningskommando för virtuell dator. |
ApiError
API-fel.
Name | Typ | Description |
---|---|---|
code |
string |
Felkoden. |
details |
Api-felinformationen |
|
innererror |
Api:ets inre fel |
|
message |
string |
Felmeddelandet. |
target |
string |
Målet för det specifika felet. |
ApiErrorBase
Api-felbas.
Name | Typ | Description |
---|---|---|
code |
string |
Felkoden. |
message |
string |
Felmeddelandet. |
target |
string |
Målet för det specifika felet. |
CloudError
Ett felsvar från Beräkningstjänsten.
Name | Typ | Description |
---|---|---|
error |
API-fel. |
ExecutionState
Skriptkörningsstatus.
Name | Typ | Description |
---|---|---|
Canceled |
string |
|
Failed |
string |
|
Pending |
string |
|
Running |
string |
|
Succeeded |
string |
|
TimedOut |
string |
|
Unknown |
string |
InnerError
Inre felinformation.
Name | Typ | Description |
---|---|---|
errordetail |
string |
Det interna felmeddelandet eller undantagsdumpen. |
exceptiontype |
string |
Undantagstypen. |
InstanceViewStatus
Status för instansvy.
Name | Typ | Description |
---|---|---|
code |
string |
Statuskoden. |
displayStatus |
string |
Den korta localizable etiketten för statusen. |
level |
Nivåkoden. |
|
message |
string |
Det detaljerade statusmeddelandet, inklusive för aviseringar och felmeddelanden. |
time |
string |
Tiden för statusen. |
RunCommandInputParameter
Beskriver egenskaperna för en körningskommandoparameter.
Name | Typ | Description |
---|---|---|
name |
string |
Kör kommandoparameterns namn. |
value |
string |
Kör kommandoparametervärdet. |
RunCommandManagedIdentity
Innehåller clientId eller objectId (använd bara ett, inte båda) för en användartilldelad hanterad identitet som har åtkomst till lagringsblob som används i Kör kommandot. Använd ett tomt RunCommandManagedIdentity-objekt vid systemtilldelad identitet. Kontrollera att Azure Storage-bloben finns i händelse av scriptUri och att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Reader" med scriptUri-blob och "Storage Blob Data Contributor" för Tilläggsblobbar (outputBlobUri, errorBlobUri). När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och Kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged.
Name | Typ | Description |
---|---|---|
clientId |
string |
Klient-ID (GUID-värde) för den användartilldelade hanterade identiteten. ObjectId bör inte användas om detta anges. |
objectId |
string |
Objekt-ID (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges. |
StatusLevelTypes
Nivåkoden.
Name | Typ | Description |
---|---|---|
Error |
string |
|
Info |
string |
|
Warning |
string |
VirtualMachineRunCommand
Beskriver ett körningskommando för virtuell dator.
Name | Typ | Standardvärde | Description |
---|---|---|---|
id |
string |
Resurs-ID |
|
location |
string |
Resursplats |
|
name |
string |
Resursnamn |
|
properties.asyncExecution |
boolean |
False |
Valfritt. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras. |
properties.errorBlobManagedIdentity |
Användartilldelad hanterad identitet som har åtkomst till errorBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Contributor". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged |
||
properties.errorBlobUri |
string |
Anger den Azure Storage-blob där skriptfelströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern errorBlobManagedIdentity. |
|
properties.instanceView |
Den virtuella datorn kör kommandoinstansvyn. |
||
properties.outputBlobManagedIdentity |
Användartilldelad hanterad identitet som har åtkomst till outputBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Contributor". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged |
||
properties.outputBlobUri |
string |
Anger den Azure Storage-blob där skriptutdataströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern outputBlobManagedIdentity. |
|
properties.parameters |
De parametrar som används av skriptet. |
||
properties.protectedParameters |
De parametrar som används av skriptet. |
||
properties.provisioningState |
string |
Etableringstillståndet, som bara visas i svaret. Om treatFailureAsDeploymentFailure är inställt på true misslyckas distributionen och ProvisioningState markeras som Misslyckad. Om treatFailureAsDeploymentFailure är inställt på falskt, skulle ProvisioningState bara återspegla om körningskommandot kördes eller inte av tilläggsplattformen, det skulle inte ange om skriptet misslyckades vid skriptfel. Se instansvyn för körningskommandot vid skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results |
|
properties.runAsPassword |
string |
Anger lösenordet för användarkontot på den virtuella datorn när körningskommandot körs. |
|
properties.runAsUser |
string |
Anger användarkontot på den virtuella datorn när körningskommandot körs. |
|
properties.source |
Källan till körningskommandoskriptet. |
||
properties.timeoutInSeconds |
integer |
Tidsgränsen i sekunder för att köra körningskommandot. |
|
properties.treatFailureAsDeploymentFailure |
boolean |
False |
Valfritt. Om värdet är sant misslyckas eventuella fel i skriptet och ProvisioningState markeras som Misslyckad. Om värdet är falskt skulle ProvisioningState bara återspegla om körningskommandot kördes eller inte av tilläggsplattformen. Det skulle inte ange om skriptet misslyckades vid skriptfel. Se instansvyn för körningskommandot vid skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results |
tags |
object |
Resurstaggar |
|
type |
string |
Resurstyp |
VirtualMachineRunCommandInstanceView
Instansvyn för ett virtuellt datorkörningskommando.
Name | Typ | Description |
---|---|---|
endTime |
string |
Sluttid för skript. |
error |
string |
Skriptfelström. |
executionMessage |
string |
Kommunicera skriptkonfigurationsfel eller körningsmeddelanden. |
executionState |
Skriptkörningsstatus. |
|
exitCode |
integer |
Slutkod som returneras från skriptkörning. |
output |
string |
Utdataström för skript. |
startTime |
string |
Starttid för skript. |
statuses |
Resursstatusinformationen. |
VirtualMachineRunCommandScriptSource
Beskriver skriptkällorna för körningskommandot. Använd bara ett skript, scriptUri, commandId.
Name | Typ | Description |
---|---|---|
commandId |
string |
Anger ett commandId för fördefinierade inbyggda skript. |
script |
string |
Anger skriptinnehållet som ska köras på den virtuella datorn. |
scriptUri |
string |
Anger platsen för skriptnedladdning. Det kan vara antingen SAS-URI för en Azure Storage-blob med läsåtkomst eller offentlig URI. |
scriptUriManagedIdentity |
Användartilldelad hanterad identitet som har åtkomst till scriptUri vid Azure Storage-blob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att Azure Storage-bloben finns och att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Reader". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och Kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged. |
VirtualMachineRunCommandUpdate
Beskriver ett körningskommando för virtuell dator.
Name | Typ | Standardvärde | Description |
---|---|---|---|
properties.asyncExecution |
boolean |
False |
Valfritt. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras. |
properties.errorBlobManagedIdentity |
Användartilldelad hanterad identitet som har åtkomst till errorBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Contributor". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged |
||
properties.errorBlobUri |
string |
Anger den Azure Storage-blob där skriptfelströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern errorBlobManagedIdentity. |
|
properties.instanceView |
Den virtuella datorn kör kommandoinstansvyn. |
||
properties.outputBlobManagedIdentity |
Användartilldelad hanterad identitet som har åtkomst till outputBlobUri-lagringsblob. Använd ett tomt objekt om det finns en systemtilldelad identitet. Kontrollera att den hanterade identiteten har fått åtkomst till blobcontainern med rolltilldelningen "Storage Blob Data Contributor". När det gäller användartilldelad identitet kontrollerar du att du lägger till den under den virtuella datorns identitet. Mer information om hanterad identitet och kör kommando finns i https://aka.ms/ManagedIdentity och https://aka.ms/RunCommandManaged |
||
properties.outputBlobUri |
string |
Anger den Azure Storage-blob där skriptutdataströmmen ska laddas upp. Använd en SAS-URI med läs-, tilläggs-, skapa-, skrivåtkomst eller använd hanterad identitet för att ge den virtuella datorn åtkomst till bloben. Se parametern outputBlobManagedIdentity. |
|
properties.parameters |
De parametrar som används av skriptet. |
||
properties.protectedParameters |
De parametrar som används av skriptet. |
||
properties.provisioningState |
string |
Etableringstillståndet, som bara visas i svaret. Om treatFailureAsDeploymentFailure är inställt på true misslyckas distributionen och ProvisioningState markeras som Misslyckad. Om treatFailureAsDeploymentFailure är inställt på falskt, skulle ProvisioningState bara återspegla om körningskommandot kördes eller inte av tilläggsplattformen, det skulle inte ange om skriptet misslyckades vid skriptfel. Se instansvyn för körningskommandot vid skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results |
|
properties.runAsPassword |
string |
Anger lösenordet för användarkontot på den virtuella datorn när körningskommandot körs. |
|
properties.runAsUser |
string |
Anger användarkontot på den virtuella datorn när körningskommandot körs. |
|
properties.source |
Källan till körningskommandoskriptet. |
||
properties.timeoutInSeconds |
integer |
Tidsgränsen i sekunder för att köra körningskommandot. |
|
properties.treatFailureAsDeploymentFailure |
boolean |
False |
Valfritt. Om värdet är sant misslyckas eventuella fel i skriptet och ProvisioningState markeras som Misslyckad. Om värdet är falskt skulle ProvisioningState bara återspegla om körningskommandot kördes eller inte av tilläggsplattformen. Det skulle inte ange om skriptet misslyckades vid skriptfel. Se instansvyn för körningskommandot vid skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results |
tags |
object |
Resurstaggar |