VirtualMachineRunCommand interface
Opisuje polecenie uruchamiania maszyny wirtualnej.
- Rozszerzenie
Właściwości
async |
Opcjonalny. W przypadku ustawienia wartości true aprowizacja zostanie ukończona zaraz po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu. |
error |
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 |
error |
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. |
instance |
Widok wystąpienia polecenia uruchamiania maszyny wirtualnej. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer. |
output |
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 |
output |
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. |
parameters | Parametry używane przez skrypt. |
protected |
Parametry używane przez skrypt. |
provisioning |
Stan aprowizacji, który pojawia się tylko w odpowiedzi. Jeśli parametr treatFailureAsDeploymentFailure ma wartość true, wszystkie błędy w skrypcie nie powiodą się, a właściwość ProvisioningState zostanie oznaczona jako Niepowodzenie. Jeśli parametr treatFailureAsDeploymentFailure ma wartość false, parametr ProvisioningState odzwierciedlałby tylko to, czy uruchomienie polecenia zostało uruchomione, czy nie przez platformę rozszerzeń, nie oznaczałoby to, czy skrypt zakończył się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku niepowodzeń skryptu, aby wyświetlić executionMessage, output, error: UWAGA: https://aka.ms/runcommandmanaged#get-execution-status-and-results Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer. |
run |
Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. |
run |
Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania. |
source | Źródło skryptu polecenia uruchamiania. |
timeout |
Limit czasu w sekundach do wykonania polecenia uruchamiania. |
treat |
Opcjonalny. W przypadku ustawienia wartości true wszystkie błędy w skry skrycie nie powiedzą się, a właściwość ProvisioningState zostanie oznaczona jako Niepowodzenie. Jeśli ustawiono wartość false, parametr ProvisioningState odzwierciedlałby tylko to, czy polecenie uruchamiania zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, czy skrypt zakończyłby się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku niepowodzeń skryptu, aby wyświetlić executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results |
Właściwości dziedziczone
id | Identyfikator zasobu UWAGA: ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer. |
location | Lokalizacja zasobu |
name | Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer. |
tags | Tagi zasobów |
type | Typ zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer. |
Szczegóły właściwości
asyncExecution
Opcjonalny. W przypadku ustawienia wartości true aprowizacja zostanie ukończona zaraz po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu.
asyncExecution?: boolean
Wartość właściwości
boolean
errorBlobManagedIdentity
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
errorBlobManagedIdentity?: RunCommandManagedIdentity
Wartość właściwości
errorBlobUri
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.
errorBlobUri?: string
Wartość właściwości
string
instanceView
Widok wystąpienia polecenia uruchamiania maszyny wirtualnej. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
instanceView?: VirtualMachineRunCommandInstanceView
Wartość właściwości
outputBlobManagedIdentity
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
outputBlobManagedIdentity?: RunCommandManagedIdentity
Wartość właściwości
outputBlobUri
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.
outputBlobUri?: string
Wartość właściwości
string
parameters
Parametry używane przez skrypt.
parameters?: RunCommandInputParameter[]
Wartość właściwości
protectedParameters
Parametry używane przez skrypt.
protectedParameters?: RunCommandInputParameter[]
Wartość właściwości
provisioningState
Stan aprowizacji, który pojawia się tylko w odpowiedzi. Jeśli parametr treatFailureAsDeploymentFailure ma wartość true, wszystkie błędy w skrypcie nie powiodą się, a właściwość ProvisioningState zostanie oznaczona jako Niepowodzenie. Jeśli parametr treatFailureAsDeploymentFailure ma wartość false, parametr ProvisioningState odzwierciedlałby tylko to, czy uruchomienie polecenia zostało uruchomione, czy nie przez platformę rozszerzeń, nie oznaczałoby to, czy skrypt zakończył się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku niepowodzeń skryptu, aby wyświetlić executionMessage, output, error: UWAGA: https://aka.ms/runcommandmanaged#get-execution-status-and-results Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
provisioningState?: string
Wartość właściwości
string
runAsPassword
Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania.
runAsPassword?: string
Wartość właściwości
string
runAsUser
Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania.
runAsUser?: string
Wartość właściwości
string
source
Źródło skryptu polecenia uruchamiania.
source?: VirtualMachineRunCommandScriptSource
Wartość właściwości
timeoutInSeconds
Limit czasu w sekundach do wykonania polecenia uruchamiania.
timeoutInSeconds?: number
Wartość właściwości
number
treatFailureAsDeploymentFailure
Opcjonalny. W przypadku ustawienia wartości true wszystkie błędy w skry skrycie nie powiedzą się, a właściwość ProvisioningState zostanie oznaczona jako Niepowodzenie. Jeśli ustawiono wartość false, parametr ProvisioningState odzwierciedlałby tylko to, czy polecenie uruchamiania zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, czy skrypt zakończyłby się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku niepowodzeń skryptu, aby wyświetlić executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results
treatFailureAsDeploymentFailure?: boolean
Wartość właściwości
boolean
Szczegóły właściwości dziedziczonej
id
Identyfikator zasobu UWAGA: ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
id?: string
Wartość właściwości
string
Dziedziczone zResource.id
location
name
Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
name?: string
Wartość właściwości
string
Dziedziczone zResource.name
tags
Tagi zasobów
tags?: {[propertyName: string]: string}
Wartość właściwości
{[propertyName: string]: string}
Dziedziczone zzasobu.tags
type
Typ zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
type?: string
Wartość właściwości
string
Dziedziczone zzasobu.type