Dela via

Microsoft.Compute virtualMachines/runCommands 2023-09-01

  • Artikel

Bicep-resursdefinition

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

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@2023-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  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

virtualMachines/runCommands

Namn Beskrivning Värde
Namn Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 sträng (krävs)
plats Resursplats sträng (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
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

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[]
protectedParameters 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
timeoutInSeconds Tidsgränsen i sekunder för att köra körningskommandot. Int
treatFailureAsDeploymentFailure 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

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 (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges. sträng

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)

VirtualMachineRunCommandScriptSource

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

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
SharePoint-prenumeration / 2019 / 2016 / 2013 alla konfigurerade

Distribuera till Azure 		Den här mallen skapar en SharePoint-prenumeration / 2019 / 2016 / 2013-servergrupp med en omfattande konfiguration som skulle ta evigheter att utföra manuellt, inklusive en federerad autentisering med ADFS, ett OAuth-förtroende, tjänsten Användarprofiler och ett webbprogram med 2 zoner som innehåller flera sökvägsbaserade och värdnamnswebbplatssamlingar. På de virtuella SharePoint-datorerna används Chocolatey för att installera den senaste versionen av Notepad++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer och 7-Zip.

Resursdefinition för ARM-mall

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

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": "2023-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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

virtualMachines/runCommands

Namn Beskrivning Värde
typ Resurstypen "Microsoft.Compute/virtualMachines/runCommands"
apiVersion Resurs-API-versionen '2023-09-01'
Namn Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)
plats Resursplats sträng (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
Egenskaper Beskriver egenskaperna för ett körningskommando för virtuell dator. 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[]
protectedParameters 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
timeoutInSeconds Tidsgränsen i sekunder för att köra körningskommandot. Int
treatFailureAsDeploymentFailure 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

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 (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges. sträng

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)

VirtualMachineRunCommandScriptSource

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

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
SharePoint-prenumeration / 2019 / 2016 / 2013 alla konfigurerade

Distribuera till Azure 		Den här mallen skapar en SharePoint-prenumeration / 2019 / 2016 / 2013-servergrupp med en omfattande konfiguration som skulle ta evigheter att utföra manuellt, inklusive en federerad autentisering med ADFS, ett OAuth-förtroende, tjänsten Användarprofiler och ett webbprogram med 2 zoner som innehåller flera sökvägsbaserade och värdnamnswebbplatssamlingar. På de virtuella SharePoint-datorerna används Chocolatey för att installera den senaste versionen av Notepad++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer och 7-Zip.

Resursdefinition för Terraform (AzAPI-provider)

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

  • Resursgrupper

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@2023-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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

virtualMachines/runCommands

Namn Beskrivning Värde
typ Resurstypen "Microsoft.Compute/virtualMachines/runCommands@2023-09-01"
Namn Resursnamnet sträng (krävs)
plats Resursplats 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
Taggar Resurstaggar Ordlista med taggnamn och värden.
Egenskaper Beskriver egenskaperna för ett körningskommando för virtuell dator. 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[]
protectedParameters 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
timeoutInSeconds Tidsgränsen i sekunder för att köra körningskommandot. Int
treatFailureAsDeploymentFailure 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

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 (GUID-värde) för den användartilldelade hanterade identiteten. ClientId bör inte användas om detta anges. sträng

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)

VirtualMachineRunCommandScriptSource

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