Set-AzVMRunCommand

Operacja tworzenia lub aktualizowania polecenia uruchamiania.

Składnia

Set-AzVMRunCommand
   -ResourceGroupName <String>
   -RunCommandName <String>
   -VMName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-AsyncExecution]
   [-ErrorBlobManagedIdentityClientId <String>]
   [-ErrorBlobManagedIdentityObjectId <String>]
   [-ErrorBlobUri <String>]
   [-OutputBlobManagedIdentityClientId <String>]
   [-OutputBlobManagedIdentityObjectId <String>]
   [-OutputBlobUri <String>]
   [-Parameter <IRunCommandInputParameter[]>]
   [-ProtectedParameter <IRunCommandInputParameter[]>]
   [-RunAsPassword <String>]
   [-RunAsUser <String>]
   [-ScriptUriManagedIdentityClientId <String>]
   [-ScriptUriManagedIdentityObjectId <String>]
   [-SourceCommandId <String>]
   [-SourceScript <String>]
   [-SourceScriptUri <String>]
   [-Tag <Hashtable>]
   [-TimeoutInSecond <Int32>]
   [-TreatFailureAsDeploymentFailure]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMRunCommand
   -ResourceGroupName <String>
   -RunCommandName <String>
   -VMName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-AsyncExecution]
   [-ErrorBlobManagedIdentityClientId <String>]
   [-ErrorBlobManagedIdentityObjectId <String>]
   [-ErrorBlobUri <String>]
   [-OutputBlobManagedIdentityClientId <String>]
   [-OutputBlobManagedIdentityObjectId <String>]
   [-OutputBlobUri <String>]
   [-Parameter <IRunCommandInputParameter[]>]
   [-ProtectedParameter <IRunCommandInputParameter[]>]
   [-RunAsPassword <String>]
   [-RunAsUser <String>]
   [-ScriptUriManagedIdentityClientId <String>]
   [-ScriptUriManagedIdentityObjectId <String>]
   [-Tag <Hashtable>]
   [-TimeoutInSecond <Int32>]
   [-TreatFailureAsDeploymentFailure]
   -ScriptLocalPath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Opis

Operacja tworzenia lub aktualizowania polecenia uruchamiania.

Przykłady

Przykład 1. Tworzenie lub aktualizowanie polecenia uruchamiania na maszynie wirtualnej przy użyciu adresu URL sygnatury dostępu współdzielonego obiektu blob magazynu

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri "https://myst.blob.core.windows.net/mycontainer/myscript.ps1?sp=r&st=2022-10-27T21:02:35Z&se=2022-10-28T05:02:35Z&spr=https&sv=2021-06-08&sr=b&sig=0I%2FIiYayRwHasfasasfdasdfasdeTsQjLnpZjA%3D"

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Utwórz lub zaktualizuj polecenie Uruchom na maszynie wirtualnej z systemem Windows przy użyciu adresu URL sygnatury dostępu współdzielonego obiektu blob magazynu zawierającego skrypt ps1. Uwaga Adres URL sygnatury dostępu współdzielonego musi zapewnić dostęp do odczytu do obiektu blob. Sugerowany jest czas wygaśnięcia 24 godzin dla adresu URL sygnatury dostępu współdzielonego. Adresy URL sygnatur dostępu współdzielonego można wygenerować w witrynie Azure Portal przy użyciu opcji obiektu blob lub tokenu SAS przy użyciu polecenia New-AzStorageBlobSASToken. W przypadku generowania tokenu SAS przy użyciu polecenia New-AzStorageBlobSASToken adres URL sygnatury dostępu współdzielonego = podstawowy adres URL obiektu blob + "?" + token SAS z polecenia New-AzStorageBlobSASToken.

Przykład 2. Tworzenie lub aktualizowanie polecenia uruchamiania na maszynie wirtualnej przy użyciu lokalnego pliku skryptu.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1"

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Utwórz lub zaktualizuj polecenie Uruchom na maszynie wirtualnej przy użyciu lokalnego pliku skryptu, który znajduje się na maszynie klienckiej, na której jest wykonywane polecenie cmdlet.

Przykład 3. Tworzenie lub aktualizowanie polecenia uruchamiania na maszynie wirtualnej przy użyciu tekstu skryptu.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand2 -Location EastUS2EUAP -SourceScript "id; echo HelloWorld"

Location      Name          Type
--------      ----          ----
eastus2euap   MyRunCommand2 Microsoft.Compute/virtualMachines/runCommands

Utwórz lub zaktualizuj polecenie Uruchom na maszynie wirtualnej przekazując zawartość skryptu bezpośrednio do parametru -SourceScript. Użyj znaku ";", aby rozdzielić wiele poleceń.

Przykład 4. Tworzenie lub aktualizowanie polecenia uruchamiania na maszynie wirtualnej przy użyciu identyfikatora commandId.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceCommandId DisableWindowsUpdate

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Utwórz lub zaktualizuj polecenie Uruchom na maszynie wirtualnej przy użyciu wstępnie istniejącego identyfikatora commandId. Dostępne identyfikatory poleceń można pobrać przy użyciu polecenia Get-AzVMRunCommandDocument.

Przykład 5. Tworzenie lub aktualizowanie polecenia uruchamiania na maszynie wirtualnej i przesyłanie strumieniowe standardowych danych wyjściowych i standardowych komunikatów o błędach do danych wyjściowych i błędów Uzupełnialne obiekty blob.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand3 -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -OutputBlobUri "https://vivst.blob.core.windows.net/vivcontainer/output.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=HQAu3Bl%2BKMofYTjMo8o5hasfadsfasdF4jIkRJra4S5FlEo%3D" -ErrorBlobUri "https://vivst.blob.core.windows.net/vivcontainer/error.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=HQAu3Bl%2BKMofYTjMo8o5h%asfasdfgdT%2F4jasfasdf5FlEo%3D"

