Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2021-03-01

Bicep-Ressourcendefinition

Der Ressourcentyp virtualMachineScaleSets/virtualMachines/runCommands kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    asyncExecution: bool
    errorBlobUri: 'string'
    outputBlobUri: 'string'
    parameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    protectedParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    runAsPassword: 'string'
    runAsUser: 'string'
    source: {
      commandId: 'string'
      script: 'string'
      scriptUri: 'string'
    }
    timeoutInSeconds: int
  }
}

Eigenschaftswerte

virtualMachineScaleSets/virtualMachines/runCommands

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.
Zeichenfolge (erforderlich)
location Ressourcenspeicherort Zeichenfolge (erforderlich)
tags Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für ressource vom Typ: virtualMachines
properties Beschreibt die Eigenschaften eines Vm-Ausführungsbefehls. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Name BESCHREIBUNG Wert
asyncExecution Optional. Wenn true festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird, und wartet nicht auf den Abschluss des Skripts. bool
errorBlobUri Gibt das Azure-Speicherblob an, in das der Skriptfehlerstream hochgeladen wird. Zeichenfolge
outputBlobUri Gibt das Azure Storage-Blob an, in das der Skriptausgabestream hochgeladen wird. Zeichenfolge
parameters Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
protectedParameters Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
runAsPassword Gibt das Benutzerkontokennwort auf dem virtuellen Computer an, wenn der Befehl "ausführen" ausgeführt wird. Zeichenfolge
runAsUser Gibt das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird. Zeichenfolge
source Die Quelle des Ausführungsbefehlsskripts. VirtualMachineRunCommandScriptSource
timeoutInSeconds Das Timeout in Sekunden, um den Befehl ausführen zu können. INT

RunCommandInputParameter

Name BESCHREIBUNG Wert
name Der Name des Befehlsparameters ausführen. Zeichenfolge (erforderlich)
value Der Wert des Befehlsparameters ausführen. Zeichenfolge (erforderlich)

VirtualMachineRunCommandScriptSource

Name BESCHREIBUNG Wert
commandId Gibt eine CommandId des vordefinierten integrierten Skripts an. Zeichenfolge
script Gibt den Skriptinhalt an, der auf dem virtuellen Computer ausgeführt werden soll. Zeichenfolge
scriptUri Gibt den Speicherort für den Skriptdownload an. Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp virtualMachineScaleSets/virtualMachines/runCommands kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Ressource Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2021-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "asyncExecution": "bool",
    "errorBlobUri": "string",
    "outputBlobUri": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "protectedParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "runAsPassword": "string",
    "runAsUser": "string",
    "source": {
      "commandId": "string",
      "script": "string",
      "scriptUri": "string"
    },
    "timeoutInSeconds": "int"
  }
}

Eigenschaftswerte

virtualMachineScaleSets/virtualMachines/runCommands

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands"
apiVersion Die Version der Ressourcen-API '2021-03-01'
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.
Zeichenfolge (erforderlich)
location Ressourcenspeicherort Zeichenfolge (erforderlich)
tags Ressourcentags Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen.
properties Beschreibt die Eigenschaften eines Vm-Ausführungsbefehls. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Name BESCHREIBUNG Wert
asyncExecution Optional. Wenn dieser Wert auf TRUE festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird, und es wird nicht auf den Abschluss des Skripts gewartet. bool
errorBlobUri Gibt das Azure Storage-Blob an, in das der Skriptfehlerstream hochgeladen wird. Zeichenfolge
outputBlobUri Gibt das Azure Storage-Blob an, in das der Skriptausgabestream hochgeladen wird. Zeichenfolge
parameters Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
protectedParameters Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
runAsPassword Gibt das Benutzerkontokennwort auf dem virtuellen Computer an, wenn der Befehl run ausgeführt wird. Zeichenfolge
runAsUser Gibt das Benutzerkonto auf dem virtuellen Computer an, wenn der Befehl run ausgeführt wird. Zeichenfolge
source Die Quelle des Ausführungsbefehlsskripts. VirtualMachineRunCommandScriptSource
timeoutInSeconds Das Timeout in Sekunden zum Ausführen des Ausführungsbefehls. INT

RunCommandInputParameter

Name BESCHREIBUNG Wert
name Der Name des Run-Befehlsparameters. Zeichenfolge (erforderlich)
value Der Wert des Befehlsparameters run. Zeichenfolge (erforderlich)

VirtualMachineRunCommandScriptSource

Name BESCHREIBUNG Wert
commandId Gibt eine commandId des vordefinierten integrierten Skripts an. Zeichenfolge
script Gibt den Skriptinhalt an, der auf dem virtuellen Computer ausgeführt werden soll. Zeichenfolge
scriptUri Gibt den Speicherort für den Skriptdownload an. Zeichenfolge

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp virtualMachineScaleSets/virtualMachines/runCommands kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      asyncExecution = bool
      errorBlobUri = "string"
      outputBlobUri = "string"
      parameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      protectedParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      runAsPassword = "string"
      runAsUser = "string"
      source = {
        commandId = "string"
        script = "string"
        scriptUri = "string"
      }
      timeoutInSeconds = int
    }
  })
}

Eigenschaftswerte

virtualMachineScaleSets/virtualMachines/runCommands

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2021-03-01"
name Der Ressourcenname Zeichenfolge (erforderlich)
location Ressourcenspeicherort Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ : virtualMachines
tags Ressourcentags Wörterbuch der Tagnamen und -werte.
properties Beschreibt die Eigenschaften eines Vm-Ausführungsbefehls. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Name BESCHREIBUNG Wert
asyncExecution Optional. Wenn true festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird, und wartet nicht auf den Abschluss des Skripts. bool
errorBlobUri Gibt das Azure-Speicherblob an, in das der Skriptfehlerstream hochgeladen wird. Zeichenfolge
outputBlobUri Gibt das Azure Storage-Blob an, in das der Skriptausgabestream hochgeladen wird. Zeichenfolge
parameters Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
protectedParameters Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
runAsPassword Gibt das Benutzerkontokennwort auf dem virtuellen Computer an, wenn der Befehl "ausführen" ausgeführt wird. Zeichenfolge
runAsUser Gibt das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird. Zeichenfolge
source Die Quelle des Ausführungsbefehlsskripts. VirtualMachineRunCommandScriptSource
timeoutInSeconds Das Timeout in Sekunden, um den Befehl ausführen zu können. INT

RunCommandInputParameter

Name BESCHREIBUNG Wert
name Der Name des Befehlsparameters ausführen. Zeichenfolge (erforderlich)
value Der Wert des Befehlsparameters ausführen. Zeichenfolge (erforderlich)

VirtualMachineRunCommandScriptSource

Name BESCHREIBUNG Wert
commandId Gibt eine CommandId des vordefinierten integrierten Skripts an. Zeichenfolge
script Gibt den Skriptinhalt an, der auf dem virtuellen Computer ausgeführt werden soll. Zeichenfolge
scriptUri Gibt den Speicherort für den Skriptdownload an. Zeichenfolge