Udostępnij za pośrednictwem

Stop-AzBatchJob

  • Odwołanie
Moduł:
Az.Batch

Zatrzymuje zadanie usługi Batch.

Składnia

Stop-AzBatchJob
    [-Id] <String>
    [[-TerminateReason] <String>]
    -BatchContext <BatchAccountContext>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Opis

Polecenie cmdlet Stop-AzBatchJob zatrzymuje zadanie usługi Azure Batch. To polecenie oznacza zadanie jako ukończone.

Przykłady

Przykład 1. Zatrzymywanie zadania usługi Batch

Stop-AzBatchJob -Id "Job-000001" -TerminateReason "No more tasks to run" -BatchContext $Context

To polecenie zatrzymuje zadanie o identyfikatorze Job-000001. Polecenie określa przyczynę zatrzymania zadania. Użyj polecenia cmdlet Get-AzBatchAccountKey, aby przypisać kontekst do zmiennej $Context.

Parametry

-BatchContext

Określa wystąpienie BatchAccountContext używane przez to polecenie cmdlet do interakcji z usługą Batch. Jeśli użyjesz polecenia cmdlet Get-AzBatchAccount, aby uzyskać element BatchAccountContext, uwierzytelnianie Microsoft Entra będzie używane podczas interakcji z usługą Batch. Aby zamiast tego użyć uwierzytelniania klucza współużytkowanego, użyj polecenia cmdlet Get-AzBatchAccountKey, aby uzyskać obiekt BatchAccountContext z wypełnionymi kluczami dostępu. W przypadku korzystania z uwierzytelniania za pomocą klucza współużytkowanego klucz podstawowy jest używany domyślnie. Aby zmienić klucz do użycia, ustaw właściwość BatchAccountContext.KeyInUse.

Typ:BatchAccountContext
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Id

Określa identyfikator zadania, które to polecenie cmdlet zatrzymuje.

Typ:String
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-TerminateReason

Określa przyczynę, dla której podjęto decyzję o zatrzymaniu zadania. To polecenie cmdlet przechowuje ten tekst jako właściwość TerminateReason zadania.

Typ:String
Position:1
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

String

BatchAccountContext

Dane wyjściowe

Void