azure.mgmt.serialconsole.operations module¶

class azure.mgmt.serialconsole.operations.MicrosoftSerialConsoleClientOperationsMixin[source]¶

Bases: azure.mgmt.serialconsole._vendor.MicrosoftSerialConsoleClientMixinABC

disable_console(default: str, **kwargs: Any) → Union[azure.mgmt.serialconsole.models._models_py3.DisableSerialConsoleResult, azure.mgmt.serialconsole.models._models_py3.GetSerialConsoleSubscriptionNotFound][source]¶

Disable Serial Console for a subscription.

Disables the Serial Console service for all VMs and VM scale sets in the provided subscription.

Parameters: default (str) – Default parameter. Leave the value as “default”. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: DisableSerialConsoleResult or GetSerialConsoleSubscriptionNotFound or the result of cls(response)
Return type: DisableSerialConsoleResult or GetSerialConsoleSubscriptionNotFound
Raises: HttpResponseError –

enable_console(default: str, **kwargs: Any) → Union[azure.mgmt.serialconsole.models._models_py3.EnableSerialConsoleResult, azure.mgmt.serialconsole.models._models_py3.GetSerialConsoleSubscriptionNotFound][source]¶

Enable Serial Console for a subscription.

Enables the Serial Console service for all VMs and VM scale sets in the provided subscription.

Parameters: default (str) – Default parameter. Leave the value as “default”. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: EnableSerialConsoleResult or GetSerialConsoleSubscriptionNotFound or the result of cls(response)
Return type: EnableSerialConsoleResult or GetSerialConsoleSubscriptionNotFound
Raises: HttpResponseError –

get_console_status(default: str, **kwargs: Any) → Union[azure.mgmt.serialconsole.models._models_py3.SerialConsoleStatus, azure.mgmt.serialconsole.models._models_py3.GetSerialConsoleSubscriptionNotFound][source]¶

Get the disabled status for a subscription.

Gets whether or not Serial Console is disabled for a given subscription.

Parameters: default (str) – Default parameter. Leave the value as “default”. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: SerialConsoleStatus or GetSerialConsoleSubscriptionNotFound or the result of cls(response)
Return type: SerialConsoleStatus or GetSerialConsoleSubscriptionNotFound
Raises: HttpResponseError –

list_operations(**kwargs: Any) → azure.mgmt.serialconsole.models._models_py3.SerialConsoleOperations[source]¶

Gets a list of Serial Console API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: SerialConsoleOperations or the result of cls(response)
Return type: SerialConsoleOperations
Raises: HttpResponseError –

class azure.mgmt.serialconsole.operations.SerialPortsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through MicrosoftSerialConsoleClient’s serial_ports attribute.

connect(resource_group_name: str, resource_provider_namespace: str, parent_resource_type: str, parent_resource: str, serial_port: str, **kwargs: Any) → azure.mgmt.serialconsole.models._models_py3.SerialPortConnectResult[source]¶

Connect to serial port of the target resource.

Parameters

resource_group_name (str) – The name of the resource group. Required.
resource_provider_namespace (str) – The namespace of the resource provider. Required.
parent_resource_type (str) – The resource type of the parent resource. For example: ‘virtualMachines’ or ‘virtualMachineScaleSets’. Required.
parent_resource (str) – The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. Required.
serial_port (str) – The name of the serial port to connect to. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SerialPortConnectResult or the result of cls(response)

Return type

SerialPortConnectResult

Raises

HttpResponseError –

create(resource_group_name: str, resource_provider_namespace: str, parent_resource_type: str, parent_resource: str, serial_port: str, parameters: _models.SerialPort, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SerialPort[source]¶

create(resource_group_name: str, resource_provider_namespace: str, parent_resource_type: str, parent_resource: str, serial_port: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SerialPort

Creates or updates a serial port.

Parameters

resource_group_name (str) – The name of the resource group. Required.
resource_provider_namespace (str) – The namespace of the resource provider. Required.
parent_resource_type (str) – The resource type of the parent resource. For example: ‘virtualMachines’ or ‘virtualMachineScaleSets’. Required.
parent_resource (str) – The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. Required.
serial_port (str) – The name of the serial port to create. Required.
parameters (SerialPort or IO) – Parameters supplied to create the serial port. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

SerialPort or the result of cls(response)

Return type

SerialPort

Raises

HttpResponseError –

delete(resource_group_name: str, resource_provider_namespace: str, parent_resource_type: str, parent_resource: str, serial_port: str, **kwargs: Any) → None [source]¶

Deletes a serial port.

Parameters

resource_group_name (str) – The name of the resource group. Required.
resource_provider_namespace (str) – The namespace of the resource provider. Required.
parent_resource_type (str) – The resource type of the parent resource. For example: ‘virtualMachines’ or ‘virtualMachineScaleSets’. Required.
parent_resource (str) – The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. Required.
serial_port (str) – The name of the serial port to delete. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, resource_provider_namespace: str, parent_resource_type: str, parent_resource: str, serial_port: str, **kwargs: Any) → azure.mgmt.serialconsole.models._models_py3.SerialPort[source]¶

Gets the configured settings for a serial port.

Parameters

resource_group_name (str) – The name of the resource group. Required.
resource_provider_namespace (str) – The namespace of the resource provider. Required.
parent_resource_type (str) – The resource type of the parent resource. For example: ‘virtualMachines’ or ‘virtualMachineScaleSets’. Required.
parent_resource (str) – The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. Required.
serial_port (str) – The name of the serial port to connect to. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SerialPort or the result of cls(response)

Return type

SerialPort

Raises

HttpResponseError –

list(resource_group_name: str, resource_provider_namespace: str, parent_resource_type: str, parent_resource: str, **kwargs: Any) → azure.mgmt.serialconsole.models._models_py3.SerialPortListResult[source]¶

Lists all of the configured serial ports for a parent resource.

Parameters

resource_group_name (str) – The name of the resource group. Required.
resource_provider_namespace (str) – The namespace of the resource provider. Required.
parent_resource_type (str) – The resource type of the parent resource. For example: ‘virtualMachines’ or ‘virtualMachineScaleSets’. Required.
parent_resource (str) – The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SerialPortListResult or the result of cls(response)

Return type

SerialPortListResult

Raises

HttpResponseError –

list_by_subscriptions(**kwargs: Any) → azure.mgmt.serialconsole.models._models_py3.SerialPortListResult[source]¶

Handles requests to list all SerialPort resources in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: SerialPortListResult or the result of cls(response)
Return type: SerialPortListResult
Raises: HttpResponseError –

models = <module 'azure.mgmt.serialconsole.models' from '/mnt/vss/_work/1/s/sdk/serialconsole/azure-mgmt-serialconsole/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/serialconsole/models/__init__.py'>¶