Sdílet prostřednictvím

Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2023-09-01

  • Článek

Definice prostředku Bicep

Typ prostředku virtualMachineScaleSets/virtualMachines/runCommands je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-09-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'
  }
}

Hodnoty vlastností

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Jméno Popis Hodnota
umístění Umístění prostředku string (povinné)
Jméno Název prostředku string (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: virtualMachineScaleSets/virtualMachines
vlastnosti Popisuje vlastnosti příkazu spuštění virtuálního počítače. VirtualMachineRunCommandProperties
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

Značky prostředků

Jméno Popis Hodnota

RunCommandInputParameter

Jméno Popis Hodnota
Jméno Název parametru příkazu run. string (povinné)
hodnota Hodnota parametru příkazu run. string (povinné)

RunCommandManagedIdentity

Jméno Popis Hodnota
clientId ID klienta (hodnota GUID) spravované identity přiřazené uživatelem Id objektu by se nemělo používat, pokud je k dispozici. řetězec
objectId ID objektu (hodnota GUID) spravované identity přiřazené uživatelem Id klienta by se nemělo používat, pokud je k dispozici. řetězec

VirtualMachineRunCommandProperties

Jméno Popis Hodnota
asyncExecution Volitelný. Pokud je hodnota true, zřizování se dokončí, jakmile se skript spustí a nečeká na dokončení skriptu. Bool
errorBlobManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k objektu blob úložiště errorBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Určuje objekt blob úložiště Azure, kde se nahraje chybový stream skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si parametr errorBlobManagedIdentity. řetězec
outputBlobManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k výstupnímu objektu blob úložištěBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Určuje objekt blob úložiště Azure, ve kterém se nahraje výstupní datový proud skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si výstupní parametrBlobManagedIdentity. řetězec
parametry Parametry používané skriptem. RunCommandInputParameter[]
protectedParameters Parametry používané skriptem. RunCommandInputParameter[]
runAsPassword Určuje heslo uživatelského účtu na virtuálním počítači při spuštění příkazu run. řetězec
runAsUser Určuje uživatelský účet na virtuálním počítači při spuštění příkazu spustit. řetězec
zdroj Zdroj skriptu příkazu run. VirtualMachineRunCommandScriptSource
timeoutInSeconds Časový limit v sekundách pro spuštění příkazu. Int
treatFailureAsDeploymentFailure Volitelný. Pokud je nastavená hodnota true, selhání ve skriptu selže nasazení a ProvisioningState se označí jako Neúspěšné. Pokud nastavíte hodnotu false, ProvisioningState bude odrážet pouze to, jestli byl příkaz spuštění spuštěný nebo ne platformou rozšíření, nezoznačuje, jestli skript selhal v případě selhání skriptu. Zobrazení spuštění příkazu instance v případě selhání skriptu zobrazit executionMessage, výstup, chyba: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Jméno Popis Hodnota
commandId Určuje commandId předdefinovaného předdefinovaného skriptu. řetězec
skript Určuje obsah skriptu, který se má na virtuálním počítači spustit. řetězec
scriptUri Určuje umístění stahování skriptu. Může to být identifikátor URI SAS objektu blob úložiště Azure s přístupem pro čtení nebo veřejným identifikátorem URI. řetězec
scriptUriManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k identifikátoru scriptUri v případě objektu blob úložiště Azure. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že objekt blob úložiště Azure existuje, a spravovaná identita má udělený přístup k kontejneru objektu blob s přiřazením role Čtenář dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Definice prostředku šablony ARM

Typ prostředku virtualMachineScaleSets/virtualMachines/runCommands je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, přidejte do šablony následující JSON.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
  "apiVersion": "2023-09-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"
  }
}

Hodnoty vlastností

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2023-09-01'
umístění Umístění prostředku string (povinné)
Jméno Název prostředku string (povinné)
vlastnosti Popisuje vlastnosti příkazu spuštění virtuálního počítače. VirtualMachineRunCommandProperties
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Značky prostředků

Jméno Popis Hodnota

RunCommandInputParameter

Jméno Popis Hodnota
Jméno Název parametru příkazu run. string (povinné)
hodnota Hodnota parametru příkazu run. string (povinné)

RunCommandManagedIdentity

Jméno Popis Hodnota
clientId ID klienta (hodnota GUID) spravované identity přiřazené uživatelem Id objektu by se nemělo používat, pokud je k dispozici. řetězec
objectId ID objektu (hodnota GUID) spravované identity přiřazené uživatelem Id klienta by se nemělo používat, pokud je k dispozici. řetězec

VirtualMachineRunCommandProperties

