Microsoft.Compute virtualMachines/runCommands 2024-07-01

2025-05-14

Bicep-resursdefinition

Resurstypen virtualMachines/runCommands kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Compute/virtualMachines/runCommands-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.Compute/virtualMachines/runCommands@2024-07-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    asyncExecution: bool
    errorBlobManagedIdentity: {
      clientId: 'string'
      objectId: 'string'
    }
    errorBlobUri: 'string'
    outputBlobManagedIdentity: {
      clientId: 'string'
      objectId: 'string'
    }
    outputBlobUri: 'string'
    parameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    protectedParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    runAsPassword: 'string'
    runAsUser: 'string'
    source: {
      commandId: 'string'
      script: 'string'
      scriptUri: 'string'
      scriptUriManagedIdentity: {
        clientId: 'string'
        objectId: 'string'
      }
    }
    timeoutInSeconds: int
    treatFailureAsDeploymentFailure: bool
  }
  tags: {
    {customized property}: 'string'
  }
}

Egenskapsvärden

Microsoft.Compute/virtualMachines/runCommands

Namn	Beskrivning	Värde
plats	Resursplats	sträng (krävs)
Namn	Resursnamnet	sträng (krävs)
förälder	I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen.	Symboliskt namn för resurs av typen: virtualMachines
Egenskaper	Beskriver egenskaperna för ett körningskommando för virtuell dator.	VirtualMachineRunCommandProperties (VirtualMachineRunCommandProperties)
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar

Resurstaggar

Namn	Beskrivning	Värde

RunCommandInputParameter

Namn	Beskrivning	Värde
Namn	Namnet på körningskommandoparametern.	sträng (krävs)
värde	Parametervärdet för körningskommandot.	sträng (krävs)

RunCommandManagedIdentity

