Freigeben über

Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2022-08-01

  • Artikel

Bicep-Ressourcendefinition

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 unter Änderungsprotokoll.

Ressourcenformat

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

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2022-08-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  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
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschaftswerte

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Name Beschreibung Wert
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge (erforderlich)
Elternteil 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 des Typs: virtualMachineScaleSets/virtualMachines
Eigenschaften Beschreibt die Eigenschaften eines Befehls zum Ausführen eines virtuellen Computers. VirtualMachineRunCommandProperties
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

ResourceTags

Name Beschreibung Wert

RunCommandInputParameter

Name Beschreibung Wert
Name Der Name des Ausführen-Befehlsparameters. Zeichenfolge (erforderlich)
Wert Der Wert des Ausführen-Befehlsparameters. Zeichenfolge (erforderlich)

VirtualMachineRunCommandProperties

Name Beschreibung Wert
asyncExecution Wahlfrei. Wenn "true" festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird und nicht auf den Abschluss des Skripts wartet. Bool
errorBlobUri Gibt das Azure Storage-Blob an, bei dem der Skriptfehlerdatenstrom hochgeladen wird. Schnur
outputBlobUri Gibt das Azure Storage-Blob an, in das der Skriptausgabedatenstrom hochgeladen wird. Schnur
Parameter Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
protectedParameters Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
runAsPassword Gibt das Kennwort für das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird. Schnur
runAsUser Gibt das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird. Schnur
Quelle Die Quelle des Ausführen-Befehlsskripts. VirtualMachineRunCommandScriptSource-
timeoutInSeconds Das Timeout in Sekunden, um den Ausführungsbefehl auszuführen. Int

VirtualMachineRunCommandScriptSource

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

ARM-Vorlagenressourcendefinition

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 unter Änderungsprotokoll.

Ressourcenformat

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

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2022-08-01",
  "name": "string",
  "location": "string",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschaftswerte

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Name Beschreibung Wert
apiVersion Die API-Version '2022-08-01'
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Beschreibt die Eigenschaften eines Befehls zum Ausführen eines virtuellen Computers. VirtualMachineRunCommandProperties
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands"

ResourceTags

Name Beschreibung Wert

RunCommandInputParameter

Name Beschreibung Wert
Name Der Name des Ausführen-Befehlsparameters. Zeichenfolge (erforderlich)
Wert Der Wert des Ausführen-Befehlsparameters. Zeichenfolge (erforderlich)

VirtualMachineRunCommandProperties

Name Beschreibung Wert
asyncExecution Wahlfrei. Wenn "true" festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird und nicht auf den Abschluss des Skripts wartet. Bool
errorBlobUri Gibt das Azure Storage-Blob an, bei dem der Skriptfehlerdatenstrom hochgeladen wird. Schnur
outputBlobUri Gibt das Azure Storage-Blob an, in das der Skriptausgabedatenstrom hochgeladen wird. Schnur
Parameter Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
protectedParameters Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
runAsPassword Gibt das Kennwort für das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird. Schnur
runAsUser Gibt das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird. Schnur
Quelle Die Quelle des Ausführen-Befehlsskripts. VirtualMachineRunCommandScriptSource-
timeoutInSeconds Das Timeout in Sekunden, um den Ausführungsbefehl auszuführen. Int

VirtualMachineRunCommandScriptSource

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

Verwendungsbeispiele

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 unter Änderungsprotokoll.

Ressourcenformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2022-08-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Name Beschreibung Wert
Ort Ressourcenspeicherort Zeichenfolge (erforderlich)
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: virtualMachineScaleSets/virtualMachines
Eigenschaften Beschreibt die Eigenschaften eines Befehls zum Ausführen eines virtuellen Computers. VirtualMachineRunCommandProperties
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2022-08-01"

ResourceTags

Name Beschreibung Wert

RunCommandInputParameter

Name Beschreibung Wert
Name Der Name des Ausführen-Befehlsparameters. Zeichenfolge (erforderlich)
Wert Der Wert des Ausführen-Befehlsparameters. Zeichenfolge (erforderlich)

VirtualMachineRunCommandProperties

Name Beschreibung Wert
asyncExecution Wahlfrei. Wenn "true" festgelegt ist, wird die Bereitstellung abgeschlossen, sobald das Skript gestartet wird und nicht auf den Abschluss des Skripts wartet. Bool
errorBlobUri Gibt das Azure Storage-Blob an, bei dem der Skriptfehlerdatenstrom hochgeladen wird. Schnur
outputBlobUri Gibt das Azure Storage-Blob an, in das der Skriptausgabedatenstrom hochgeladen wird. Schnur
Parameter Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
protectedParameters Die vom Skript verwendeten Parameter. RunCommandInputParameter[]
runAsPassword Gibt das Kennwort für das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird. Schnur
runAsUser Gibt das Benutzerkonto auf dem virtuellen Computer an, wenn der Ausführungsbefehl ausgeführt wird. Schnur
Quelle Die Quelle des Ausführen-Befehlsskripts. VirtualMachineRunCommandScriptSource-
timeoutInSeconds Das Timeout in Sekunden, um den Ausführungsbefehl auszuführen. Int

VirtualMachineRunCommandScriptSource

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