Virtual Machine Instances - Stop

Usługa:

Azure Arc enabled SCVMM

Wersja interfejsu API:

2024-06-01

Implementuje operację zatrzymywania maszyny wirtualnej.
Operacja wyłączania (zatrzymywania) wystąpienia maszyny wirtualnej.

POST https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceUri	path	True	string	W pełni kwalifikowany identyfikator zasobu usługi Azure Resource Manager.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
skipShutdown	SkipShutdown	Pobiera lub ustawia wartość wskazującą, czy żądać niewłasnego zamknięcia maszyny wirtualnej. Wartość true dla tej flagi wskazuje niewłaściwe zamknięcie, podczas gdy wartość false wskazuje w przeciwnym razie. Wartość domyślna to false.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Zaakceptowano operację zasobu. Nagłówki Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

VirtualMachineInstances_Stop_MaximumSet

VirtualMachineInstances_Stop_MinimumSet

VirtualMachineInstances_Stop_MaximumSet

Przykładowe żądanie

HTTP

POST https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

{
  "skipShutdown": "true"
}

Przykładowa odpowiedź

Kod stanu:

202

location: https://contoso.com/operationstatus

VirtualMachineInstances_Stop_MinimumSet

Przykładowe żądanie

HTTP

POST https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

{}

Przykładowa odpowiedź

Kod stanu:

202

location: https://contoso.com/operationstatus

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
SkipShutdown	Pobiera lub ustawia wartość wskazującą, czy żądać niewłasnego zamknięcia maszyny wirtualnej. Wartość true dla tej flagi wskazuje niewłaściwe zamknięcie, podczas gdy wartość false wskazuje w przeciwnym razie. Wartość domyślna to false.
StopVirtualMachineOptions	Definiuje właściwości akcji zatrzymania.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

SkipShutdown

Pobiera lub ustawia wartość wskazującą, czy żądać niewłasnego zamknięcia maszyny wirtualnej. Wartość true dla tej flagi wskazuje niewłaściwe zamknięcie, podczas gdy wartość false wskazuje w przeciwnym razie. Wartość domyślna to false.

Nazwa	Typ	Opis
false	string	Wyłącz zamykanie pomiń.
true	string	Włącz zamykanie pominięcia.

StopVirtualMachineOptions

Definiuje właściwości akcji zatrzymania.

Nazwa	Typ	Domyślna wartość	Opis
skipShutdown	SkipShutdown	false	Pobiera lub ustawia wartość wskazującą, czy żądać niewłasnego zamknięcia maszyny wirtualnej. Wartość true dla tej flagi wskazuje niewłaściwe zamknięcie, podczas gdy wartość false wskazuje w przeciwnym razie. Wartość domyślna to false.