serialconsole

Documentation

Overview

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

Azure Virtual Machine Serial Console allows you to access serial console of a Virtual Machine

Index

• Constants
• func UserAgent() string
• func Version() string
• type BaseClient
  • func New(subscriptionID string) BaseClient
  • func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
• type ConsoleClient
  • func NewConsoleClient(subscriptionID string) ConsoleClient
  • func NewConsoleClientWithBaseURI(baseURI string, subscriptionID string) ConsoleClient
  • func (client ConsoleClient) DisableConsole(ctx context.Context) (result SetDisabledResult, err error)
  • func (client ConsoleClient) DisableConsolePreparer(ctx context.Context) (*http.Request, error)
  • func (client ConsoleClient) DisableConsoleResponder(resp *http.Response) (result SetDisabledResult, err error)
  • func (client ConsoleClient) DisableConsoleSender(req *http.Request) (*http.Response, error)
  • func (client ConsoleClient) EnableConsole(ctx context.Context) (result SetDisabledResult, err error)
  • func (client ConsoleClient) EnableConsolePreparer(ctx context.Context) (*http.Request, error)
  • func (client ConsoleClient) EnableConsoleResponder(resp *http.Response) (result SetDisabledResult, err error)
  • func (client ConsoleClient) EnableConsoleSender(req *http.Request) (*http.Response, error)
• type DeploymentValidateResult
• type GetDisabledResult
• type GetResult
• type ListClient
  • func NewListClient(subscriptionID string) ListClient
  • func NewListClientWithBaseURI(baseURI string, subscriptionID string) ListClient
  • func (client ListClient) Operations(ctx context.Context) (result Operations, err error)
  • func (client ListClient) OperationsPreparer(ctx context.Context) (*http.Request, error)
  • func (client ListClient) OperationsResponder(resp *http.Response) (result Operations, err error)
  • func (client ListClient) OperationsSender(req *http.Request) (*http.Response, error)
• type ListConsoleClient
  • func NewListConsoleClient(subscriptionID string) ListConsoleClient
  • func NewListConsoleClientWithBaseURI(baseURI string, subscriptionID string) ListConsoleClient
  • func (client ListConsoleClient) Disabled(ctx context.Context) (result GetDisabledResult, err error)
  • func (client ListConsoleClient) DisabledPreparer(ctx context.Context) (*http.Request, error)
  • func (client ListConsoleClient) DisabledResponder(resp *http.Response) (result GetDisabledResult, err error)
  • func (client ListConsoleClient) DisabledSender(req *http.Request) (*http.Response, error)
• type Operations
• type SetDisabledResult

Constants

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

Functions

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.

Types

type BaseClient

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

BaseClient is the base client for Serialconsole.

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.

type ConsoleClient

type ConsoleClient struct {
	BaseClient
}

ConsoleClient is the azure Virtual Machine Serial Console allows you to access serial console of a Virtual Machine

func NewConsoleClient

func NewConsoleClient(subscriptionID string) ConsoleClient

NewConsoleClient creates an instance of the ConsoleClient client.

func NewConsoleClientWithBaseURI

func NewConsoleClientWithBaseURI(baseURI string, subscriptionID string) ConsoleClient

NewConsoleClientWithBaseURI creates an instance of the ConsoleClient client.

func (ConsoleClient) DisableConsole

func (client ConsoleClient) DisableConsole(ctx context.Context) (result SetDisabledResult, err error)

DisableConsole disables Serial Console for a subscription

func (ConsoleClient) DisableConsolePreparer

func (client ConsoleClient) DisableConsolePreparer(ctx context.Context) (*http.Request, error)

DisableConsolePreparer prepares the DisableConsole request.

func (ConsoleClient) DisableConsoleResponder

func (client ConsoleClient) DisableConsoleResponder(resp *http.Response) (result SetDisabledResult, err error)

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

func (ConsoleClient) DisableConsoleSender

func (client ConsoleClient) 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 (ConsoleClient) EnableConsole

