VirtualMachineRunCommand interface

Pakiet:

@azure/arm-compute

Opisuje polecenie uruchamiania maszyny wirtualnej.

Rozszerzenie

TrackedResource

Właściwości

asyncExecution	Fakultatywny. Jeśli ustawiono wartość true, aprowizacja zostanie ukończona natychmiast po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu.
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ści 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
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, aby zapewnić maszynie wirtualnej dostęp do obiektu blob. Zapoznaj się z parametrem errorBlobManagedIdentity.
instanceView	Widok wystąpienia polecenia uruchamiania maszyny wirtualnej. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
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ści 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
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, aby zapewnić maszynie wirtualnej dostęp do obiektu blob. Zapoznaj się z parametrem outputBlobManagedIdentity.
parameters	Parametry używane przez skrypt.
protectedParameters	Parametry używane przez skrypt.
provisioningState	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 właściwość ProvisioningState zostanie oznaczona jako Niepowodzenie. Jeśli parametr treatFailureAsDeploymentFailure ma wartość false, wartość ProvisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, 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ć komunikat executionMessage, dane wyjściowe, błąd: https://aka.ms/runcommandmanaged#get-execution-status-and-results UWAGA: ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
runAsPassword	Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania.
runAsUser	Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania.
source	Źródło skryptu polecenia uruchamiania.
timeoutInSeconds	Limit czasu w sekundach do wykonania polecenia uruchomienia.
treatFailureAsDeploymentFailure	Fakultatywny. Jeśli ustawiono wartość true, wszystkie błędy w skry skrycie nie powiedzą się, a stan ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli ustawiono wartość false, wartość ProvisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, czy skrypt zakończył się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku błędów skryptu, aby wyświetlić executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results

Właściwości dziedziczone

id	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
location	Lokalizacja geograficzna, w której znajduje się zasób
name	Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
tags	Tagi zasobów.
type	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Szczegóły właściwości

asyncExecution

Fakultatywny. Jeśli ustawiono wartość true, aprowizacja zostanie ukończona natychmiast 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ści 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

RunCommandManagedIdentity

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, aby zapewnić maszynie wirtualnej dostęp 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

VirtualMachineRunCommandInstanceView

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ści 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

RunCommandManagedIdentity

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, aby zapewnić maszynie wirtualnej dostęp 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

RunCommandInputParameter[]

protectedParameters

Parametry używane przez skrypt.

protectedParameters?: RunCommandInputParameter[]

Wartość właściwości

RunCommandInputParameter[]

provisioningState

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 właściwość ProvisioningState zostanie oznaczona jako Niepowodzenie. Jeśli parametr treatFailureAsDeploymentFailure ma wartość false, wartość ProvisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, 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ć komunikat executionMessage, dane wyjściowe, błąd: https://aka.ms/runcommandmanaged#get-execution-status-and-results UWAGA: 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

VirtualMachineRunCommandScriptSource

timeoutInSeconds

Limit czasu w sekundach do wykonania polecenia uruchomienia.

timeoutInSeconds?: number

Wartość właściwości

number

treatFailureAsDeploymentFailure

Fakultatywny. Jeśli ustawiono wartość true, wszystkie błędy w skry skrycie nie powiedzą się, a stan ProvisioningState zostanie oznaczony jako Niepowodzenie. Jeśli ustawiono wartość false, wartość ProvisioningState będzie odzwierciedlać tylko to, czy polecenie uruchomienia zostało uruchomione, czy nie przez platformę rozszerzeń, nie wskazuje, czy skrypt zakończył się niepowodzeniem w przypadku błędów skryptu. Zobacz widok wystąpienia polecenia uruchamiania w przypadku błędów 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

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 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 zTrackedResource.id

location

Lokalizacja geograficzna, w której znajduje się zasób

location: string

Wartość właściwości

string

dziedziczone zTrackedResource.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 zTrackedResource.name

systemData

Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

systemData?: SystemData

Wartość właściwości

SystemData

dziedziczone zTrackedResource.systemData

tags

Tagi zasobów.

tags?: {[propertyName: string]: string}

Wartość właściwości

{[propertyName: string]: string}

dziedziczone zTrackedResource.tags

type

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" 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 zTrackedResource.type