VirtualMachineRunCommand Klasa
Opisuje polecenie uruchamiania maszyny wirtualnej.
Zmienne są wypełniane tylko przez serwer i będą ignorowane podczas wysyłania żądania.
Aby wysyłać na platformę Azure wszystkie wymagane parametry, należy wypełnić wszystkie wymagane parametry.
- Dziedziczenie
-
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
Lokalizacja zasobu. Wymagane.
Źródło skryptu polecenia run.
- parameters
- list[RunCommandInputParameter]
Parametry używane przez skrypt.
- protected_parameters
- list[RunCommandInputParameter]
Parametry używane przez skrypt.
- async_execution
- bool
Opcjonalny. Jeśli ustawiono wartość true, aprowizacja zostanie zakończona zaraz po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu.
- run_as_user
- str
Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia run.
- run_as_password
- str
Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia run.
- timeout_in_seconds
- int
Limit czasu w sekundach do wykonania polecenia uruchomienia.
- output_blob_uri
- str
Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem outputBlobManagedIdentity.
- error_blob_uri
- str
Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień błędów skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity.
- output_blob_managed_identity
- RunCommandManagedIdentity
Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob magazynu outputBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamość maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged.
- error_blob_managed_identity
- RunCommandManagedIdentity
Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob storage errorBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamość maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged.
- treat_failure_as_deployment_failure
- bool
Opcjonalny. Jeśli ustawiono wartość true, wszystkie błędy w skry skrycie nie powiedzą się, a parametr ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli ustawiono wartość false, provisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie oznaczałoby to, czy skrypt zakończył się niepowodzeniem w przypadku awarii skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku niepowodzeń skryptu, aby wyświetlić komunikat executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.
Zmienne
- id
- str
Identyfikator zasobu.
- name
- str
Nazwa zasobu.
- type
- str
Typ zasobu.
- location
- str
Lokalizacja zasobu. Wymagane.
Źródło skryptu polecenia run.
- parameters
- list[RunCommandInputParameter]
Parametry używane przez skrypt.
- protected_parameters
- list[RunCommandInputParameter]
Parametry używane przez skrypt.
- async_execution
- bool
Opcjonalny. Jeśli ustawiono wartość true, aprowizacja zostanie zakończona zaraz po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu.
- run_as_user
- str
Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia run.
- run_as_password
- str
Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia run.
- timeout_in_seconds
- int
Limit czasu w sekundach do wykonania polecenia uruchomienia.
- output_blob_uri
- str
Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień wyjściowy skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem outputBlobManagedIdentity.
- error_blob_uri
- str
Określa obiekt blob usługi Azure Storage, w którym zostanie przekazany strumień błędów skryptu. Użyj identyfikatora URI sygnatury dostępu współdzielonego z identyfikatorem odczytu, dołączania, tworzenia, zapisu lub używania tożsamości zarządzanej w celu zapewnienia dostępu maszyny wirtualnej do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity.
- output_blob_managed_identity
- RunCommandManagedIdentity
Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob magazynu outputBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamość maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged.
- error_blob_managed_identity
- RunCommandManagedIdentity
Tożsamość zarządzana przypisana przez użytkownika, która ma dostęp do obiektu blob storage errorBlobUri. Użyj pustego obiektu w przypadku tożsamości przypisanej przez system. Upewnij się, że tożsamość zarządzana ma dostęp do kontenera obiektu blob z przypisaniem roli "Współautor danych obiektu blob usługi Storage". W przypadku tożsamości przypisanej przez użytkownika upewnij się, że została dodana w obszarze tożsamość maszyny wirtualnej. Aby uzyskać więcej informacji na temat tożsamości zarządzanej i uruchamiania polecenia, zobacz https://aka.ms/ManagedIdentity i https://aka.ms/RunCommandManaged.
- provisioning_state
- str
Stan aprowizacji, który pojawia się tylko w odpowiedzi. Jeśli parametr treatFailureAsDeploymentFailure ma wartość true, wszystkie błędy w skrypcie nie powiedzą się, a stan ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli właściwość treatFailureAsDeploymentFailure ma wartość false, provisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie oznaczałoby to, czy skrypt zakończył się niepowodzeniem w przypadku awarii skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku niepowodzeń skryptu, aby wyświetlić komunikat executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.
- instance_view
- VirtualMachineRunCommandInstanceView
Widok wystąpienia polecenia uruchamiania maszyny wirtualnej.
- treat_failure_as_deployment_failure
- bool
Opcjonalny. Jeśli ustawiono wartość true, wszystkie błędy w skry skrycie nie powiedzą się, a parametr ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli ustawiono wartość false, provisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie oznaczałoby to, czy skrypt zakończył się niepowodzeniem w przypadku awarii skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku niepowodzeń skryptu, aby wyświetlić komunikat executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results.
Azure SDK for Python