Namn	Beskrivning	Värde
clientId	Klient-ID (GUID-värde) för den användartilldelade hanterade identiteten. ObjectId bör inte användas om detta anges.	sträng
objectId (objekt-ID)	Objekt-ID (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges.	sträng

VirtualMachineRunCommandProperties (VirtualMachineRunCommandProperties)

Namn	Beskrivning	Värde
asyncExecution	Valfri. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras.	Bool
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 måste du lägga 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	RunCommandManagedIdentity
errorBlobUri	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.	sträng
outputBlobManagedIdentity	Användartilldelad hanterad identitet som har åtkomst till utdataBlobUri-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 måste du lägga 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	RunCommandManagedIdentity
outputBlobUri	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.	sträng
Parametrar	Parametrarna som används av skriptet.	RunCommandInputParameter[]
skyddade parametrar	Parametrarna som används av skriptet.	RunCommandInputParameter[]
runAsPassword	Anger lösenordet för användarkontot på den virtuella datorn när körningskommandot körs.	sträng
runAsUser	Anger användarkontot på den virtuella datorn när körningskommandot körs.	sträng
källa	Källan till körningskommandoskriptet.	VirtualMachineRunCommandScriptSource (på engelska)
timeoutInSeconds (timeout)Sekunder	Tidsgränsen i sekunder för att köra körningskommandot.	Int
BehandlaFelSomDistribueringsfel	Valfri. Om värdet är true kommer eventuella fel i skriptet att misslyckas med distributionen och ProvisioningState markeras som Misslyckades. 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 i händelse av skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results	Bool

VirtualMachineRunCommandScriptSource (på engelska)

Namn	Beskrivning	Värde
commandId	Anger ett commandId för fördefinierat inbyggt skript.	sträng
manus	Anger skriptinnehållet som ska köras på den virtuella datorn.	sträng
scriptUri	Anger platsen för skripthämtning. Det kan vara antingen SAS-URI för en Azure-lagringsblob med läsåtkomst eller offentlig URI.	sträng
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 måste du lägga 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.	RunCommandManagedIdentity

Användningsexempel

Azure-snabbstartsexempel

Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.

Bicep-fil	Beskrivning
GitLab Omnibus	Den här mallen förenklar distributionen av GitLab Omnibus på en virtuell dator med en offentlig DNS, vilket utnyttjar den offentliga IP-adressens DNS. Den använder Standard_F8s_v2 instansstorlek, som överensstämmer med referensarkitekturen och har stöd för upp till 1 000 användare (20 RPS). Instansen är förkonfigurerad för att använda HTTPS med ett Let's Encrypt-certifikat för säkra anslutningar.

Bicep-fil

Beskrivning

GitLab Omnibus

Den här mallen förenklar distributionen av GitLab Omnibus på en virtuell dator med en offentlig DNS, vilket utnyttjar den offentliga IP-adressens DNS. Den använder Standard_F8s_v2 instansstorlek, som överensstämmer med referensarkitekturen och har stöd för upp till 1 000 användare (20 RPS). Instansen är förkonfigurerad för att använda HTTPS med ett Let's Encrypt-certifikat för säkra anslutningar.

Resursdefinition för ARM-mall

Resurstypen virtualMachines/runCommands kan distribueras med åtgärder som mål:

Resursgrupper – Se resursgruppsdistributionskommandon

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Compute/virtualMachines/runCommands-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.Compute/virtualMachines/runCommands",
  "apiVersion": "2024-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "asyncExecution": "bool",
    "errorBlobManagedIdentity": {
      "clientId": "string",
      "objectId": "string"
    },
    "errorBlobUri": "string",
    "outputBlobManagedIdentity": {
      "clientId": "string",
      "objectId": "string"
    },
    "outputBlobUri": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "protectedParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "runAsPassword": "string",
    "runAsUser": "string",
    "source": {
      "commandId": "string",
      "script": "string",
      "scriptUri": "string",
      "scriptUriManagedIdentity": {
        "clientId": "string",
        "objectId": "string"
      }
    },
    "timeoutInSeconds": "int",
    "treatFailureAsDeploymentFailure": "bool"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Egenskapsvärden

Microsoft.Compute/virtualMachines/runCommands

Namn	Beskrivning	Värde
apiVersion	API-versionen	'2024-07-01'
plats	Resursplats	sträng (krävs)
Namn	Resursnamnet	sträng (krävs)
Egenskaper	Beskriver egenskaperna för ett körningskommando för virtuell dator.	VirtualMachineRunCommandProperties (VirtualMachineRunCommandProperties)
Taggar	Resurstaggar	Ordlista med taggnamn och värden. Se taggar i mallar
typ	Resurstypen	"Microsoft.Compute/virtualMachines/runCommands"

Resurstaggar

Namn	Beskrivning	Värde

RunCommandInputParameter

Namn	Beskrivning	Värde
Namn	Namnet på körningskommandoparametern.	sträng (krävs)
värde	Parametervärdet för körningskommandot.	sträng (krävs)

RunCommandManagedIdentity

Namn	Beskrivning	Värde
clientId	Klient-ID (GUID-värde) för den användartilldelade hanterade identiteten. ObjectId bör inte användas om detta anges.	sträng
objectId (objekt-ID)	Objekt-ID (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges.	sträng

VirtualMachineRunCommandProperties (VirtualMachineRunCommandProperties)

Namn	Beskrivning	Värde
asyncExecution	Valfri. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras.	Bool
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 måste du lägga 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	RunCommandManagedIdentity
errorBlobUri	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.	sträng
outputBlobManagedIdentity	Användartilldelad hanterad identitet som har åtkomst till utdataBlobUri-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 måste du lägga 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	RunCommandManagedIdentity
outputBlobUri	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.	sträng
Parametrar	Parametrarna som används av skriptet.	RunCommandInputParameter[]
skyddade parametrar	Parametrarna som används av skriptet.	RunCommandInputParameter[]
runAsPassword	Anger lösenordet för användarkontot på den virtuella datorn när körningskommandot körs.	sträng
runAsUser	Anger användarkontot på den virtuella datorn när körningskommandot körs.	sträng
källa	Källan till körningskommandoskriptet.	VirtualMachineRunCommandScriptSource (på engelska)
timeoutInSeconds (timeout)Sekunder	Tidsgränsen i sekunder för att köra körningskommandot.	Int
BehandlaFelSomDistribueringsfel	Valfri. Om värdet är true kommer eventuella fel i skriptet att misslyckas med distributionen och ProvisioningState markeras som Misslyckades. 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 i händelse av skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results	Bool

VirtualMachineRunCommandScriptSource (på engelska)

Namn	Beskrivning	Värde
commandId	Anger ett commandId för fördefinierat inbyggt skript.	sträng
manus	Anger skriptinnehållet som ska köras på den virtuella datorn.	sträng
scriptUri	Anger platsen för skripthämtning. Det kan vara antingen SAS-URI för en Azure-lagringsblob med läsåtkomst eller offentlig URI.	sträng
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 måste du lägga 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.	RunCommandManagedIdentity

Användningsexempel

Azure-snabbstartsmallar

Följande Azure-snabbstartsmallar distribuera den här resurstypen.

Mall	Beskrivning
GitLab Omnibus	Den här mallen förenklar distributionen av GitLab Omnibus på en virtuell dator med en offentlig DNS, vilket utnyttjar den offentliga IP-adressens DNS. Den använder Standard_F8s_v2 instansstorlek, som överensstämmer med referensarkitekturen och har stöd för upp till 1 000 användare (20 RPS). Instansen är förkonfigurerad för att använda HTTPS med ett Let's Encrypt-certifikat för säkra anslutningar.

Mall

Beskrivning

GitLab Omnibus

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen virtualMachines/runCommands kan distribueras med åtgärder som mål:

Resursgrupp

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Compute/virtualMachines/runCommands-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/runCommands@2024-07-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      asyncExecution = bool
      errorBlobManagedIdentity = {
        clientId = "string"
        objectId = "string"
      }
      errorBlobUri = "string"
      outputBlobManagedIdentity = {
        clientId = "string"
        objectId = "string"
      }
      outputBlobUri = "string"
      parameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      protectedParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      runAsPassword = "string"
      runAsUser = "string"
      source = {
        commandId = "string"
        script = "string"
        scriptUri = "string"
        scriptUriManagedIdentity = {
          clientId = "string"
          objectId = "string"
        }
      }
      timeoutInSeconds = int
      treatFailureAsDeploymentFailure = bool
    }
  }
}

