VirtualMachineRunCommand Třída
Popisuje příkaz spuštění virtuálního počítače.
Proměnné jsou naplněny pouze serverem a při odesílání požadavku budou ignorovány.
Aby bylo možné odesílat do Azure, musí být vyplněny všechny požadované parametry.
- Dědičnost
-
azure.mgmt.compute.v2023_03_01.models._models_py3.ResourceVirtualMachineRunCommand
Konstruktor
VirtualMachineRunCommand(*, location: str, tags: Dict[str, str] | None = None, source: _models.VirtualMachineRunCommandScriptSource | None = None, parameters: List[_models.RunCommandInputParameter] | None = None, protected_parameters: List[_models.RunCommandInputParameter] | None = None, async_execution: bool = False, run_as_user: str | None = None, run_as_password: str | None = None, timeout_in_seconds: int | None = None, output_blob_uri: str | None = None, error_blob_uri: str | None = None, output_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, error_blob_managed_identity: _models.RunCommandManagedIdentity | None = None, treat_failure_as_deployment_failure: bool = False, **kwargs: Any)
Keyword-Only Parameters
- location
- str
Umístění prostředku. Povinná hodnota.
Zdroj skriptu příkazu spuštění.
- parameters
- list[RunCommandInputParameter]
Parametry používané skriptem.
- protected_parameters
- list[RunCommandInputParameter]
Parametry používané skriptem.
- async_execution
- bool
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.
- run_as_user
- str
Určuje uživatelský účet na virtuálním počítači při provádění příkazu spustit.
- run_as_password
- str
Určuje heslo uživatelského účtu na virtuálním počítači při spuštění příkazu.
- timeout_in_seconds
- int
Časový limit v sekundách pro spuštění příkazu.
- output_blob_uri
- str
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.
- error_blob_uri
- str
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.
- output_blob_managed_identity
- RunCommandManagedIdentity
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.
- error_blob_managed_identity
- RunCommandManagedIdentity
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.
- treat_failure_as_deployment_failure
- bool
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. Viz 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.
Proměnné
- id
- str
ID prostředku.
- name
- str
Název prostředku.
- type
- str
Typ prostředku.
- location
- str
Umístění prostředku. Povinná hodnota.
Zdroj skriptu příkazu spuštění.
- parameters
- list[RunCommandInputParameter]
Parametry používané skriptem.
- protected_parameters
- list[RunCommandInputParameter]
Parametry používané skriptem.
- async_execution
- bool
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.
- run_as_user
- str
Určuje uživatelský účet na virtuálním počítači při provádění příkazu spustit.
- run_as_password
- str
Určuje heslo uživatelského účtu na virtuálním počítači při spuštění příkazu.
- timeout_in_seconds
- int
Časový limit v sekundách pro spuštění příkazu.
- output_blob_uri
- str
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.
- error_blob_uri
- str
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.
- output_blob_managed_identity
- RunCommandManagedIdentity
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.
- error_blob_managed_identity
- RunCommandManagedIdentity
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.
- provisioning_state
- str
Stav zřizování, který se zobrazí pouze v odpovědi. Pokud je treatFailureAsDeploymentFailure nastavená na hodnotu true, selhání skriptu selže při nasazení a ProvisioningState se označí jako neúspěšné. Pokud je treatFailureAsDeploymentFailure nastavená na hodnotu false, ProvisioningState by odrážel pouze to, jestli byl příkaz spuštění spuštěný platformou rozšíření, nebo ne. V případě selhání skriptu by to neuznačovalo, jestli skript selhal. Viz 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.
- instance_view
- VirtualMachineRunCommandInstanceView
Virtuální počítač spustí zobrazení instance příkazu.
- treat_failure_as_deployment_failure
- bool
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. Viz 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.
Azure SDK for Python