Sdílet prostřednictvím

Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands

  • Článek

Definice prostředku Bicep

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

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' = {
  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
  }
}

Hodnoty vlastností

virtualMachineScaleSets/virtualMachines/runCommands

Název Description Hodnota
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v nástroji Bicep.		 string (povinné)
location Umístění prostředku string (povinné)
tags Značky prostředků Slovník názvů a hodnot značek. Zobrazit značky v šablonách
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí 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 : virtualMachines
properties Popisuje vlastnosti příkazu spuštění virtuálního počítače. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Název Description Hodnota
asyncExecution Nepovinný parametr. Pokud je nastavená hodnota true, zřizování se dokončí hned po spuštění skriptu a nebude čekat na dokončení skriptu. bool
chybaBlobManagedIdentity 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 má spravovaná identita udělený přístup ke kontejneru objektu blob s přiřazením role Přispěvatel dat v objektech blob služby Storage. V případě identity přiřazené uživatelem nezapomeňte ji přidat pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit příkaz najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
chybaBlobUri Určuje objekt blob úložiště Azure, do kterého se nahraje stream chyb skriptu. Použijte identifikátor URI SAS s přístupem ke čtení, připojení, vytvoření, zápisu nebo použijte spravovanou identitu k poskytnutí přístupu virtuálního počítače k objektu blob. Projděte si parametr errorBlobManagedIdentity. řetězec
outputBlobManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k objektu blob úložiště outputBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že má spravovaná identita udělený přístup ke kontejneru objektu blob s přiřazením role Přispěvatel dat v objektech blob služby Storage. V případě identity přiřazené uživatelem nezapomeňte ji přidat pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit příkaz najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Určuje objekt blob úložiště Azure, do kterého se nahraje výstupní stream skriptu. Použijte identifikátor URI SAS s přístupem ke čtení, připojení, vytvoření, zápisu nebo použijte spravovanou identitu k poskytnutí přístupu virtuálního počítače k objektu blob. Projděte si parametr outputBlobManagedIdentity. řetězec
parameters 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. řetězec
spustit jakouživatel Určuje uživatelský účet na virtuálním počítači při spuštění příkazu. řetězec
source Zdroj skriptu příkazu spustit. VirtualMachineRunCommandScriptSource
timeoutInSeconds Časový limit v sekundách pro spuštění příkazu. int
treatFailureAsDeploymentFailure Nepovinný parametr. Pokud je nastavená hodnota true, selhání skriptu selže při nasazení a stav provisioningstate se označí jako neúspěšný. Pokud je nastavená hodnota false, ProvisioningState by odrážela pouze to, jestli byl příkaz spuštění spuštěn platformou rozšíření, nebo ne. V případě selhání skriptu by se nezoznačovalo, jestli skript selhal. Projděte si zobrazení instance příkazu spuštění v případě selhání skriptu a podívejte se na executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

Název Description Hodnota
clientId ID klienta (hodnota GUID) spravované identity přiřazené uživatelem. ObjectId by se nemělo používat, pokud je k dispozici. řetězec
objectId ID objektu (hodnota GUID) spravované identity přiřazené uživatelem. ClientId by se nemělo používat, pokud je toto zadané. řetězec

RunCommandInputParameter

Název Description Hodnota
name Název parametru příkazu spustit. string (povinné)
hodnota Hodnota parametru příkazu spustit. string (povinné)

VirtualMachineRunCommandScriptSource

Název Description Hodnota
Commandid Určuje commandId předdefinovaného předdefinovaného skriptu. řetězec
script Určuje obsah skriptu, který se má na virtuálním počítači spustit. řetězec
identifikátor scriptUri Určuje umístění pro stažení skriptu. Může to být buď identifikátor URI SAS objektu blob úložiště Azure s přístupem pro čtení, nebo veřejný identifikátor URI. řetězec
scriptUriManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k 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 že spravovaná identita má udělený přístup ke kontejneru objektu blob s přiřazením role Čtenář dat v objektech blob služby Storage. V případě identity přiřazené uživatelem nezapomeňte ji přidat pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit příkaz 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í na:

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í kód JSON.

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/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"
  }
}