Egenskapsvärden

Microsoft.Compute/virtualMachines/runCommands

Namn	Beskrivning	Värde
plats	Resursplats	sträng (krävs)
Namn	Resursnamnet	sträng (krävs)
parent_id	ID för resursen som är överordnad för den här resursen.	ID för resurs av typen: virtualMachines
Egenskaper	Beskriver egenskaperna för ett körningskommando för virtuell dator.	VirtualMachineRunCommandProperties (VirtualMachineRunCommandProperties)
Taggar	Resurstaggar	Ordlista med taggnamn och värden.
typ	Resurstypen	"Microsoft.Compute/virtualMachines/runCommands@2024-07-01"

Resurstaggar

Namn	Beskrivning	Värde

RunCommandInputParameter

Namn	Beskrivning	Värde
Namn	Namnet på körningskommandoparametern.	sträng (krävs)
värde	Parametervärdet för körningskommandot.	sträng (krävs)

RunCommandManagedIdentity

Namn	Beskrivning	Värde
clientId	Klient-ID (GUID-värde) för den användartilldelade hanterade identiteten. ObjectId bör inte användas om detta anges.	sträng
objectId (objekt-ID)	Objekt-ID (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges.	sträng

VirtualMachineRunCommandProperties (VirtualMachineRunCommandProperties)

Namn	Beskrivning	Värde
asyncExecution	Valfri. Om värdet är true slutförs etableringen så snart skriptet startar och väntar inte på att skriptet ska slutföras.	Bool
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 måste du lägga 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	RunCommandManagedIdentity
errorBlobUri	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.	sträng
outputBlobManagedIdentity	Användartilldelad hanterad identitet som har åtkomst till utdataBlobUri-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 måste du lägga 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	RunCommandManagedIdentity
outputBlobUri	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.	sträng
Parametrar	Parametrarna som används av skriptet.	RunCommandInputParameter[]
skyddade parametrar	Parametrarna som används av skriptet.	RunCommandInputParameter[]
runAsPassword	Anger lösenordet för användarkontot på den virtuella datorn när körningskommandot körs.	sträng
runAsUser	Anger användarkontot på den virtuella datorn när körningskommandot körs.	sträng
källa	Källan till körningskommandoskriptet.	VirtualMachineRunCommandScriptSource (på engelska)
timeoutInSeconds (timeout)Sekunder	Tidsgränsen i sekunder för att köra körningskommandot.	Int
BehandlaFelSomDistribueringsfel	Valfri. Om värdet är true kommer eventuella fel i skriptet att misslyckas med distributionen och ProvisioningState markeras som Misslyckades. 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 i händelse av skriptfel för att se executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results	Bool

VirtualMachineRunCommandScriptSource (på engelska)

Namn	Beskrivning	Värde
commandId	Anger ett commandId för fördefinierat inbyggt skript.	sträng
manus	Anger skriptinnehållet som ska köras på den virtuella datorn.	sträng
scriptUri	Anger platsen för skripthämtning. Det kan vara antingen SAS-URI för en Azure-lagringsblob med läsåtkomst eller offentlig URI.	sträng
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 måste du lägga 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.	RunCommandManagedIdentity

Dela via

Microsoft.Compute virtualMachines/runCommands 2024-07-01

Bicep-resursdefinition

Resursformat

Egenskapsvärden

Microsoft.Compute/virtualMachines/runCommands

Resurstaggar

RunCommandInputParameter

RunCommandManagedIdentity

VirtualMachineRunCommandProperties (VirtualMachineRunCommandProperties)

VirtualMachineRunCommandScriptSource (på engelska)

Användningsexempel

Azure-snabbstartsexempel

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

Microsoft.Compute/virtualMachines/runCommands

Resurstaggar

RunCommandInputParameter

RunCommandManagedIdentity

VirtualMachineRunCommandProperties (VirtualMachineRunCommandProperties)

VirtualMachineRunCommandScriptSource (på engelska)

Användningsexempel

Azure-snabbstartsmallar

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

Microsoft.Compute/virtualMachines/runCommands

Resurstaggar

RunCommandInputParameter

RunCommandManagedIdentity

VirtualMachineRunCommandProperties (VirtualMachineRunCommandProperties)

VirtualMachineRunCommandScriptSource (på engelska)

Feedback

Ytterligare resurser