Enable Console - Enable Console

Dienst:

Serial Console

API-Version:

2024-07-01

Aktivieren der seriellen Konsole für ein Abonnement
Aktiviert den seriellen Konsolendienst für alle VMs und VM-Skalierungsgruppen im bereitgestellten Abonnement.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
default	path	True	string	Standardparameter. Belassen Sie den Wert als "Standard".
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	EnableSerialConsoleResult	Die Anforderung ist erfolgreich.
404 Not Found	GetSerialConsoleSubscriptionNotFound	Abonnement nicht gefunden – gibt ein JSON-Objekt mit Fehlerdetails zurück.
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Enable Serial Console for a subscription

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SerialConsole/consoleServices/default/enableConsole?api-version=2024-07-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.serialconsole import MicrosoftSerialConsoleClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-serialconsole
# USAGE
    python enable_console_examples.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MicrosoftSerialConsoleClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.enable_console(
        default="default",
    )
    print(response)


# x-ms-original-file: 2024-07-01/EnableConsoleExamples.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armserialconsole_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/serialconsole/armserialconsole/v2"
)

// Generated from example definition: 2024-07-01/EnableConsoleExamples.json
func ExampleMicrosoftSerialConsoleClient_EnableConsole() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armserialconsole.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMicrosoftSerialConsoleClient().EnableConsole(ctx, "default", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armserialconsole.MicrosoftSerialConsoleClientEnableConsoleResponse{
	// 	EnableSerialConsoleResult: armserialconsole.EnableSerialConsoleResult{
	// 		Properties: &armserialconsole.EnableSerialConsoleResultProperties{
	// 			Disabled: to.Ptr(false),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { MicrosoftSerialConsoleClient } = require("@azure/arm-serialconsole");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to enables the Serial Console service for all VMs and VM scale sets in the provided subscription
 *
 * @summary enables the Serial Console service for all VMs and VM scale sets in the provided subscription
 * x-ms-original-file: 2024-07-01/EnableConsoleExamples.json
 */
async function enableSerialConsoleForASubscription() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new MicrosoftSerialConsoleClient(credential, subscriptionId);
  const result = await client.enableConsole("default");
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:

200

{
  "properties": {
    "disabled": false
  }
}

Statuscode:

404

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

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Diensts.
CloudErrorBody	Eine Fehlerantwort des Batchdiensts.
EnableSerialConsoleResult	Ergebnis der seriellen Konsole aktivieren
EnableSerialConsoleResultProperties
GetSerialConsoleSubscriptionNotFound	Serielle Konsolenabonnement nicht gefunden

CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloudfehlertext.

CloudErrorBody

Objekt

Eine Fehlerantwort des Batchdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

EnableSerialConsoleResult

Objekt

Ergebnis der seriellen Konsole aktivieren

Name	Typ	Beschreibung
properties	EnableSerialConsoleResultProperties

EnableSerialConsoleResultProperties

Objekt

Name	Typ	Beschreibung
disabled	boolean	Gibt an, ob die serielle Konsole deaktiviert ist.

GetSerialConsoleSubscriptionNotFound

Objekt

Serielle Konsolenabonnement nicht gefunden

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Nachricht "Abonnement nicht gefunden"