Location      Name          Type
--------      ----         ----
eastus2euap   MyRunCommand3 Microsoft.Compute/virtualMachines/runCommands

Utwórz lub zaktualizuj polecenie uruchom na maszynie wirtualnej i przesyłaj strumieniowo standardowe komunikaty o błędach i komunikaty o błędach do danych wyjściowych i uzupełnialnych obiektów blob. Zwróć uwagę, że dane wyjściowe i błędy obiektów blob muszą być typu AppendBlob, a ich adresy URL sygnatur dostępu współdzielonego muszą zapewniać dostęp do odczytu, dołączania, tworzenia, zapisu do obiektu blob. Sugerowany jest czas wygaśnięcia 24 godzin dla adresu URL sygnatury dostępu współdzielonego. Jeśli obiekt blob danych wyjściowych lub błąd nie istnieje, zostanie utworzony obiekt blob typu AppendBlob. Adresy URL sygnatur dostępu współdzielonego można wygenerować w witrynie Azure Portal przy użyciu opcji obiektu blob lub tokenu SAS przy użyciu polecenia New-AzStorageBlobSASToken. W przypadku generowania tokenu SAS przy użyciu polecenia New-AzStorageBlobSASToken adres URL sygnatury dostępu współdzielonego = podstawowy adres URL obiektu blob + "?" + token SAS z polecenia New-AzStorageBlobSASToken.

Przykład 6. Tworzenie lub aktualizowanie polecenia uruchamiania na maszynie wirtualnej, uruchamianie polecenia Uruchom jako inny użytkownik przy użyciu parametrów RunAsUser i RunAsPassword.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -RunAsUser myusername -RunAsPassword mypassword

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Utwórz lub zaktualizuj polecenie Uruchom na maszynie wirtualnej, uruchom polecenie Uruchom jako inny użytkownik przy użyciu parametrów RunAsUser i RunAsPassword. Aby działało prawidłowo, skontaktuj się z administratorem maszyny wirtualnej i upewnij się, że użytkownik został dodany na maszynie wirtualnej, użytkownik ma dostęp do zasobów, do których uzyskuje dostęp za pomocą polecenia uruchom (katalogi, pliki, sieć itp.), a w przypadku maszyny wirtualnej z systemem Windows usługa "Logowanie pomocnicze" jest uruchomiona na maszynie wirtualnej.

Parametry

-AsJob

Uruchamianie polecenia jako zadania

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsyncExecution

Opcjonalny. Jeśli ustawiono wartość true, aprowizacja zostanie ukończona natychmiast po uruchomieniu skryptu i nie będzie czekać na ukończenie skryptu.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Parametr DefaultProfile nie działa. Użyj parametru SubscriptionId, jeśli jest dostępny, jeśli wykonuje polecenie cmdlet dla innej subskrypcji.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorBlobManagedIdentityClientId

Identyfikator klienta (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Nie należy używać identyfikatora ObjectId, jeśli jest to podane.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorBlobManagedIdentityObjectId

Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. W przypadku podania tego identyfikatora nie należy używać identyfikatora ClientId.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

Lokalizacja zasobu

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Uruchom polecenie asynchronicznie

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputBlobManagedIdentityClientId

Identyfikator klienta (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Nie należy używać identyfikatora ObjectId, jeśli jest to podane.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputBlobManagedIdentityObjectId

Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. W przypadku podania tego identyfikatora nie należy używać identyfikatora ClientId.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Parameter

Parametry używane przez skrypt. Aby skonstruować, zobacz sekcję UWAGI dla właściwości PARAMETRów i utwórz tabelę skrótów.

Type:IRunCommandInputParameter[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProtectedParameter

Parametry używane przez skrypt. Aby utworzyć, zobacz sekcję UWAGI dla właściwości PROTECTEDPARAMETER i utwórz tabelę skrótów.

Type:IRunCommandInputParameter[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Nazwa grupy zasobów.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RunAsPassword

Określa hasło konta użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsUser

Określa konto użytkownika na maszynie wirtualnej podczas wykonywania polecenia uruchamiania.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunCommandName

Nazwa polecenia uruchomienia maszyny wirtualnej.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ScriptLocalPath

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ScriptUriManagedIdentityClientId

Identyfikator klienta (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. Nie należy używać identyfikatora ObjectId, jeśli jest to podane.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScriptUriManagedIdentityObjectId

Identyfikator obiektu (wartość GUID) tożsamości zarządzanej przypisanej przez użytkownika. W przypadku podania tego identyfikatora nie należy używać identyfikatora ClientId.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceCommandId

Określa identyfikator polecenia wstępnie zdefiniowanego wbudowanego skryptu.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceScript

Określa zawartość skryptu do wykonania na maszynie wirtualnej.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceScriptUri

Określa lokalizację pobierania skryptu. Może to być identyfikator URI sygnatury dostępu współdzielonego obiektu blob usługi Azure Storage z dostępem do odczytu lub publicznym identyfikatorem URI.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Tagi zasobów

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TimeoutInSecond

Limit czasu w sekundach do wykonania polecenia uruchomienia.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TreatFailureAsDeploymentFailure

Opcjonalny. 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 niepowodzeń skryptu, aby wyświetlić komunikat executionMessage, dane wyjściowe, błąd: https://aka.ms/runcommandmanaged#get-execution-status-and-results

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMName

Nazwa maszyny wirtualnej, na której należy utworzyć lub zaktualizować polecenie uruchamiania.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Dane wyjściowe

IVirtualMachineRunCommand