Hodnoty vlastností

virtualMachineScaleSets/virtualMachines/runCommands

Název Description Hodnota
typ Typ prostředku Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands
apiVersion Verze rozhraní API prostředku '2023-09-01'
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.		 string (povinné)
location Umístění prostředku string (povinné)
tags Značky prostředků Slovník názvů a hodnot značek. Zobrazit značky v šablonách
properties Popisuje vlastnosti příkazu spuštění virtuálního počítače. VirtualMachineRunCommandProperties

VirtualMachineRunCommandProperties

Název Description Hodnota
asyncExecution Nepovinný parametr. Pokud je nastavená hodnota true, zřizování se dokončí hned po spuštění skriptu a nebude čekat na dokončení skriptu. bool
chybaBlobManagedIdentity 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 má spravovaná identita udělený přístup ke kontejneru objektu blob s přiřazením role Přispěvatel dat v objektech blob služby Storage. V případě identity přiřazené uživatelem nezapomeňte ji přidat pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit příkaz najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
chybaBlobUri Určuje objekt blob úložiště Azure, do kterého se nahraje stream chyb skriptu. Použijte identifikátor URI SAS s přístupem ke čtení, připojení, vytvoření, zápisu nebo použijte spravovanou identitu k poskytnutí přístupu virtuálního počítače k objektu blob. Projděte si parametr errorBlobManagedIdentity. řetězec
outputBlobManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k objektu blob úložiště outputBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že má spravovaná identita udělený přístup ke kontejneru objektu blob s přiřazením role Přispěvatel dat v objektech blob služby Storage. V případě identity přiřazené uživatelem nezapomeňte ji přidat pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit příkaz najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Určuje objekt blob úložiště Azure, do kterého se nahraje výstupní stream skriptu. Použijte identifikátor URI SAS s přístupem ke čtení, připojení, vytvoření, zápisu nebo použijte spravovanou identitu k poskytnutí přístupu virtuálního počítače k objektu blob. Projděte si parametr outputBlobManagedIdentity. řetězec
parameters 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. řetězec
spustit jakouživatel Určuje uživatelský účet na virtuálním počítači při spuštění příkazu. řetězec
source Zdroj skriptu příkazu spustit. VirtualMachineRunCommandScriptSource
timeoutInSeconds Časový limit v sekundách pro spuštění příkazu. int
treatFailureAsDeploymentFailure Nepovinný parametr. Pokud je nastavená hodnota true, selhání skriptu selže při nasazení a stav provisioningstate se označí jako neúspěšný. Pokud je nastavená hodnota false, ProvisioningState by odrážela pouze to, jestli byl příkaz spuštění spuštěn platformou rozšíření, nebo ne. V případě selhání skriptu by se nezoznačovalo, jestli skript selhal. Projděte si zobrazení instance příkazu spuštění v případě selhání skriptu a podívejte se na executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

Název Description Hodnota
clientId ID klienta (hodnota GUID) spravované identity přiřazené uživatelem. ObjectId by se nemělo používat, pokud je k dispozici. řetězec
objectId ID objektu (hodnota GUID) spravované identity přiřazené uživatelem. ClientId by se nemělo používat, pokud je toto zadané. řetězec

RunCommandInputParameter

Název Description Hodnota
name Název parametru příkazu spustit. string (povinné)
hodnota Hodnota parametru příkazu spustit. string (povinné)

VirtualMachineRunCommandScriptSource

Název Description Hodnota
Commandid Určuje commandId předdefinovaného předdefinovaného skriptu. řetězec
script Určuje obsah skriptu, který se má na virtuálním počítači spustit. řetězec
identifikátor scriptUri Určuje umístění pro stažení skriptu. Může to být buď identifikátor URI SAS objektu blob úložiště Azure s přístupem pro čtení, nebo veřejný identifikátor URI. řetězec
scriptUriManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k 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 že spravovaná identita má udělený přístup ke kontejneru objektu blob s přiřazením role Čtenář dat v objektech blob služby Storage. V případě identity přiřazené uživatelem nezapomeňte ji přidat pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit příkaz najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged. RunCommandManagedIdentity

