MicrosoftSerialConsoleClient class
- Extends
Конструкторы
Microsoft |
Инициализирует новый экземпляр класса MicrosoftSerialConsoleClient. |
Свойства
$host | |
api |
|
serial |
|
subscription |
Унаследованные свойства
pipeline | Конвейер, используемый этим клиентом для выполнения запросов |
Методы
disable |
Отключает службу последовательной консоли для всех виртуальных машин и масштабируемых наборов виртуальных машин в предоставленной подписке. |
enable |
Включает службу последовательной консоли для всех виртуальных машин и масштабируемых наборов виртуальных машин в предоставленной подписке. |
get |
Возвращает значение, указывающее, отключена ли последовательная консоль для данной подписки. |
list |
Возвращает список операций API последовательной консоли. |
Наследуемые методы
send |
Отправьте HTTP-запрос, который заполняется с помощью предоставленного operationSpec. |
send |
Отправьте предоставленный запрос httpRequest. |
Сведения о конструкторе
MicrosoftSerialConsoleClient(TokenCredential, string, MicrosoftSerialConsoleClientOptionalParams)
Инициализирует новый экземпляр класса MicrosoftSerialConsoleClient.
new MicrosoftSerialConsoleClient(credentials: TokenCredential, subscriptionId: string, options?: MicrosoftSerialConsoleClientOptionalParams)
Параметры
- credentials
- TokenCredential
Учетные данные подписки, которые однозначно идентифицируют подписку клиента.
- subscriptionId
-
string
Идентификатор подписки, который однозначно идентифицирует подписку Microsoft Azure. Идентификатор подписки является частью универсального кода ресурса (URI) для каждого вызова службы, для которого он требуется.
Параметры параметра
Сведения о свойстве
$host
$host: string
Значение свойства
string
apiVersion
apiVersion: string
Значение свойства
string
serialPorts
subscriptionId
subscriptionId: string
Значение свойства
string
Сведения об унаследованном свойстве
pipeline
Конвейер, используемый этим клиентом для выполнения запросов
pipeline: Pipeline
Значение свойства
Наследуется от coreClient.ServiceClient.pipeline
Сведения о методе
disableConsole(string, DisableConsoleOptionalParams)
Отключает службу последовательной консоли для всех виртуальных машин и масштабируемых наборов виртуальных машин в предоставленной подписке.
function disableConsole(defaultParam: string, options?: DisableConsoleOptionalParams): Promise<DisableSerialConsoleResult>
Параметры
- defaultParam
-
string
Параметр по умолчанию. Оставьте значение "default".
- options
- DisableConsoleOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<DisableSerialConsoleResult>
enableConsole(string, EnableConsoleOptionalParams)
Включает службу последовательной консоли для всех виртуальных машин и масштабируемых наборов виртуальных машин в предоставленной подписке.
function enableConsole(defaultParam: string, options?: EnableConsoleOptionalParams): Promise<EnableSerialConsoleResult>
Параметры
- defaultParam
-
string
Параметр по умолчанию. Оставьте значение "default".
- options
- EnableConsoleOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<EnableSerialConsoleResult>
getConsoleStatus(string, GetConsoleStatusOptionalParams)
Возвращает значение, указывающее, отключена ли последовательная консоль для данной подписки.
function getConsoleStatus(defaultParam: string, options?: GetConsoleStatusOptionalParams): Promise<SerialConsoleStatus>
Параметры
- defaultParam
-
string
Параметр по умолчанию. Оставьте значение "default".
- options
- GetConsoleStatusOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<SerialConsoleStatus>
listOperations(ListOperationsOptionalParams)
Возвращает список операций API последовательной консоли.
function listOperations(options?: ListOperationsOptionalParams): Promise<SerialConsoleOperations>
Параметры
- options
- ListOperationsOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<SerialConsoleOperations>
Сведения о наследуемом методе
sendOperationRequest<T>(OperationArguments, OperationSpec)
Отправьте HTTP-запрос, который заполняется с помощью предоставленного operationSpec.
function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>
Параметры
- operationArguments
- OperationArguments
Аргументы, из которые будут заполнены значения шаблона HTTP-запроса.
- operationSpec
- OperationSpec
Параметр OperationSpec, используемый для заполнения httpRequest.
Возвращаемое значение
Promise<T>
Наследуется от coreClient.ServiceClient.sendOperationRequest
sendRequest(PipelineRequest)
Отправьте предоставленный запрос httpRequest.
function sendRequest(request: PipelineRequest): Promise<PipelineResponse>
Параметры
- request
- PipelineRequest
Возвращаемое значение
Promise<PipelineResponse>
Наследуется от coreClient.ServiceClient.sendRequest