Jméno Popis Hodnota
asyncExecution Volitelný. Pokud je hodnota true, zřizování se dokončí, jakmile se skript spustí a nečeká na dokončení skriptu. Bool
errorBlobManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k objektu blob úložiště errorBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Určuje objekt blob úložiště Azure, kde se nahraje chybový stream skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si parametr errorBlobManagedIdentity. řetězec
outputBlobManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k výstupnímu objektu blob úložištěBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Určuje objekt blob úložiště Azure, ve kterém se nahraje výstupní datový proud skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si výstupní parametrBlobManagedIdentity. řetězec
parametry Parametry používané skriptem. RunCommandInputParameter[]
protectedParameters Parametry používané skriptem. RunCommandInputParameter[]
runAsPassword Určuje heslo uživatelského účtu na virtuálním počítači při spuštění příkazu run. řetězec
runAsUser Určuje uživatelský účet na virtuálním počítači při spuštění příkazu spustit. řetězec
zdroj Zdroj skriptu příkazu run. VirtualMachineRunCommandScriptSource
timeoutInSeconds Časový limit v sekundách pro spuštění příkazu. Int
treatFailureAsDeploymentFailure Volitelný. Pokud je nastavená hodnota true, selhání ve skriptu selže nasazení a ProvisioningState se označí jako Neúspěšné. Pokud nastavíte hodnotu false, ProvisioningState bude odrážet pouze to, jestli byl příkaz spuštění spuštěný nebo ne platformou rozšíření, nezoznačuje, jestli skript selhal v případě selhání skriptu. Zobrazení spuštění příkazu instance v případě selhání skriptu zobrazit executionMessage, výstup, chyba: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Jméno Popis Hodnota
commandId Určuje commandId předdefinovaného předdefinovaného skriptu. řetězec
skript Určuje obsah skriptu, který se má na virtuálním počítači spustit. řetězec
scriptUri Určuje umístění stahování skriptu. Může to být identifikátor URI SAS objektu blob úložiště Azure s přístupem pro čtení nebo veřejným identifikátorem URI. řetězec
scriptUriManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k identifikátoru scriptUri v případě objektu blob úložiště Azure. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že objekt blob úložiště Azure existuje, a spravovaná identita má udělený přístup k kontejneru objektu blob s přiřazením role Čtenář dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku virtualMachineScaleSets/virtualMachines/runCommands je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands

Jméno Popis Hodnota
umístění Umístění prostředku string (povinné)
Jméno Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: virtualMachineScaleSets/virtualMachines
vlastnosti Popisuje vlastnosti příkazu spuštění virtuálního počítače. VirtualMachineRunCommandProperties
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-09-01

Značky prostředků

Jméno Popis Hodnota

RunCommandInputParameter

Jméno Popis Hodnota
Jméno Název parametru příkazu run. string (povinné)
hodnota Hodnota parametru příkazu run. string (povinné)

RunCommandManagedIdentity

Jméno Popis Hodnota
clientId ID klienta (hodnota GUID) spravované identity přiřazené uživatelem Id objektu by se nemělo používat, pokud je k dispozici. řetězec
objectId ID objektu (hodnota GUID) spravované identity přiřazené uživatelem Id klienta by se nemělo používat, pokud je k dispozici. řetězec

VirtualMachineRunCommandProperties

Jméno Popis Hodnota
asyncExecution Volitelný. Pokud je hodnota true, zřizování se dokončí, jakmile se skript spustí a nečeká na dokončení skriptu. Bool
errorBlobManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k objektu blob úložiště errorBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
errorBlobUri Určuje objekt blob úložiště Azure, kde se nahraje chybový stream skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si parametr errorBlobManagedIdentity. řetězec
outputBlobManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k výstupnímu objektu blob úložištěBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že spravovaná identita získala přístup k kontejneru objektu blob s přiřazením role Přispěvatel dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Určuje objekt blob úložiště Azure, ve kterém se nahraje výstupní datový proud skriptu. K poskytnutí přístupu k objektu blob použijte identifikátor URI SAS se čtením, připojením, vytvořením, přístupem k zápisu nebo spravovanou identitou. Projděte si výstupní parametrBlobManagedIdentity. řetězec
parametry Parametry používané skriptem. RunCommandInputParameter[]
protectedParameters Parametry používané skriptem. RunCommandInputParameter[]
runAsPassword Určuje heslo uživatelského účtu na virtuálním počítači při spuštění příkazu run. řetězec
runAsUser Určuje uživatelský účet na virtuálním počítači při spuštění příkazu spustit. řetězec
zdroj Zdroj skriptu příkazu run. VirtualMachineRunCommandScriptSource
timeoutInSeconds Časový limit v sekundách pro spuštění příkazu. Int
treatFailureAsDeploymentFailure Volitelný. Pokud je nastavená hodnota true, selhání ve skriptu selže nasazení a ProvisioningState se označí jako Neúspěšné. Pokud nastavíte hodnotu false, ProvisioningState bude odrážet pouze to, jestli byl příkaz spuštění spuštěný nebo ne platformou rozšíření, nezoznačuje, jestli skript selhal v případě selhání skriptu. Zobrazení spuštění příkazu instance v případě selhání skriptu zobrazit executionMessage, výstup, chyba: https://aka.ms/runcommandmanaged#get-execution-status-and-results Bool

VirtualMachineRunCommandScriptSource

Jméno Popis Hodnota
commandId Určuje commandId předdefinovaného předdefinovaného skriptu. řetězec
skript Určuje obsah skriptu, který se má na virtuálním počítači spustit. řetězec
scriptUri Určuje umístění stahování skriptu. Může to být identifikátor URI SAS objektu blob úložiště Azure s přístupem pro čtení nebo veřejným identifikátorem URI. řetězec
scriptUriManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k identifikátoru scriptUri v případě objektu blob úložiště Azure. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že objekt blob úložiště Azure existuje, a spravovaná identita má udělený přístup k kontejneru objektu blob s přiřazením role Čtenář dat objektů blob služby Storage. V případě identity přiřazené uživatelem se ujistěte, že ji přidáte do identity virtuálního počítače. Další informace o spravované identitě a příkazu Spustit najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged. RunCommandManagedIdentity