Definice prostředku Terraform (poskytovatel AzAPI)

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

  • 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"
  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
    }
  })
}

Hodnoty vlastností

virtualMachineScaleSets/virtualMachines/runCommands

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

VirtualMachineRunCommandProperties

Název Description Hodnota
asyncExecution Nepovinný parametr. Pokud je nastavená hodnota true, zřizování se dokončí hned po spuštění skriptu a nebude čekat na dokončení skriptu. bool
chybaBlobManagedIdentity 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 má spravovaná identita udělený přístup ke kontejneru objektu blob s přiřazením role Přispěvatel dat v objektech blob služby Storage. V případě identity přiřazené uživatelem nezapomeňte ji přidat pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit příkaz najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
chybaBlobUri Určuje objekt blob úložiště Azure, do kterého se nahraje stream chyb skriptu. Použijte identifikátor URI SAS s přístupem ke čtení, připojení, vytvoření, zápisu nebo použijte spravovanou identitu k poskytnutí přístupu virtuálního počítače k objektu blob. Projděte si parametr errorBlobManagedIdentity. řetězec
outputBlobManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k objektu blob úložiště outputBlobUri. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že má spravovaná identita udělený přístup ke kontejneru objektu blob s přiřazením role Přispěvatel dat v objektech blob služby Storage. V případě identity přiřazené uživatelem nezapomeňte ji přidat pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit příkaz najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged RunCommandManagedIdentity
outputBlobUri Určuje objekt blob úložiště Azure, do kterého se nahraje výstupní stream skriptu. Použijte identifikátor URI SAS s přístupem ke čtení, připojení, vytvoření, zápisu nebo použijte spravovanou identitu k poskytnutí přístupu virtuálního počítače k objektu blob. Projděte si parametr outputBlobManagedIdentity. řetězec
parameters 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. řetězec
spustit jakouživatel Určuje uživatelský účet na virtuálním počítači při spuštění příkazu. řetězec
source Zdroj skriptu příkazu spustit. VirtualMachineRunCommandScriptSource
timeoutInSeconds Časový limit v sekundách pro spuštění příkazu. int
treatFailureAsDeploymentFailure Nepovinný parametr. Pokud je nastavená hodnota true, selhání skriptu selže při nasazení a stav provisioningstate se označí jako neúspěšný. Pokud je nastavená hodnota false, ProvisioningState by odrážela pouze to, jestli byl příkaz spuštění spuštěn platformou rozšíření, nebo ne. V případě selhání skriptu by se nezoznačovalo, jestli skript selhal. Projděte si zobrazení instance příkazu spuštění v případě selhání skriptu a podívejte se na executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results bool

RunCommandManagedIdentity

Název Description Hodnota
clientId ID klienta (hodnota GUID) spravované identity přiřazené uživatelem. ObjectId by se nemělo používat, pokud je k dispozici. řetězec
objectId ID objektu (hodnota GUID) spravované identity přiřazené uživatelem. ClientId by se nemělo používat, pokud je toto zadané. řetězec

RunCommandInputParameter

Název Description Hodnota
name Název parametru příkazu spustit. string (povinné)
hodnota Hodnota parametru příkazu spustit. string (povinné)

VirtualMachineRunCommandScriptSource

Název Description Hodnota
Commandid Určuje commandId předdefinovaného předdefinovaného skriptu. řetězec
script Určuje obsah skriptu, který se má na virtuálním počítači spustit. řetězec
identifikátor scriptUri Určuje umístění pro stažení skriptu. Může to být buď identifikátor URI SAS objektu blob úložiště Azure s přístupem pro čtení, nebo veřejný identifikátor URI. řetězec
scriptUriManagedIdentity Spravovaná identita přiřazená uživatelem, která má přístup k 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 že spravovaná identita má udělený přístup ke kontejneru objektu blob s přiřazením role Čtenář dat v objektech blob služby Storage. V případě identity přiřazené uživatelem nezapomeňte ji přidat pod identitu virtuálního počítače. Další informace o spravované identitě a příkazu Spustit příkaz najdete v tématu https://aka.ms/ManagedIdentity a https://aka.ms/RunCommandManaged. RunCommandManagedIdentity