Microsoft.Compute virtualMachines/runCommands 2023-03-01

• Latest (Nejnovější)
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01

Definice prostředku Bicep

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

• Skupiny prostředků – viz příkazy nasazení 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/virtualMachines/runCommands, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.Compute/virtualMachines/runCommands@2023-03-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í

virtualMachines/runCommands

Název	Description	Hodnota
name	Název prostředku Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu.	string (povinné)
location	Umístění prostředku	string (povinné)
tags	Značky prostředků	Slovník názvů značek a hodnot. Viz Značky v šablonách
Nadřazené	V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. 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
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é identitě byl 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
errorBlobUri	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žití spravované identity k poskytnutí přístupu virtuálního počítače k objektu blob. Viz 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 spravované identitě byl 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žití spravované identity 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
runAsUser	Určuje uživatelský účet na virtuálním počítači při provádění příkazu spustit.	řetězec
source	Zdroj skriptu příkazu spuštění.	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 ProvisioningState se označí jako neúspěšné. Pokud je nastavená hodnota false, ProvisioningState by odrážel pouze to, jestli byl příkaz spuštění spuštěn platformou rozšíření, nebo ne, což by neoznačovalo, jestli skript selhal v případě selhání skriptu. 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

Šablony pro rychlý start

Následující šablony pro rychlý start nasadí tento typ prostředku.

Template (Šablona)

Description

Nakonfigurované předplatné SharePointu / 2019 / 2016 / 2013

Tato šablona vytvoří farmu s předplatným SharePointu 2019, 2016 a 2013 s rozsáhlou konfigurací, která může trvat věky, než se provede ručně, včetně federovaného ověřování pomocí ADFS, vztahu důvěryhodnosti OAuth, služby profilů uživatelů a webové aplikace se 2 zónami, které obsahují více kolekcí webů založených na cestách a pojmenovaných hostiteli. Na virtuálních počítačích SharePointu se Chocolatey používá k instalaci nejnovější verze aplikací Notepad++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer a 7-Zip.

Definice prostředku šablony ARM

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

• Skupiny prostředků – viz příkazy pro nasazení skupin 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/virtualMachines/runCommands, přidejte do šablony následující kód JSON.

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

virtualMachines/runCommands

Název	Description	Hodnota
typ	Typ prostředku	Microsoft.Compute/virtualMachines/runCommands
apiVersion	Verze rozhraní API prostředku	'2023-03-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žití spravované identity k poskytnutí přístupu virtuálního počítače k objektu blob. Viz 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 spravované identitě byl 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žití spravované identity 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
runAsUser	Určuje uživatelský účet na virtuálním počítači při provádění příkazu spustit.	řetězec
source	Zdroj skriptu příkazu spuštění.	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 ProvisioningState se označí jako neúspěšné. Pokud je nastavená hodnota false, ProvisioningState by odrážel pouze to, jestli byl příkaz spuštění spuštěn platformou rozšíření, nebo ne, což by neoznačovalo, jestli skript selhal v případě selhání skriptu. Podívejte se na zobrazení instance příkazu spuštění v případě selhání skriptu a podívejte se na executionMessage, output a 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 nemělo být použito, pokud je k dispozici.	řetězec
objectId	ID objektu (hodnota GUID) spravované identity přiřazené uživatelem. Pokud je toto id klienta zadané, nemělo by se použít.	řetězec

SpustitCommandInputParameter

Název	Description	Hodnota
name	Název parametru příkazu spuštění	string (povinné)
hodnota	Hodnota parametru příkazu spuštění	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
scriptUri	Určuje umístění pro stažení skriptu. Může to být identifikátor URI SAS objektu blob úložiště Azure s přístupem ke č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 služby Azure Storage. V případě identity přiřazené systémem použijte prázdný objekt. Ujistěte se, že existuje objekt blob služby Azure Storage a že má spravovaná identita 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

Šablony pro rychlý start

Následující šablony rychlého startu nasadí tento typ prostředku.

Template (Šablona)

Description

Nakonfigurované předplatné SharePointu / 2019 / 2016 / 2013

Tato šablona vytvoří farmu předplatného SharePointu / 2019 / 2016 / 2013 s rozsáhlou konfigurací, která by trvalo věky, než se provede ručně, včetně federovaného ověřování pomocí ADFS, vztahu důvěryhodnosti OAuth, služby Profilů uživatelů a webové aplikace se 2 zónami, která obsahuje více kolekcí webů založených na cestě a pojmenovaných hostiteli. Na virtuálních počítačích SharePointu se Chocolatey používá k instalaci nejnovější verze aplikací Notepad++, Visual Studio Code, Azure Data Studio, Fiddler, ULS Viewer a 7-Zip.

Definice prostředku Terraformu (zprostředkovatele AzAPI)

Typ prostředku 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/virtualMachines/runCommands, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachines/runCommands@2023-03-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í

virtualMachines/runCommands

Název	Description	Hodnota
typ	Typ prostředku	Microsoft.Compute/virtualMachines/runCommands@2023-03-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ů značek a hodnot.
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
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é identitě byl 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
errorBlobUri	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žití spravované identity k poskytnutí přístupu virtuálního počítače k objektu blob. Viz 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 spravované identitě byl 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žití spravované identity 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
runAsUser	Určuje uživatelský účet na virtuálním počítači při provádění příkazu spustit.	řetězec
source	Zdroj skriptu příkazu spuštění.	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 ProvisioningState se označí jako neúspěšné. Pokud je nastavená hodnota false, ProvisioningState by odrážel pouze to, jestli byl příkaz spuštění spuštěn platformou rozšíření, nebo ne, což by neoznačovalo, jestli skript selhal v případě selhání skriptu. Podívejte se na zobrazení instance příkazu spuštění v případě selhání skriptu a podívejte se na executionMessage, output a 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 nemělo být použito, pokud je k dispozici.	řetězec
objectId	ID objektu (hodnota GUID) spravované identity přiřazené uživatelem. Pokud je toto id klienta zadané, nemělo by se použít.	řetězec

SpustitCommandInputParameter

Název	Description	Hodnota
name	Název parametru příkazu spuštění	string (povinné)
hodnota	Hodnota parametru příkazu spuštění	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