...

Package serialconsole

import "github.com/Azure/azure-sdk-for-go/services/serialconsole/mgmt/2018-05-01/serialconsole"
Overview
Index
Subdirectories

Overview ▾

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/serialconsole/armserialconsole(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/serialconsole/armserialconsole). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package serialconsole implements the Azure ARM Serialconsole service API version 2018-05-01.

The Azure Serial Console allows you to access the serial console of a Virtual Machine or VM scale set instance

Index ▾

Constants
func UserAgent() string
func Version() string
type BaseClient
    func New(subscriptionID string) BaseClient
    func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
    func (client BaseClient) DisableConsole(ctx context.Context, defaultParameter string) (result SetObject, err error)
    func (client BaseClient) DisableConsolePreparer(ctx context.Context, defaultParameter string) (*http.Request, error)
    func (client BaseClient) DisableConsoleResponder(resp *http.Response) (result SetObject, err error)
    func (client BaseClient) DisableConsoleSender(req *http.Request) (*http.Response, error)
    func (client BaseClient) EnableConsole(ctx context.Context, defaultParameter string) (result SetObject, err error)
    func (client BaseClient) EnableConsolePreparer(ctx context.Context, defaultParameter string) (*http.Request, error)
    func (client BaseClient) EnableConsoleResponder(resp *http.Response) (result SetObject, err error)
    func (client BaseClient) EnableConsoleSender(req *http.Request) (*http.Response, error)
    func (client BaseClient) GetConsoleStatus(ctx context.Context, defaultParameter string) (result SetObject, err error)
    func (client BaseClient) GetConsoleStatusPreparer(ctx context.Context, defaultParameter string) (*http.Request, error)
    func (client BaseClient) GetConsoleStatusResponder(resp *http.Response) (result SetObject, err error)
    func (client BaseClient) GetConsoleStatusSender(req *http.Request) (*http.Response, error)
    func (client BaseClient) ListOperations(ctx context.Context) (result Operations, err error)
    func (client BaseClient) ListOperationsPreparer(ctx context.Context) (*http.Request, error)
    func (client BaseClient) ListOperationsResponder(resp *http.Response) (result Operations, err error)
    func (client BaseClient) ListOperationsSender(req *http.Request) (*http.Response, error)
type DisableSerialConsoleResult
type EnableSerialConsoleResult
type GetSerialConsoleSubscriptionNotFound
type Operations
type OperationsValueItem
type OperationsValueItemDisplay
type SetObject
type Status

Package files

client.go models.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Serialconsole
    DefaultBaseURI = "https://management.azure.com"
)

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

type BaseClient

BaseClient is the base client for Serialconsole.

type BaseClient struct {
    autorest.Client
    BaseURI        string
    SubscriptionID string
}

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (BaseClient) DisableConsole

func (client BaseClient) DisableConsole(ctx context.Context, defaultParameter string) (result SetObject, err error)

DisableConsole disables the Serial Console service for all VMs and VM scale sets in the provided subscription Parameters: defaultParameter - default parameter. Leave the value as "default".

func (BaseClient) DisableConsolePreparer

func (client BaseClient) DisableConsolePreparer(ctx context.Context, defaultParameter string) (*http.Request, error)

DisableConsolePreparer prepares the DisableConsole request.

func (BaseClient) DisableConsoleResponder

func (client BaseClient) DisableConsoleResponder(resp *http.Response) (result SetObject, err error)

DisableConsoleResponder handles the response to the DisableConsole request. The method always closes the http.Response Body.

func (BaseClient) DisableConsoleSender

func (client BaseClient) DisableConsoleSender(req *http.Request) (*http.Response, error)

DisableConsoleSender sends the DisableConsole request. The method will close the http.Response Body if it receives an error.

func (BaseClient) EnableConsole

func (client BaseClient) EnableConsole(ctx context.Context, defaultParameter string) (result SetObject, err error)

EnableConsole enables the Serial Console service for all VMs and VM scale sets in the provided subscription Parameters: defaultParameter - default parameter. Leave the value as "default".

func (BaseClient) EnableConsolePreparer

func (client BaseClient) EnableConsolePreparer(ctx context.Context, defaultParameter string) (*http.Request, error)

EnableConsolePreparer prepares the EnableConsole request.

func (BaseClient) EnableConsoleResponder

func (client BaseClient) EnableConsoleResponder(resp *http.Response) (result SetObject, err error)

