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
client.go models.go version.go
const ( // DefaultBaseURI is the default URI used for the service Serialconsole DefaultBaseURI = "https://management.azure.com" )
UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
BaseClient is the base client for Serialconsole.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
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 (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 (client BaseClient) DisableConsolePreparer(ctx context.Context, defaultParameter string) (*http.Request, error)
DisableConsolePreparer prepares the DisableConsole request.
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.
DisableConsoleSender sends the DisableConsole request. The method will close the http.Response Body if it receives an error.
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 (client BaseClient) EnableConsolePreparer(ctx context.Context, defaultParameter string) (*http.Request, error)
EnableConsolePreparer prepares the EnableConsole request.
EnableConsoleResponder handles the response to the EnableConsole request. The method always closes the http.Response Body.
EnableConsoleSender sends the EnableConsole request. The method will close the http.Response Body if it receives an error.
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 (client BaseClient) GetConsoleStatusPreparer(ctx context.Context, defaultParameter string) (*http.Request, error)
GetConsoleStatusPreparer prepares the GetConsoleStatus request.
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.
GetConsoleStatusSender sends the GetConsoleStatus request. The method will close the http.Response Body if it receives an error.
func (client BaseClient) ListOperations(ctx context.Context) (result Operations, err error)
ListOperations gets a list of Serial Console API operations.
ListOperationsPreparer prepares the ListOperations request.
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.
ListOperationsSender sends the ListOperations request. The method will close the http.Response Body if it receives an error.
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 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 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 struct { autorest.Response `json:"-"` // Value - A list of Serial Console operations Value *[]OperationsValueItem `json:"value,omitempty"` }
Operations serial Console operations
type OperationsValueItem struct { Name *string `json:"name,omitempty"` IsDataAction *string `json:"isDataAction,omitempty"` Display *OperationsValueItemDisplay `json:"display,omitempty"` }
OperationsValueItem ...
type OperationsValueItemDisplay struct { Provider *string `json:"provider,omitempty"` Resource *string `json:"resource,omitempty"` Operation *string `json:"operation,omitempty"` Description *string `json:"description,omitempty"` }
OperationsValueItemDisplay ...
SetObject ...
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.
Path | Synopsis |
---|---|
serialconsoleapi |
Package serialconsole imports 6 packages (graph) and is imported by 3 packages. Updated 2021-01-28. Refresh now. Tools for package owners.