func (client ConsoleClient) EnableConsole(ctx context.Context) (result SetDisabledResult, err error)

EnableConsole enables Serial Console for a subscription

func (ConsoleClient) EnableConsolePreparer

func (client ConsoleClient) EnableConsolePreparer(ctx context.Context) (*http.Request, error)

EnableConsolePreparer prepares the EnableConsole request.

func (ConsoleClient) EnableConsoleResponder

func (client ConsoleClient) EnableConsoleResponder(resp *http.Response) (result SetDisabledResult, err error)

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

func (ConsoleClient) EnableConsoleSender

func (client ConsoleClient) 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.

type DeploymentValidateResult

type DeploymentValidateResult struct {
	// ErrorMessage - Error message
	ErrorMessage *string `json:"errorMessage,omitempty"`
}

DeploymentValidateResult details on Failure

type GetDisabledResult

type GetDisabledResult struct {
	autorest.Response `json:"-"`
	// Disabled - Disabled result
	Disabled *bool `json:"disabled,omitempty"`
}

GetDisabledResult returns whether or not Serial Console is disabled for this given subscription

type GetResult

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

GetResult returns whether or not Serial Console is disabled.

type ListClient

type ListClient struct {
	BaseClient
}

ListClient is the azure Virtual Machine Serial Console allows you to access serial console of a Virtual Machine

func NewListClient

func NewListClient(subscriptionID string) ListClient

NewListClient creates an instance of the ListClient client.

func NewListClientWithBaseURI

func NewListClientWithBaseURI(baseURI string, subscriptionID string) ListClient

NewListClientWithBaseURI creates an instance of the ListClient client.

func (ListClient) Operations

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

Operations gets a list of Serial Console API operations.

func (ListClient) OperationsPreparer

func (client ListClient) OperationsPreparer(ctx context.Context) (*http.Request, error)

OperationsPreparer prepares the Operations request.

func (ListClient) OperationsResponder

func (client ListClient) OperationsResponder(resp *http.Response) (result Operations, err error)

OperationsResponder handles the response to the Operations request. The method always closes the http.Response Body.

func (ListClient) OperationsSender

func (client ListClient) OperationsSender(req *http.Request) (*http.Response, error)

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

type ListConsoleClient

type ListConsoleClient struct {
	BaseClient
}

ListConsoleClient is the azure Virtual Machine Serial Console allows you to access serial console of a Virtual Machine

func NewListConsoleClient

func NewListConsoleClient(subscriptionID string) ListConsoleClient

NewListConsoleClient creates an instance of the ListConsoleClient client.

func NewListConsoleClientWithBaseURI

func NewListConsoleClientWithBaseURI(baseURI string, subscriptionID string) ListConsoleClient

NewListConsoleClientWithBaseURI creates an instance of the ListConsoleClient client.

func (ListConsoleClient) Disabled

func (client ListConsoleClient) Disabled(ctx context.Context) (result GetDisabledResult, err error)

Disabled gets if Serial Console is disabled for a subscription.

func (ListConsoleClient) DisabledPreparer

func (client ListConsoleClient) DisabledPreparer(ctx context.Context) (*http.Request, error)

DisabledPreparer prepares the Disabled request.

func (ListConsoleClient) DisabledResponder

func (client ListConsoleClient) DisabledResponder(resp *http.Response) (result GetDisabledResult, err error)

DisabledResponder handles the response to the Disabled request. The method always closes the http.Response Body.

func (ListConsoleClient) DisabledSender

func (client ListConsoleClient) DisabledSender(req *http.Request) (*http.Response, error)

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

type Operations

type Operations struct {
	autorest.Response `json:"-"`
	// Value - Serial Console operations
	Value *string `json:"value,omitempty"`
}

Operations serial Console operations

type SetDisabledResult

type SetDisabledResult struct {
	autorest.Response `json:"-"`
	// Disabled - Disabled result
	Disabled *bool `json:"disabled,omitempty"`
}

SetDisabledResult sets disable status and returns whether or not Serial Console is now disabled for this given subscription