EnableConsoleResponder handles the response to the EnableConsole request. The method always closes the http.Response Body.

func (BaseClient) EnableConsoleSender

func (client BaseClient) EnableConsoleSender(req *http.Request) (*http.Response, error)

EnableConsoleSender sends the EnableConsole request. The method will close the http.Response Body if it receives an error.

func (BaseClient) GetConsoleStatus

func (client BaseClient) GetConsoleStatus(ctx context.Context, defaultParameter string) (result SetObject, err error)

GetConsoleStatus gets whether or not Serial Console is disabled for a given subscription Parameters: defaultParameter - default parameter. Leave the value as "default".

func (BaseClient) GetConsoleStatusPreparer

func (client BaseClient) GetConsoleStatusPreparer(ctx context.Context, defaultParameter string) (*http.Request, error)

GetConsoleStatusPreparer prepares the GetConsoleStatus request.

func (BaseClient) GetConsoleStatusResponder

func (client BaseClient) GetConsoleStatusResponder(resp *http.Response) (result SetObject, err error)

GetConsoleStatusResponder handles the response to the GetConsoleStatus request. The method always closes the http.Response Body.

func (BaseClient) GetConsoleStatusSender

func (client BaseClient) GetConsoleStatusSender(req *http.Request) (*http.Response, error)

GetConsoleStatusSender sends the GetConsoleStatus request. The method will close the http.Response Body if it receives an error.

func (BaseClient) ListOperations

func (client BaseClient) ListOperations(ctx context.Context) (result Operations, err error)

ListOperations gets a list of Serial Console API operations.

func (BaseClient) ListOperationsPreparer

func (client BaseClient) ListOperationsPreparer(ctx context.Context) (*http.Request, error)

ListOperationsPreparer prepares the ListOperations request.

func (BaseClient) ListOperationsResponder

func (client BaseClient) ListOperationsResponder(resp *http.Response) (result Operations, err error)

ListOperationsResponder handles the response to the ListOperations request. The method always closes the http.Response Body.

func (BaseClient) ListOperationsSender

func (client BaseClient) ListOperationsSender(req *http.Request) (*http.Response, error)

ListOperationsSender sends the ListOperations request. The method will close the http.Response Body if it receives an error.

type DisableSerialConsoleResult

DisableSerialConsoleResult returns whether or not Serial Console is disabled.

type DisableSerialConsoleResult struct {
    // Disabled - Whether or not Serial Console is disabled.
    Disabled *bool `json:"disabled,omitempty"`
}

type EnableSerialConsoleResult

EnableSerialConsoleResult returns whether or not Serial Console is disabled (enabled).

type EnableSerialConsoleResult struct {
    // Disabled - Whether or not Serial Console is disabled (enabled).
    Disabled *bool `json:"disabled,omitempty"`
}

type GetSerialConsoleSubscriptionNotFound

GetSerialConsoleSubscriptionNotFound error saying that the provided subscription could not be found

type GetSerialConsoleSubscriptionNotFound struct {
    // Code - Error code
    Code *string `json:"code,omitempty"`
    // Message - Subscription not found message
    Message *string `json:"message,omitempty"`
}

type Operations

Operations serial Console operations

type Operations struct {
    autorest.Response `json:"-"`
    // Value - A list of Serial Console operations
    Value *[]OperationsValueItem `json:"value,omitempty"`
}

type OperationsValueItem

OperationsValueItem ...

type OperationsValueItem struct {
    Name         *string                     `json:"name,omitempty"`
    IsDataAction *string                     `json:"isDataAction,omitempty"`
    Display      *OperationsValueItemDisplay `json:"display,omitempty"`
}

type OperationsValueItemDisplay

OperationsValueItemDisplay ...

type OperationsValueItemDisplay struct {
    Provider    *string `json:"provider,omitempty"`
    Resource    *string `json:"resource,omitempty"`
    Operation   *string `json:"operation,omitempty"`
    Description *string `json:"description,omitempty"`
}

type SetObject

SetObject ...

type SetObject struct {
    autorest.Response `json:"-"`
    Value             interface{} `json:"value,omitempty"`
}

type Status

Status returns whether or not Serial Console is disabled.

type Status struct {
    // Disabled - Whether or not Serial Console is disabled.
    Disabled *bool `json:"disabled,omitempty"`
}

Subdirectories

Name Synopsis
..
serialconsoleapi Deprecated: Please note, this package has been deprecated.