azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/serialconsole/mgmt/2018-05-01/serialconsole Index | Files | Directories

package serialconsole

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

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

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 Uses

❖
func UserAgent() string

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

func Version Uses

❖
func Version() string

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

type BaseClient Uses

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

BaseClient is the base client for Serialconsole.

func New Uses

❖
func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

❖
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 Uses

❖
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 Uses

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

DisableConsolePreparer prepares the DisableConsole request.

func (BaseClient) DisableConsoleResponder Uses

❖
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 Uses

❖
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 Uses

❖
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 Uses

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

EnableConsolePreparer prepares the EnableConsole request.

func (BaseClient) EnableConsoleResponder Uses

❖
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 Uses

❖
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 Uses

❖
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 Uses

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

GetConsoleStatusPreparer prepares the GetConsoleStatus request.

func (BaseClient) GetConsoleStatusResponder Uses

❖
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 Uses

❖
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 Uses

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

ListOperations gets a list of Serial Console API operations.

func (BaseClient) ListOperationsPreparer Uses

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

ListOperationsPreparer prepares the ListOperations request.

func (BaseClient) ListOperationsResponder Uses

❖
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 Uses

❖
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 Uses

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

DisableSerialConsoleResult returns whether or not Serial Console is disabled.

type EnableSerialConsoleResult Uses

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

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

type GetSerialConsoleSubscriptionNotFound Uses

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

GetSerialConsoleSubscriptionNotFound error saying that the provided subscription could not be found

type Operations Uses

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

Operations serial Console operations

type OperationsValueItem Uses

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

OperationsValueItem ...

type OperationsValueItemDisplay Uses

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

OperationsValueItemDisplay ...

type SetObject Uses

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

SetObject ...

type Status Uses

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

Status returns whether or not Serial Console is disabled.

Directories

PathSynopsis
serialconsoleapi

Package serialconsole imports 6 packages (graph) and is imported by 3 packages. Updated 2021-01-28. Refresh now. Tools for package owners.