servermanagement

package
v11.2.2-beta+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 7, 2017 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package servermanagement implements the Azure ARM Servermanagement service API version 2015-07-01-preview.

REST API for Azure Server Management Service.

Index

Constants

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

Variables

This section is empty.

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 AutoUpgrade

type AutoUpgrade string

AutoUpgrade enumerates the values for auto upgrade.

const (
	// Off specifies the off state for auto upgrade.
	Off AutoUpgrade = "Off"
	// On specifies the on state for auto upgrade.
	On AutoUpgrade = "On"
)

type Error

type Error struct {
	Code    *int32  `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
	Fields  *string `json:"fields,omitempty"`
}

Error is error message.

type GatewayClient

type GatewayClient struct {
	ManagementClient
}

GatewayClient is the REST API for Azure Server Management Service.

func NewGatewayClient

func NewGatewayClient(subscriptionID string) GatewayClient

NewGatewayClient creates an instance of the GatewayClient client.

func NewGatewayClientWithBaseURI

func NewGatewayClientWithBaseURI(baseURI string, subscriptionID string) GatewayClient

NewGatewayClientWithBaseURI creates an instance of the GatewayClient client.

func (GatewayClient) Create

func (client GatewayClient) Create(resourceGroupName string, gatewayName string, gatewayParameters GatewayParameters, cancel <-chan struct{}) (<-chan GatewayResource, <-chan error)

Create creates or updates a ManagementService gateway. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName is the gateway name (256 characters maximum). gatewayParameters is parameters supplied to the CreateOrUpdate operation.

func (GatewayClient) CreatePreparer

func (client GatewayClient) CreatePreparer(resourceGroupName string, gatewayName string, gatewayParameters GatewayParameters, cancel <-chan struct{}) (*http.Request, error)

CreatePreparer prepares the Create request.

func (GatewayClient) CreateResponder

func (client GatewayClient) CreateResponder(resp *http.Response) (result GatewayResource, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (GatewayClient) CreateSender

func (client GatewayClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (GatewayClient) Delete

func (client GatewayClient) Delete(resourceGroupName string, gatewayName string) (result autorest.Response, err error)

Delete deletes a gateway from a resource group.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName is the gateway name (256 characters maximum).

func (GatewayClient) DeletePreparer

func (client GatewayClient) DeletePreparer(resourceGroupName string, gatewayName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GatewayClient) DeleteResponder

func (client GatewayClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (GatewayClient) DeleteSender

func (client GatewayClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (GatewayClient) Get

func (client GatewayClient) Get(resourceGroupName string, gatewayName string, expand GatewayExpandOption) (result GatewayResource, err error)

Get gets a gateway.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName is the gateway name (256 characters maximum). expand is gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

func (GatewayClient) GetPreparer

func (client GatewayClient) GetPreparer(resourceGroupName string, gatewayName string, expand GatewayExpandOption) (*http.Request, error)

GetPreparer prepares the Get request.

func (GatewayClient) GetProfile

func (client GatewayClient) GetProfile(resourceGroupName string, gatewayName string, cancel <-chan struct{}) (<-chan GatewayProfile, <-chan error)

GetProfile gets a gateway profile. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName is the gateway name (256 characters maximum).

func (GatewayClient) GetProfilePreparer

func (client GatewayClient) GetProfilePreparer(resourceGroupName string, gatewayName string, cancel <-chan struct{}) (*http.Request, error)

GetProfilePreparer prepares the GetProfile request.

func (GatewayClient) GetProfileResponder

func (client GatewayClient) GetProfileResponder(resp *http.Response) (result GatewayProfile, err error)

GetProfileResponder handles the response to the GetProfile request. The method always closes the http.Response Body.

func (GatewayClient) GetProfileSender

func (client GatewayClient) GetProfileSender(req *http.Request) (*http.Response, error)

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

func (GatewayClient) GetResponder

func (client GatewayClient) GetResponder(resp *http.Response) (result GatewayResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (GatewayClient) GetSender

func (client GatewayClient) GetSender(req *http.Request) (*http.Response, error)

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

func (GatewayClient) List

func (client GatewayClient) List() (result GatewayResources, err error)

List lists gateways in a subscription.

func (GatewayClient) ListComplete

func (client GatewayClient) ListComplete(cancel <-chan struct{}) (<-chan GatewayResource, <-chan error)

ListComplete gets all elements from the list without paging.

func (GatewayClient) ListForResourceGroup

func (client GatewayClient) ListForResourceGroup(resourceGroupName string) (result GatewayResources, err error)

ListForResourceGroup returns gateways in a resource group.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId.

func (GatewayClient) ListForResourceGroupComplete

func (client GatewayClient) ListForResourceGroupComplete(resourceGroupName string, cancel <-chan struct{}) (<-chan GatewayResource, <-chan error)

ListForResourceGroupComplete gets all elements from the list without paging.

func (GatewayClient) ListForResourceGroupNextResults

func (client GatewayClient) ListForResourceGroupNextResults(lastResults GatewayResources) (result GatewayResources, err error)

ListForResourceGroupNextResults retrieves the next set of results, if any.

func (GatewayClient) ListForResourceGroupPreparer

func (client GatewayClient) ListForResourceGroupPreparer(resourceGroupName string) (*http.Request, error)

ListForResourceGroupPreparer prepares the ListForResourceGroup request.

func (GatewayClient) ListForResourceGroupResponder

func (client GatewayClient) ListForResourceGroupResponder(resp *http.Response) (result GatewayResources, err error)

ListForResourceGroupResponder handles the response to the ListForResourceGroup request. The method always closes the http.Response Body.

func (GatewayClient) ListForResourceGroupSender

func (client GatewayClient) ListForResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (GatewayClient) ListNextResults

func (client GatewayClient) ListNextResults(lastResults GatewayResources) (result GatewayResources, err error)

ListNextResults retrieves the next set of results, if any.

func (GatewayClient) ListPreparer

func (client GatewayClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (GatewayClient) ListResponder

func (client GatewayClient) ListResponder(resp *http.Response) (result GatewayResources, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (GatewayClient) ListSender

func (client GatewayClient) ListSender(req *http.Request) (*http.Response, error)

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

func (GatewayClient) RegenerateProfile

func (client GatewayClient) RegenerateProfile(resourceGroupName string, gatewayName string, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)

RegenerateProfile regenerates a gateway's profile This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName is the gateway name (256 characters maximum).

func (GatewayClient) RegenerateProfilePreparer

func (client GatewayClient) RegenerateProfilePreparer(resourceGroupName string, gatewayName string, cancel <-chan struct{}) (*http.Request, error)

RegenerateProfilePreparer prepares the RegenerateProfile request.

func (GatewayClient) RegenerateProfileResponder

func (client GatewayClient) RegenerateProfileResponder(resp *http.Response) (result autorest.Response, err error)

RegenerateProfileResponder handles the response to the RegenerateProfile request. The method always closes the http.Response Body.

func (GatewayClient) RegenerateProfileSender

func (client GatewayClient) RegenerateProfileSender(req *http.Request) (*http.Response, error)

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

func (GatewayClient) Update

func (client GatewayClient) Update(resourceGroupName string, gatewayName string, gatewayParameters GatewayParameters, cancel <-chan struct{}) (<-chan GatewayResource, <-chan error)

Update updates a gateway belonging to a resource group. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName is the gateway name (256 characters maximum). gatewayParameters is parameters supplied to the Update operation.

func (GatewayClient) UpdatePreparer

func (client GatewayClient) UpdatePreparer(resourceGroupName string, gatewayName string, gatewayParameters GatewayParameters, cancel <-chan struct{}) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (GatewayClient) UpdateResponder

func (client GatewayClient) UpdateResponder(resp *http.Response) (result GatewayResource, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (GatewayClient) UpdateSender

func (client GatewayClient) UpdateSender(req *http.Request) (*http.Response, error)

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

func (GatewayClient) Upgrade

func (client GatewayClient) Upgrade(resourceGroupName string, gatewayName string, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)

Upgrade upgrades a gateway. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName is the gateway name (256 characters maximum).

func (GatewayClient) UpgradePreparer

func (client GatewayClient) UpgradePreparer(resourceGroupName string, gatewayName string, cancel <-chan struct{}) (*http.Request, error)

UpgradePreparer prepares the Upgrade request.

func (GatewayClient) UpgradeResponder

func (client GatewayClient) UpgradeResponder(resp *http.Response) (result autorest.Response, err error)

UpgradeResponder handles the response to the Upgrade request. The method always closes the http.Response Body.

func (GatewayClient) UpgradeSender

func (client GatewayClient) UpgradeSender(req *http.Request) (*http.Response, error)

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

type GatewayExpandOption

type GatewayExpandOption string

GatewayExpandOption enumerates the values for gateway expand option.

const (
	// Status specifies the status state for gateway expand option.
	Status GatewayExpandOption = "status"
)

type GatewayParameters

type GatewayParameters struct {
	Location                     *string                 `json:"location,omitempty"`
	Tags                         *map[string]interface{} `json:"tags,omitempty"`
	*GatewayParametersProperties `json:"properties,omitempty"`
}

GatewayParameters is

type GatewayParametersProperties

type GatewayParametersProperties struct {
	AutoUpgrade AutoUpgrade `json:"autoUpgrade,omitempty"`
}

GatewayParametersProperties is

type GatewayProfile

type GatewayProfile struct {
	autorest.Response           `json:"-"`
	DataPlaneServiceBaseAddress *string `json:"dataPlaneServiceBaseAddress,omitempty"`
	GatewayID                   *string `json:"gatewayId,omitempty"`
	Environment                 *string `json:"environment,omitempty"`
	UpgradeManifestURL          *string `json:"upgradeManifestUrl,omitempty"`
	MessagingNamespace          *string `json:"messagingNamespace,omitempty"`
	MessagingAccount            *string `json:"messagingAccount,omitempty"`
	MessagingKey                *string `json:"messagingKey,omitempty"`
	RequestQueue                *string `json:"requestQueue,omitempty"`
	ResponseTopic               *string `json:"responseTopic,omitempty"`
	StatusBlobSignature         *string `json:"statusBlobSignature,omitempty"`
}

GatewayProfile is JSON properties that the gateway service uses know how to communicate with the resource.

type GatewayResource

type GatewayResource struct {
	autorest.Response          `json:"-"`
	ID                         *string             `json:"id,omitempty"`
	Type                       *string             `json:"type,omitempty"`
	Name                       *string             `json:"name,omitempty"`
	Location                   *string             `json:"location,omitempty"`
	Tags                       *map[string]*string `json:"tags,omitempty"`
	Etag                       *string             `json:"etag,omitempty"`
	*GatewayResourceProperties `json:"properties,omitempty"`
}

GatewayResource is

type GatewayResourceProperties

type GatewayResourceProperties struct {
	Created                   *date.Time       `json:"created,omitempty"`
	Updated                   *date.Time       `json:"updated,omitempty"`
	AutoUpgrade               AutoUpgrade      `json:"autoUpgrade,omitempty"`
	DesiredVersion            *string          `json:"desiredVersion,omitempty"`
	Instances                 *[]GatewayStatus `json:"instances,omitempty"`
	ActiveMessageCount        *int32           `json:"activeMessageCount,omitempty"`
	LatestPublishedMsiVersion *string          `json:"latestPublishedMsiVersion,omitempty"`
	PublishedTimeUtc          *date.Time       `json:"publishedTimeUtc,omitempty"`
}

GatewayResourceProperties is

type GatewayResources

type GatewayResources struct {
	autorest.Response `json:"-"`
	Value             *[]GatewayResource `json:"value,omitempty"`
	NextLink          *string            `json:"nextLink,omitempty"`
}

GatewayResources is collection of Gateway Resources.

func (GatewayResources) GatewayResourcesPreparer

func (client GatewayResources) GatewayResourcesPreparer() (*http.Request, error)

GatewayResourcesPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type GatewayStatus

type GatewayStatus struct {
	AvailableMemoryMByte         *float64   `json:"availableMemoryMByte,omitempty"`
	GatewayCPUUtilizationPercent *float64   `json:"gatewayCpuUtilizationPercent,omitempty"`
	TotalCPUUtilizationPercent   *float64   `json:"totalCpuUtilizationPercent,omitempty"`
	GatewayVersion               *string    `json:"gatewayVersion,omitempty"`
	FriendlyOsName               *string    `json:"friendlyOsName,omitempty"`
	InstalledDate                *date.Time `json:"installedDate,omitempty"`
	LogicalProcessorCount        *int32     `json:"logicalProcessorCount,omitempty"`
	Name                         *string    `json:"name,omitempty"`
	GatewayID                    *string    `json:"gatewayId,omitempty"`
	GatewayWorkingSetMByte       *float64   `json:"gatewayWorkingSetMByte,omitempty"`
	StatusUpdated                *date.Time `json:"statusUpdated,omitempty"`
}

GatewayStatus is expanded gateway status information.

type ManagementClient

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

ManagementClient is the base client for Servermanagement.

func New

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type NodeClient

type NodeClient struct {
	ManagementClient
}

NodeClient is the REST API for Azure Server Management Service.

func NewNodeClient

func NewNodeClient(subscriptionID string) NodeClient

NewNodeClient creates an instance of the NodeClient client.

func NewNodeClientWithBaseURI

func NewNodeClientWithBaseURI(baseURI string, subscriptionID string) NodeClient

NewNodeClientWithBaseURI creates an instance of the NodeClient client.

func (NodeClient) Create

func (client NodeClient) Create(resourceGroupName string, nodeName string, gatewayParameters NodeParameters, cancel <-chan struct{}) (<-chan NodeResource, <-chan error)

Create creates or updates a management node. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). gatewayParameters is parameters supplied to the CreateOrUpdate operation.

func (NodeClient) CreatePreparer

func (client NodeClient) CreatePreparer(resourceGroupName string, nodeName string, gatewayParameters NodeParameters, cancel <-chan struct{}) (*http.Request, error)

CreatePreparer prepares the Create request.

func (NodeClient) CreateResponder

func (client NodeClient) CreateResponder(resp *http.Response) (result NodeResource, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (NodeClient) CreateSender

func (client NodeClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (NodeClient) Delete

func (client NodeClient) Delete(resourceGroupName string, nodeName string) (result autorest.Response, err error)

Delete deletes a management node.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum).

func (NodeClient) DeletePreparer

func (client NodeClient) DeletePreparer(resourceGroupName string, nodeName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (NodeClient) DeleteResponder

func (client NodeClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (NodeClient) DeleteSender

func (client NodeClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (NodeClient) Get

func (client NodeClient) Get(resourceGroupName string, nodeName string) (result NodeResource, err error)

Get gets a management node.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum).

func (NodeClient) GetPreparer

func (client NodeClient) GetPreparer(resourceGroupName string, nodeName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (NodeClient) GetResponder

func (client NodeClient) GetResponder(resp *http.Response) (result NodeResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (NodeClient) GetSender

func (client NodeClient) GetSender(req *http.Request) (*http.Response, error)

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

func (NodeClient) List

func (client NodeClient) List() (result NodeResources, err error)

List lists nodes in a subscription.

func (NodeClient) ListComplete

func (client NodeClient) ListComplete(cancel <-chan struct{}) (<-chan NodeResource, <-chan error)

ListComplete gets all elements from the list without paging.

func (NodeClient) ListForResourceGroup

func (client NodeClient) ListForResourceGroup(resourceGroupName string) (result NodeResources, err error)

ListForResourceGroup lists nodes in a resource group.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId.

func (NodeClient) ListForResourceGroupComplete

func (client NodeClient) ListForResourceGroupComplete(resourceGroupName string, cancel <-chan struct{}) (<-chan NodeResource, <-chan error)

ListForResourceGroupComplete gets all elements from the list without paging.

func (NodeClient) ListForResourceGroupNextResults

func (client NodeClient) ListForResourceGroupNextResults(lastResults NodeResources) (result NodeResources, err error)

ListForResourceGroupNextResults retrieves the next set of results, if any.

func (NodeClient) ListForResourceGroupPreparer

func (client NodeClient) ListForResourceGroupPreparer(resourceGroupName string) (*http.Request, error)

ListForResourceGroupPreparer prepares the ListForResourceGroup request.

func (NodeClient) ListForResourceGroupResponder

func (client NodeClient) ListForResourceGroupResponder(resp *http.Response) (result NodeResources, err error)

ListForResourceGroupResponder handles the response to the ListForResourceGroup request. The method always closes the http.Response Body.

func (NodeClient) ListForResourceGroupSender

func (client NodeClient) ListForResourceGroupSender(req *http.Request) (*http.Response, error)

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

func (NodeClient) ListNextResults

func (client NodeClient) ListNextResults(lastResults NodeResources) (result NodeResources, err error)

ListNextResults retrieves the next set of results, if any.

func (NodeClient) ListPreparer

func (client NodeClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (NodeClient) ListResponder

func (client NodeClient) ListResponder(resp *http.Response) (result NodeResources, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (NodeClient) ListSender

func (client NodeClient) ListSender(req *http.Request) (*http.Response, error)

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

func (NodeClient) Update

func (client NodeClient) Update(resourceGroupName string, nodeName string, nodeParameters NodeParameters, cancel <-chan struct{}) (<-chan NodeResource, <-chan error)

Update updates a management node. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). nodeParameters is parameters supplied to the CreateOrUpdate operation.

func (NodeClient) UpdatePreparer

func (client NodeClient) UpdatePreparer(resourceGroupName string, nodeName string, nodeParameters NodeParameters, cancel <-chan struct{}) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (NodeClient) UpdateResponder

func (client NodeClient) UpdateResponder(resp *http.Response) (result NodeResource, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (NodeClient) UpdateSender

func (client NodeClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type NodeParameters

type NodeParameters struct {
	Location                  *string                 `json:"location,omitempty"`
	Tags                      *map[string]interface{} `json:"tags,omitempty"`
	*NodeParametersProperties `json:"properties,omitempty"`
}

NodeParameters is

type NodeParametersProperties

type NodeParametersProperties struct {
	GatewayID      *string `json:"gatewayId,omitempty"`
	ConnectionName *string `json:"connectionName,omitempty"`
	UserName       *string `json:"userName,omitempty"`
	Password       *string `json:"password,omitempty"`
}

NodeParametersProperties is

type NodeResource

type NodeResource struct {
	autorest.Response       `json:"-"`
	ID                      *string             `json:"id,omitempty"`
	Type                    *string             `json:"type,omitempty"`
	Name                    *string             `json:"name,omitempty"`
	Location                *string             `json:"location,omitempty"`
	Tags                    *map[string]*string `json:"tags,omitempty"`
	Etag                    *string             `json:"etag,omitempty"`
	*NodeResourceProperties `json:"properties,omitempty"`
}

NodeResource is a Node Resource.

type NodeResourceProperties

type NodeResourceProperties struct {
	GatewayID      *string    `json:"gatewayId,omitempty"`
	ConnectionName *string    `json:"connectionName,omitempty"`
	Created        *date.Time `json:"created,omitempty"`
	Updated        *date.Time `json:"updated,omitempty"`
}

NodeResourceProperties is

type NodeResources

type NodeResources struct {
	autorest.Response `json:"-"`
	Value             *[]NodeResource `json:"value,omitempty"`
	NextLink          *string         `json:"nextLink,omitempty"`
}

NodeResources is a collection of node resource objects.

func (NodeResources) NodeResourcesPreparer

func (client NodeResources) NodeResourcesPreparer() (*http.Request, error)

NodeResourcesPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type PowerShellClient

type PowerShellClient struct {
	ManagementClient
}

PowerShellClient is the REST API for Azure Server Management Service.

func NewPowerShellClient

func NewPowerShellClient(subscriptionID string) PowerShellClient

NewPowerShellClient creates an instance of the PowerShellClient client.

func NewPowerShellClientWithBaseURI

func NewPowerShellClientWithBaseURI(baseURI string, subscriptionID string) PowerShellClient

NewPowerShellClientWithBaseURI creates an instance of the PowerShellClient client.

func (PowerShellClient) CancelCommand

func (client PowerShellClient) CancelCommand(resourceGroupName string, nodeName string, session string, pssession string, cancel <-chan struct{}) (<-chan PowerShellCommandResults, <-chan error)

CancelCommand cancels a PowerShell command. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). session is the sessionId from the user. pssession is the PowerShell sessionId from the user.

func (PowerShellClient) CancelCommandPreparer

func (client PowerShellClient) CancelCommandPreparer(resourceGroupName string, nodeName string, session string, pssession string, cancel <-chan struct{}) (*http.Request, error)

CancelCommandPreparer prepares the CancelCommand request.

func (PowerShellClient) CancelCommandResponder

func (client PowerShellClient) CancelCommandResponder(resp *http.Response) (result PowerShellCommandResults, err error)

CancelCommandResponder handles the response to the CancelCommand request. The method always closes the http.Response Body.

func (PowerShellClient) CancelCommandSender

func (client PowerShellClient) CancelCommandSender(req *http.Request) (*http.Response, error)

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

func (PowerShellClient) CreateSession

func (client PowerShellClient) CreateSession(resourceGroupName string, nodeName string, session string, pssession string, cancel <-chan struct{}) (<-chan PowerShellSessionResource, <-chan error)

CreateSession creates a PowerShell session. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). session is the sessionId from the user. pssession is the PowerShell sessionId from the user.

func (PowerShellClient) CreateSessionPreparer

func (client PowerShellClient) CreateSessionPreparer(resourceGroupName string, nodeName string, session string, pssession string, cancel <-chan struct{}) (*http.Request, error)

CreateSessionPreparer prepares the CreateSession request.

func (PowerShellClient) CreateSessionResponder

func (client PowerShellClient) CreateSessionResponder(resp *http.Response) (result PowerShellSessionResource, err error)

CreateSessionResponder handles the response to the CreateSession request. The method always closes the http.Response Body.

func (PowerShellClient) CreateSessionSender

func (client PowerShellClient) CreateSessionSender(req *http.Request) (*http.Response, error)

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

func (PowerShellClient) GetCommandStatus

func (client PowerShellClient) GetCommandStatus(resourceGroupName string, nodeName string, session string, pssession string, expand PowerShellExpandOption) (result PowerShellCommandStatus, err error)

GetCommandStatus gets the status of a command.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). session is the sessionId from the user. pssession is the PowerShell sessionId from the user. expand is gets current output from an ongoing call.

func (PowerShellClient) GetCommandStatusPreparer

func (client PowerShellClient) GetCommandStatusPreparer(resourceGroupName string, nodeName string, session string, pssession string, expand PowerShellExpandOption) (*http.Request, error)

GetCommandStatusPreparer prepares the GetCommandStatus request.

func (PowerShellClient) GetCommandStatusResponder

func (client PowerShellClient) GetCommandStatusResponder(resp *http.Response) (result PowerShellCommandStatus, err error)

GetCommandStatusResponder handles the response to the GetCommandStatus request. The method always closes the http.Response Body.

func (PowerShellClient) GetCommandStatusSender

func (client PowerShellClient) GetCommandStatusSender(req *http.Request) (*http.Response, error)

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

func (PowerShellClient) InvokeCommand

func (client PowerShellClient) InvokeCommand(resourceGroupName string, nodeName string, session string, pssession string, powerShellCommandParameters PowerShellCommandParameters, cancel <-chan struct{}) (<-chan PowerShellCommandResults, <-chan error)

InvokeCommand creates a PowerShell script and invokes it. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). session is the sessionId from the user. pssession is the PowerShell sessionId from the user. powerShellCommandParameters is parameters supplied to the Invoke PowerShell Command operation.

func (PowerShellClient) InvokeCommandPreparer

func (client PowerShellClient) InvokeCommandPreparer(resourceGroupName string, nodeName string, session string, pssession string, powerShellCommandParameters PowerShellCommandParameters, cancel <-chan struct{}) (*http.Request, error)

InvokeCommandPreparer prepares the InvokeCommand request.

func (PowerShellClient) InvokeCommandResponder

func (client PowerShellClient) InvokeCommandResponder(resp *http.Response) (result PowerShellCommandResults, err error)

InvokeCommandResponder handles the response to the InvokeCommand request. The method always closes the http.Response Body.

func (PowerShellClient) InvokeCommandSender

func (client PowerShellClient) InvokeCommandSender(req *http.Request) (*http.Response, error)

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

func (PowerShellClient) ListSession

func (client PowerShellClient) ListSession(resourceGroupName string, nodeName string, session string) (result PowerShellSessionResources, err error)

ListSession gets a list of the active sessions.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). session is the sessionId from the user.

func (PowerShellClient) ListSessionPreparer

func (client PowerShellClient) ListSessionPreparer(resourceGroupName string, nodeName string, session string) (*http.Request, error)

ListSessionPreparer prepares the ListSession request.

func (PowerShellClient) ListSessionResponder

func (client PowerShellClient) ListSessionResponder(resp *http.Response) (result PowerShellSessionResources, err error)

ListSessionResponder handles the response to the ListSession request. The method always closes the http.Response Body.

func (PowerShellClient) ListSessionSender

func (client PowerShellClient) ListSessionSender(req *http.Request) (*http.Response, error)

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

func (PowerShellClient) TabCompletion

func (client PowerShellClient) TabCompletion(resourceGroupName string, nodeName string, session string, pssession string, powerShellTabCompletionParamters PowerShellTabCompletionParameters) (result PowerShellTabCompletionResults, err error)

TabCompletion gets tab completion values for a command.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). session is the sessionId from the user. pssession is the PowerShell sessionId from the user. powerShellTabCompletionParamters is parameters supplied to the tab completion call.

func (PowerShellClient) TabCompletionPreparer

func (client PowerShellClient) TabCompletionPreparer(resourceGroupName string, nodeName string, session string, pssession string, powerShellTabCompletionParamters PowerShellTabCompletionParameters) (*http.Request, error)

TabCompletionPreparer prepares the TabCompletion request.

func (PowerShellClient) TabCompletionResponder

func (client PowerShellClient) TabCompletionResponder(resp *http.Response) (result PowerShellTabCompletionResults, err error)

TabCompletionResponder handles the response to the TabCompletion request. The method always closes the http.Response Body.

func (PowerShellClient) TabCompletionSender

func (client PowerShellClient) TabCompletionSender(req *http.Request) (*http.Response, error)

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

func (PowerShellClient) UpdateCommand

func (client PowerShellClient) UpdateCommand(resourceGroupName string, nodeName string, session string, pssession string, cancel <-chan struct{}) (<-chan PowerShellCommandResults, <-chan error)

UpdateCommand updates a running PowerShell command with more data. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). session is the sessionId from the user. pssession is the PowerShell sessionId from the user.

func (PowerShellClient) UpdateCommandPreparer

func (client PowerShellClient) UpdateCommandPreparer(resourceGroupName string, nodeName string, session string, pssession string, cancel <-chan struct{}) (*http.Request, error)

UpdateCommandPreparer prepares the UpdateCommand request.

func (PowerShellClient) UpdateCommandResponder

func (client PowerShellClient) UpdateCommandResponder(resp *http.Response) (result PowerShellCommandResults, err error)

UpdateCommandResponder handles the response to the UpdateCommand request. The method always closes the http.Response Body.

func (PowerShellClient) UpdateCommandSender

func (client PowerShellClient) UpdateCommandSender(req *http.Request) (*http.Response, error)

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

type PowerShellCommandParameters

type PowerShellCommandParameters struct {
	*PowerShellCommandParametersProperties `json:"properties,omitempty"`
}

PowerShellCommandParameters is the parameters to a PowerShell script execution command.

type PowerShellCommandParametersProperties

type PowerShellCommandParametersProperties struct {
	Command *string `json:"command,omitempty"`
}

PowerShellCommandParametersProperties is

type PowerShellCommandResult

type PowerShellCommandResult struct {
	MessageType     *int32                    `json:"messageType,omitempty"`
	ForegroundColor *string                   `json:"foregroundColor,omitempty"`
	BackgroundColor *string                   `json:"backgroundColor,omitempty"`
	Value           *string                   `json:"value,omitempty"`
	Prompt          *string                   `json:"prompt,omitempty"`
	ExitCode        *int32                    `json:"exitCode,omitempty"`
	ID              *int32                    `json:"id,omitempty"`
	Caption         *string                   `json:"caption,omitempty"`
	Message         *string                   `json:"message,omitempty"`
	Descriptions    *[]PromptFieldDescription `json:"descriptions,omitempty"`
}

PowerShellCommandResult is

type PowerShellCommandResults

type PowerShellCommandResults struct {
	autorest.Response `json:"-"`
	Results           *[]PowerShellCommandResult `json:"results,omitempty"`
	Pssession         *string                    `json:"pssession,omitempty"`
	Command           *string                    `json:"command,omitempty"`
	Completed         *bool                      `json:"completed,omitempty"`
}

PowerShellCommandResults is a collection of results from a PowerShell command.

type PowerShellCommandStatus

type PowerShellCommandStatus struct {
	autorest.Response         `json:"-"`
	ID                        *string             `json:"id,omitempty"`
	Type                      *string             `json:"type,omitempty"`
	Name                      *string             `json:"name,omitempty"`
	Location                  *string             `json:"location,omitempty"`
	Tags                      *map[string]*string `json:"tags,omitempty"`
	Etag                      *string             `json:"etag,omitempty"`
	*PowerShellCommandResults `json:"properties,omitempty"`
}

PowerShellCommandStatus is

type PowerShellExpandOption

type PowerShellExpandOption string

PowerShellExpandOption enumerates the values for power shell expand option.

const (
	// Output specifies the output state for power shell expand option.
	Output PowerShellExpandOption = "output"
)

type PowerShellSessionResource

type PowerShellSessionResource struct {
	autorest.Response                    `json:"-"`
	ID                                   *string             `json:"id,omitempty"`
	Type                                 *string             `json:"type,omitempty"`
	Name                                 *string             `json:"name,omitempty"`
	Location                             *string             `json:"location,omitempty"`
	Tags                                 *map[string]*string `json:"tags,omitempty"`
	Etag                                 *string             `json:"etag,omitempty"`
	*PowerShellSessionResourceProperties `json:"properties,omitempty"`
}

PowerShellSessionResource is a PowerShell session resource (practically equivalent to a runspace instance).

type PowerShellSessionResourceProperties

type PowerShellSessionResourceProperties struct {
	SessionID            *string                  `json:"sessionId,omitempty"`
	State                *string                  `json:"state,omitempty"`
	RunspaceAvailability *string                  `json:"runspaceAvailability,omitempty"`
	DisconnectedOn       *date.Time               `json:"disconnectedOn,omitempty"`
	ExpiresOn            *date.Time               `json:"expiresOn,omitempty"`
	Version              *VersionServermanagement `json:"version,omitempty"`
	Name                 *string                  `json:"name,omitempty"`
}

PowerShellSessionResourceProperties is

type PowerShellSessionResources

type PowerShellSessionResources struct {
	autorest.Response `json:"-"`
	Value             *[]PowerShellSessionResource `json:"value,omitempty"`
	NextLink          *string                      `json:"nextLink,omitempty"`
}

PowerShellSessionResources is a collection of PowerShell session resources.

type PowerShellTabCompletionParameters

type PowerShellTabCompletionParameters struct {
	Command *string `json:"command,omitempty"`
}

PowerShellTabCompletionParameters is

type PowerShellTabCompletionResults

type PowerShellTabCompletionResults struct {
	autorest.Response `json:"-"`
	Results           *[]string `json:"results,omitempty"`
}

PowerShellTabCompletionResults is an array of strings representing the different values that can be selected through.

type PromptFieldDescription

type PromptFieldDescription struct {
	Name                  *string         `json:"name,omitempty"`
	Label                 *string         `json:"label,omitempty"`
	HelpMessage           *string         `json:"helpMessage,omitempty"`
	PromptFieldTypeIsList *bool           `json:"promptFieldTypeIsList,omitempty"`
	PromptFieldType       PromptFieldType `json:"promptFieldType,omitempty"`
}

PromptFieldDescription is field description for the implementation of PSHostUserInterface.Prompt.

type PromptFieldType

type PromptFieldType string

PromptFieldType enumerates the values for prompt field type.

const (
	// Credential specifies the credential state for prompt field type.
	Credential PromptFieldType = "Credential"
	// SecureString specifies the secure string state for prompt field type.
	SecureString PromptFieldType = "SecureString"
	// String specifies the string state for prompt field type.
	String PromptFieldType = "String"
)

type PromptMessageResponse

type PromptMessageResponse struct {
	Response *[]string `json:"response,omitempty"`
}

PromptMessageResponse is the response to a prompt message.

type Resource

type Resource struct {
	ID       *string             `json:"id,omitempty"`
	Type     *string             `json:"type,omitempty"`
	Name     *string             `json:"name,omitempty"`
	Location *string             `json:"location,omitempty"`
	Tags     *map[string]*string `json:"tags,omitempty"`
	Etag     *string             `json:"etag,omitempty"`
}

Resource is resource Manager Resource Information.

type SessionClient

type SessionClient struct {
	ManagementClient
}

SessionClient is the REST API for Azure Server Management Service.

func NewSessionClient

func NewSessionClient(subscriptionID string) SessionClient

NewSessionClient creates an instance of the SessionClient client.

func NewSessionClientWithBaseURI

func NewSessionClientWithBaseURI(baseURI string, subscriptionID string) SessionClient

NewSessionClientWithBaseURI creates an instance of the SessionClient client.

func (SessionClient) Create

func (client SessionClient) Create(resourceGroupName string, nodeName string, session string, sessionParameters SessionParameters, cancel <-chan struct{}) (<-chan SessionResource, <-chan error)

Create creates a session for a node. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). session is the sessionId from the user. sessionParameters is parameters supplied to the CreateOrUpdate operation.

func (SessionClient) CreatePreparer

func (client SessionClient) CreatePreparer(resourceGroupName string, nodeName string, session string, sessionParameters SessionParameters, cancel <-chan struct{}) (*http.Request, error)

CreatePreparer prepares the Create request.

func (SessionClient) CreateResponder

func (client SessionClient) CreateResponder(resp *http.Response) (result SessionResource, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (SessionClient) CreateSender

func (client SessionClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (SessionClient) Delete

func (client SessionClient) Delete(resourceGroupName string, nodeName string, session string) (result autorest.Response, err error)

Delete deletes a session for a node.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). session is the sessionId from the user.

func (SessionClient) DeletePreparer

func (client SessionClient) DeletePreparer(resourceGroupName string, nodeName string, session string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (SessionClient) DeleteResponder

func (client SessionClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (SessionClient) DeleteSender

func (client SessionClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (SessionClient) Get

func (client SessionClient) Get(resourceGroupName string, nodeName string, session string) (result SessionResource, err error)

Get gets a session for a node.

resourceGroupName is the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName is the node name (256 characters maximum). session is the sessionId from the user.

func (SessionClient) GetPreparer

func (client SessionClient) GetPreparer(resourceGroupName string, nodeName string, session string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SessionClient) GetResponder

func (client SessionClient) GetResponder(resp *http.Response) (result SessionResource, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SessionClient) GetSender

func (client SessionClient) GetSender(req *http.Request) (*http.Response, error)

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

type SessionParameters

type SessionParameters struct {
	*SessionParametersProperties `json:"properties,omitempty"`
}

SessionParameters is

type SessionParametersProperties

type SessionParametersProperties struct {
	UserName *string `json:"userName,omitempty"`
	Password *string `json:"password,omitempty"`
}

SessionParametersProperties is

type SessionResource

type SessionResource struct {
	autorest.Response          `json:"-"`
	ID                         *string             `json:"id,omitempty"`
	Type                       *string             `json:"type,omitempty"`
	Name                       *string             `json:"name,omitempty"`
	Location                   *string             `json:"location,omitempty"`
	Tags                       *map[string]*string `json:"tags,omitempty"`
	Etag                       *string             `json:"etag,omitempty"`
	*SessionResourceProperties `json:"properties,omitempty"`
}

SessionResource is the session object.

type SessionResourceProperties

type SessionResourceProperties struct {
	UserName *string    `json:"userName,omitempty"`
	Created  *date.Time `json:"created,omitempty"`
	Updated  *date.Time `json:"updated,omitempty"`
}

SessionResourceProperties is

type VersionServermanagement

type VersionServermanagement struct {
	Major         *int32 `json:"major,omitempty"`
	Minor         *int32 `json:"minor,omitempty"`
	Build         *int32 `json:"build,omitempty"`
	Revision      *int32 `json:"revision,omitempty"`
	MajorRevision *int32 `json:"majorRevision,omitempty"`
	MinorRevision *int32 `json:"minorRevision,omitempty"`
}

VersionServermanagement is a multipart-numeric version number.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL