Disable Console - Disable Console

Usługa:

Serial Console

Wersja interfejsu API:

2023-01-01

Wyłączanie konsoli szeregowej dla subskrypcji
Wyłącza usługę konsoli szeregowej dla wszystkich maszyn wirtualnych i zestawów skalowania maszyn wirtualnych w podanej subskrypcji

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/disableConsole?api-version=2023-01-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
default	path	True	string	Parametr domyślny. Pozostaw wartość "default".
subscriptionId	path	True	string	Identyfikator subskrypcji, który jednoznacznie identyfikuje subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi wymagającego go.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DisableSerialConsoleResult	OK — zwraca obiekt JSON
404 Not Found	GetSerialConsoleSubscriptionNotFound	Nie znaleziono subskrypcji — zwraca obiekt JSON ze szczegółami błędu
Other Status Codes	CloudError	Odpowiedź domyślna

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

Disable Serial Console for a subscription

Przykładowe żądanie

HTTP

POST https://management.azure.com/subscriptions/00000000-00000-0000-0000-000000000000/providers/Microsoft.SerialConsole/consoleServices/default/disableConsole?api-version=2023-01-01

Przykładowa odpowiedź

Kod stanu:

200

{
  "disabled": true
}

Kod stanu:

404

{
  "code": "SubscriptionNotFound",
  "message": "The subscription '00000000-00000-0000-0000-000000000000' could not be found."
}

Definicje

Nazwa	Opis
CloudError	Odpowiedź na błąd z usługi.
CloudErrorBody	Odpowiedź na błąd z usługi Batch.
DisableSerialConsoleResult	Wyłącz wynik konsoli szeregowej
GetSerialConsoleSubscriptionNotFound	Nie można odnaleźć subskrypcji konsoli szeregowej

CloudError

Objekt

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	CloudErrorBody	Treść błędu chmury.

CloudErrorBody

Objekt

Odpowiedź na błąd z usługi Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

DisableSerialConsoleResult

Objekt

Wyłącz wynik konsoli szeregowej

Nazwa	Typ	Opis
disabled	boolean	Niezależnie od tego, czy konsola szeregowa jest wyłączona.

GetSerialConsoleSubscriptionNotFound

Objekt

Nie można odnaleźć subskrypcji konsoli szeregowej

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Nie znaleziono komunikatu o subskrypcji