servermanagement

package
v17.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jun 8, 2018 License: Apache-2.0 Imports: 9 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 ...
	Off AutoUpgrade = "Off"
	// On ...
	On AutoUpgrade = "On"
)

func PossibleAutoUpgradeValues 

func PossibleAutoUpgradeValues() []AutoUpgrade

PossibleAutoUpgradeValues returns an array of possible values for the AutoUpgrade const type.

type BaseClient 

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

BaseClient is the base client for Servermanagement.

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 Error 

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

Error error message.

type GatewayClient 

type GatewayClient struct {
	BaseClient
}

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(ctx context.Context, resourceGroupName string, gatewayName string, gatewayParameters GatewayParameters) (result GatewayCreateFuture, err error)

Create creates or updates a ManagementService gateway. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName - the gateway name (256 characters maximum). gatewayParameters - parameters supplied to the CreateOrUpdate operation.

func (GatewayClient) CreatePreparer 

func (client GatewayClient) CreatePreparer(ctx context.Context, resourceGroupName string, gatewayName string, gatewayParameters GatewayParameters) (*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) (future GatewayCreateFuture, err 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(ctx context.Context, resourceGroupName string, gatewayName string) (result autorest.Response, err error)

Delete deletes a gateway from a resource group. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName - the gateway name (256 characters maximum).

func (GatewayClient) DeletePreparer 

func (client GatewayClient) DeletePreparer(ctx context.Context, 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(ctx context.Context, resourceGroupName string, gatewayName string, expand GatewayExpandOption) (result GatewayResource, err error)

Get gets a gateway. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName - the gateway name (256 characters maximum). expand - 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(ctx context.Context, resourceGroupName string, gatewayName string, expand GatewayExpandOption) (*http.Request, error)

GetPreparer prepares the Get request.

func (GatewayClient) GetProfile 

func (client GatewayClient) GetProfile(ctx context.Context, resourceGroupName string, gatewayName string) (result GatewayGetProfileFuture, err error)

GetProfile gets a gateway profile. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName - the gateway name (256 characters maximum).

func (GatewayClient) GetProfilePreparer 

func (client GatewayClient) GetProfilePreparer(ctx context.Context, resourceGroupName string, gatewayName string) (*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) (future GatewayGetProfileFuture, err 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(ctx context.Context) (result GatewayResourcesPage, err error)

List lists gateways in a subscription.

func (GatewayClient) ListComplete 

func (client GatewayClient) ListComplete(ctx context.Context) (result GatewayResourcesIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (GatewayClient) ListForResourceGroup 

func (client GatewayClient) ListForResourceGroup(ctx context.Context, resourceGroupName string) (result GatewayResourcesPage, err error)

ListForResourceGroup returns gateways in a resource group. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId.

func (GatewayClient) ListForResourceGroupComplete 

func (client GatewayClient) ListForResourceGroupComplete(ctx context.Context, resourceGroupName string) (result GatewayResourcesIterator, err error)

ListForResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (GatewayClient) ListForResourceGroupPreparer 

func (client GatewayClient) ListForResourceGroupPreparer(ctx context.Context, 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) ListPreparer 

func (client GatewayClient) ListPreparer(ctx context.Context) (*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(ctx context.Context, resourceGroupName string, gatewayName string) (result GatewayRegenerateProfileFuture, err error)

RegenerateProfile regenerates a gateway's profile Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName - the gateway name (256 characters maximum).

func (GatewayClient) RegenerateProfilePreparer 

func (client GatewayClient) RegenerateProfilePreparer(ctx context.Context, resourceGroupName string, gatewayName string) (*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) (future GatewayRegenerateProfileFuture, err 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(ctx context.Context, resourceGroupName string, gatewayName string, gatewayParameters GatewayParameters) (result GatewayUpdateFuture, err error)

Update updates a gateway belonging to a resource group. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName - the gateway name (256 characters maximum). gatewayParameters - parameters supplied to the Update operation.

func (GatewayClient) UpdatePreparer 

func (client GatewayClient) UpdatePreparer(ctx context.Context, resourceGroupName string, gatewayName string, gatewayParameters GatewayParameters) (*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) (future GatewayUpdateFuture, err 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(ctx context.Context, resourceGroupName string, gatewayName string) (result GatewayUpgradeFuture, err error)

Upgrade upgrades a gateway. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. gatewayName - the gateway name (256 characters maximum).

func (GatewayClient) UpgradePreparer 

func (client GatewayClient) UpgradePreparer(ctx context.Context, resourceGroupName string, gatewayName string) (*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) (future GatewayUpgradeFuture, err error)

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

type GatewayCreateFuture 

type GatewayCreateFuture struct {
	azure.Future
}

GatewayCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GatewayCreateFuture) Result 

func (future *GatewayCreateFuture) Result(client GatewayClient) (gr GatewayResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type GatewayExpandOption 

type GatewayExpandOption string

GatewayExpandOption enumerates the values for gateway expand option. 

const (
	// Status ...
	Status GatewayExpandOption = "status"
)

func PossibleGatewayExpandOptionValues 

func PossibleGatewayExpandOptionValues() []GatewayExpandOption

PossibleGatewayExpandOptionValues returns an array of possible values for the GatewayExpandOption const type.

type GatewayGetProfileFuture 

type GatewayGetProfileFuture struct {
	azure.Future
}

GatewayGetProfileFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GatewayGetProfileFuture) Result 

func (future *GatewayGetProfileFuture) Result(client GatewayClient) (gp GatewayProfile, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type GatewayParameters 

type GatewayParameters struct {
	// Location - Location of the resource.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags                         interface{} `json:"tags,omitempty"`
	*GatewayParametersProperties `json:"properties,omitempty"`
}

GatewayParameters ...

func (GatewayParameters) MarshalJSON 

func (gp GatewayParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GatewayParameters.

func (*GatewayParameters) UnmarshalJSON 

func (gp *GatewayParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GatewayParameters struct.

type GatewayParametersProperties 

type GatewayParametersProperties struct {
	// AutoUpgrade - The autoUpgrade property gives the flexibility to gateway to auto upgrade itself. If properties value not specified, then we assume autoUpgrade = Off. Possible values include: 'On', 'Off'
	AutoUpgrade AutoUpgrade `json:"autoUpgrade,omitempty"`
}

GatewayParametersProperties ...

type GatewayProfile 

type GatewayProfile struct {
	autorest.Response `json:"-"`
	// DataPlaneServiceBaseAddress - The Dataplane connection URL.
	DataPlaneServiceBaseAddress *string `json:"dataPlaneServiceBaseAddress,omitempty"`
	// GatewayID - The ID of the gateway.
	GatewayID *string `json:"gatewayId,omitempty"`
	// Environment - The environment for the gateway (DEV, DogFood, or Production).
	Environment *string `json:"environment,omitempty"`
	// UpgradeManifestURL - Gateway upgrade manifest URL.
	UpgradeManifestURL *string `json:"upgradeManifestUrl,omitempty"`
	// MessagingNamespace - Messaging namespace.
	MessagingNamespace *string `json:"messagingNamespace,omitempty"`
	// MessagingAccount - Messaging Account.
	MessagingAccount *string `json:"messagingAccount,omitempty"`
	// MessagingKey - Messaging Key.
	MessagingKey *string `json:"messagingKey,omitempty"`
	// RequestQueue - Request queue name.
	RequestQueue *string `json:"requestQueue,omitempty"`
	// ResponseTopic - Response topic name.
	ResponseTopic *string `json:"responseTopic,omitempty"`
	// StatusBlobSignature - The gateway status blob SAS URL.
	StatusBlobSignature *string `json:"statusBlobSignature,omitempty"`
}

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

type GatewayRegenerateProfileFuture 

type GatewayRegenerateProfileFuture struct {
	azure.Future
}

GatewayRegenerateProfileFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GatewayRegenerateProfileFuture) Result 

func (future *GatewayRegenerateProfileFuture) Result(client GatewayClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type GatewayResource 

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

GatewayResource ...

func (GatewayResource) MarshalJSON 

func (gr GatewayResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GatewayResource.

func (*GatewayResource) UnmarshalJSON 

func (gr *GatewayResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GatewayResource struct.

type GatewayResourceProperties 

type GatewayResourceProperties struct {
	// Created - UTC date and time when gateway was first added to management service.
	Created *date.Time `json:"created,omitempty"`
	// Updated - UTC date and time when node was last updated.
	Updated *date.Time `json:"updated,omitempty"`
	// AutoUpgrade - Setting of the autoupgrade. Possible values include: 'On', 'Off'
	AutoUpgrade AutoUpgrade `json:"autoUpgrade,omitempty"`
	// DesiredVersion - Latest available MSI version.
	DesiredVersion *string `json:"desiredVersion,omitempty"`
	// Instances - Names of the nodes in the gateway.
	Instances *[]GatewayStatus `json:"instances,omitempty"`
	// ActiveMessageCount - number of active messages
	ActiveMessageCount *int32 `json:"activeMessageCount,omitempty"`
	// LatestPublishedMsiVersion - Last published MSI version.
	LatestPublishedMsiVersion *string `json:"latestPublishedMsiVersion,omitempty"`
	// PublishedTimeUtc - The date/time of the last published gateway.
	PublishedTimeUtc *date.Time `json:"publishedTimeUtc,omitempty"`
}

GatewayResourceProperties ...

type GatewayResources 

type GatewayResources struct {
	autorest.Response `json:"-"`
	// Value - Collection of Gateway Resources.
	Value *[]GatewayResource `json:"value,omitempty"`
	// NextLink - The URL to the next set of resources.
	NextLink *string `json:"nextLink,omitempty"`
}

GatewayResources collection of Gateway Resources.

func (GatewayResources) IsEmpty 

func (gr GatewayResources) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type GatewayResourcesIterator 

type GatewayResourcesIterator struct {
	// contains filtered or unexported fields
}

GatewayResourcesIterator provides access to a complete listing of GatewayResource values.

func (*GatewayResourcesIterator) Next 

func (iter *GatewayResourcesIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (GatewayResourcesIterator) NotDone 

func (iter GatewayResourcesIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (GatewayResourcesIterator) Response 

func (iter GatewayResourcesIterator) Response() GatewayResources

Response returns the raw server response from the last page request.

func (GatewayResourcesIterator) Value 

func (iter GatewayResourcesIterator) Value() GatewayResource

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type GatewayResourcesPage 

type GatewayResourcesPage struct {
	// contains filtered or unexported fields
}

GatewayResourcesPage contains a page of GatewayResource values.

func (*GatewayResourcesPage) Next 

func (page *GatewayResourcesPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (GatewayResourcesPage) NotDone 

func (page GatewayResourcesPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (GatewayResourcesPage) Response 

func (page GatewayResourcesPage) Response() GatewayResources

Response returns the raw server response from the last page request.

func (GatewayResourcesPage) Values 

func (page GatewayResourcesPage) Values() []GatewayResource

Values returns the slice of values for the current page or nil if there are no values.

type GatewayStatus 

type GatewayStatus struct {
	// AvailableMemoryMByte - The available memory on the gateway host machine in megabytes.
	AvailableMemoryMByte *float64 `json:"availableMemoryMByte,omitempty"`
	// GatewayCPUUtilizationPercent - The CPU utilization of the gateway process (numeric value between 0 and 100).
	GatewayCPUUtilizationPercent *float64 `json:"gatewayCpuUtilizationPercent,omitempty"`
	// TotalCPUUtilizationPercent - CPU Utilization of the whole system.
	TotalCPUUtilizationPercent *float64 `json:"totalCpuUtilizationPercent,omitempty"`
	// GatewayVersion - The version of the gateway that is installed on the system.
	GatewayVersion *string `json:"gatewayVersion,omitempty"`
	// FriendlyOsName - The Plaintext description of the OS on the gateway.
	FriendlyOsName *string `json:"friendlyOsName,omitempty"`
	// InstalledDate - The date the gateway was installed.
	InstalledDate *date.Time `json:"installedDate,omitempty"`
	// LogicalProcessorCount - Number of logical processors in the gateway system.
	LogicalProcessorCount *int32 `json:"logicalProcessorCount,omitempty"`
	// Name - The computer name of the gateway system.
	Name *string `json:"name,omitempty"`
	// GatewayID - The gateway resource ID.
	GatewayID *string `json:"gatewayId,omitempty"`
	// GatewayWorkingSetMByte - The working set size of the gateway process in megabytes.
	GatewayWorkingSetMByte *float64 `json:"gatewayWorkingSetMByte,omitempty"`
	// StatusUpdated - UTC date and time when gateway status was last updated.
	StatusUpdated *date.Time `json:"statusUpdated,omitempty"`
}

GatewayStatus expanded gateway status information.

type GatewayUpdateFuture 

type GatewayUpdateFuture struct {
	azure.Future
}

GatewayUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GatewayUpdateFuture) Result 

func (future *GatewayUpdateFuture) Result(client GatewayClient) (gr GatewayResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type GatewayUpgradeFuture 

type GatewayUpgradeFuture struct {
	azure.Future
}

GatewayUpgradeFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*GatewayUpgradeFuture) Result 

func (future *GatewayUpgradeFuture) Result(client GatewayClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type NodeClient 

type NodeClient struct {
	BaseClient
}

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(ctx context.Context, resourceGroupName string, nodeName string, gatewayParameters NodeParameters) (result NodeCreateFuture, err error)

Create creates or updates a management node. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). gatewayParameters - parameters supplied to the CreateOrUpdate operation.

func (NodeClient) CreatePreparer 

func (client NodeClient) CreatePreparer(ctx context.Context, resourceGroupName string, nodeName string, gatewayParameters NodeParameters) (*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) (future NodeCreateFuture, err 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(ctx context.Context, resourceGroupName string, nodeName string) (result autorest.Response, err error)

Delete deletes a management node. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum).

func (NodeClient) DeletePreparer 

func (client NodeClient) DeletePreparer(ctx context.Context, 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(ctx context.Context, resourceGroupName string, nodeName string) (result NodeResource, err error)

Get gets a management node. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum).

func (NodeClient) GetPreparer 

func (client NodeClient) GetPreparer(ctx context.Context, 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(ctx context.Context) (result NodeResourcesPage, err error)

List lists nodes in a subscription.

func (NodeClient) ListComplete 

func (client NodeClient) ListComplete(ctx context.Context) (result NodeResourcesIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (NodeClient) ListForResourceGroup 

func (client NodeClient) ListForResourceGroup(ctx context.Context, resourceGroupName string) (result NodeResourcesPage, err error)

ListForResourceGroup lists nodes in a resource group. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId.

func (NodeClient) ListForResourceGroupComplete 

func (client NodeClient) ListForResourceGroupComplete(ctx context.Context, resourceGroupName string) (result NodeResourcesIterator, err error)

ListForResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (NodeClient) ListForResourceGroupPreparer 

func (client NodeClient) ListForResourceGroupPreparer(ctx context.Context, 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) ListPreparer 

func (client NodeClient) ListPreparer(ctx context.Context) (*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(ctx context.Context, resourceGroupName string, nodeName string, nodeParameters NodeParameters) (result NodeUpdateFuture, err error)

Update updates a management node. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). nodeParameters - parameters supplied to the CreateOrUpdate operation.

func (NodeClient) UpdatePreparer 

func (client NodeClient) UpdatePreparer(ctx context.Context, resourceGroupName string, nodeName string, nodeParameters NodeParameters) (*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) (future NodeUpdateFuture, err error)

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

type NodeCreateFuture 

type NodeCreateFuture struct {
	azure.Future
}

NodeCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*NodeCreateFuture) Result 

func (future *NodeCreateFuture) Result(client NodeClient) (nr NodeResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type NodeParameters 

type NodeParameters struct {
	// Location - Location of the resource.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags                      interface{} `json:"tags,omitempty"`
	*NodeParametersProperties `json:"properties,omitempty"`
}

NodeParameters ...

func (NodeParameters) MarshalJSON 

func (np NodeParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for NodeParameters.

func (*NodeParameters) UnmarshalJSON 

func (np *NodeParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for NodeParameters struct.

type NodeParametersProperties 

type NodeParametersProperties struct {
	// GatewayID - Gateway ID which will manage this node.
	GatewayID *string `json:"gatewayId,omitempty"`
	// ConnectionName - myhost.domain.com
	ConnectionName *string `json:"connectionName,omitempty"`
	// UserName - User name to be used to connect to node.
	UserName *string `json:"userName,omitempty"`
	// Password - Password associated with user name.
	Password *string `json:"password,omitempty"`
}

NodeParametersProperties ...

type NodeResource 

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

NodeResource a Node Resource.

func (NodeResource) MarshalJSON 

func (nr NodeResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for NodeResource.

func (*NodeResource) UnmarshalJSON 

func (nr *NodeResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for NodeResource struct.

type NodeResourceProperties 

type NodeResourceProperties struct {
	// GatewayID - ID of the gateway.
	GatewayID *string `json:"gatewayId,omitempty"`
	// ConnectionName - myhost.domain.com
	ConnectionName *string `json:"connectionName,omitempty"`
	// Created - UTC date and time when node was first added to management service.
	Created *date.Time `json:"created,omitempty"`
	// Updated - UTC date and time when node was last updated.
	Updated *date.Time `json:"updated,omitempty"`
}

NodeResourceProperties ...

type NodeResources 

type NodeResources struct {
	autorest.Response `json:"-"`
	// Value - Collection of Node Resources.
	Value *[]NodeResource `json:"value,omitempty"`
	// NextLink - The URL to the next set of resources.
	NextLink *string `json:"nextLink,omitempty"`
}

NodeResources a collection of node resource objects.

func (NodeResources) IsEmpty 

func (nr NodeResources) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type NodeResourcesIterator 

type NodeResourcesIterator struct {
	// contains filtered or unexported fields
}

NodeResourcesIterator provides access to a complete listing of NodeResource values.

func (*NodeResourcesIterator) Next 

func (iter *NodeResourcesIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (NodeResourcesIterator) NotDone 

func (iter NodeResourcesIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (NodeResourcesIterator) Response 

func (iter NodeResourcesIterator) Response() NodeResources

Response returns the raw server response from the last page request.

func (NodeResourcesIterator) Value 

func (iter NodeResourcesIterator) Value() NodeResource

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type NodeResourcesPage 

type NodeResourcesPage struct {
	// contains filtered or unexported fields
}

NodeResourcesPage contains a page of NodeResource values.

func (*NodeResourcesPage) Next 

func (page *NodeResourcesPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (NodeResourcesPage) NotDone 

func (page NodeResourcesPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (NodeResourcesPage) Response 

func (page NodeResourcesPage) Response() NodeResources

Response returns the raw server response from the last page request.

func (NodeResourcesPage) Values 

func (page NodeResourcesPage) Values() []NodeResource

Values returns the slice of values for the current page or nil if there are no values.

type NodeUpdateFuture 

type NodeUpdateFuture struct {
	azure.Future
}

NodeUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*NodeUpdateFuture) Result 

func (future *NodeUpdateFuture) Result(client NodeClient) (nr NodeResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PowerShellCancelCommandFuture 

type PowerShellCancelCommandFuture struct {
	azure.Future
}

PowerShellCancelCommandFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PowerShellCancelCommandFuture) Result 

func (future *PowerShellCancelCommandFuture) Result(client PowerShellClient) (pscr PowerShellCommandResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PowerShellClient 

type PowerShellClient struct {
	BaseClient
}

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(ctx context.Context, resourceGroupName string, nodeName string, session string, pssession string) (result PowerShellCancelCommandFuture, err error)

CancelCommand cancels a PowerShell command. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). session - the sessionId from the user. pssession - the PowerShell sessionId from the user.

func (PowerShellClient) CancelCommandPreparer 

func (client PowerShellClient) CancelCommandPreparer(ctx context.Context, resourceGroupName string, nodeName string, session string, pssession string) (*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) (future PowerShellCancelCommandFuture, err 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(ctx context.Context, resourceGroupName string, nodeName string, session string, pssession string) (result PowerShellCreateSessionFuture, err error)

CreateSession creates a PowerShell session. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). session - the sessionId from the user. pssession - the PowerShell sessionId from the user.

func (PowerShellClient) CreateSessionPreparer 

func (client PowerShellClient) CreateSessionPreparer(ctx context.Context, resourceGroupName string, nodeName string, session string, pssession string) (*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) (future PowerShellCreateSessionFuture, err 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(ctx context.Context, resourceGroupName string, nodeName string, session string, pssession string, expand PowerShellExpandOption) (result PowerShellCommandStatus, err error)

GetCommandStatus gets the status of a command. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). session - the sessionId from the user. pssession - the PowerShell sessionId from the user. expand - gets current output from an ongoing call.

func (PowerShellClient) GetCommandStatusPreparer 

func (client PowerShellClient) GetCommandStatusPreparer(ctx context.Context, 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(ctx context.Context, resourceGroupName string, nodeName string, session string, pssession string, powerShellCommandParameters PowerShellCommandParameters) (result PowerShellInvokeCommandFuture, err error)

InvokeCommand creates a PowerShell script and invokes it. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). session - the sessionId from the user. pssession - the PowerShell sessionId from the user. powerShellCommandParameters - parameters supplied to the Invoke PowerShell Command operation.

func (PowerShellClient) InvokeCommandPreparer 

func (client PowerShellClient) InvokeCommandPreparer(ctx context.Context, resourceGroupName string, nodeName string, session string, pssession string, powerShellCommandParameters PowerShellCommandParameters) (*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) (future PowerShellInvokeCommandFuture, err 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(ctx context.Context, resourceGroupName string, nodeName string, session string) (result PowerShellSessionResources, err error)

ListSession gets a list of the active sessions. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). session - the sessionId from the user.

func (PowerShellClient) ListSessionPreparer 

func (client PowerShellClient) ListSessionPreparer(ctx context.Context, 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(ctx context.Context, resourceGroupName string, nodeName string, session string, pssession string, powerShellTabCompletionParamters PowerShellTabCompletionParameters) (result PowerShellTabCompletionResults, err error)

TabCompletion gets tab completion values for a command. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). session - the sessionId from the user. pssession - the PowerShell sessionId from the user. powerShellTabCompletionParamters - parameters supplied to the tab completion call.

func (PowerShellClient) TabCompletionPreparer 

func (client PowerShellClient) TabCompletionPreparer(ctx context.Context, 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(ctx context.Context, resourceGroupName string, nodeName string, session string, pssession string) (result PowerShellUpdateCommandFuture, err error)

UpdateCommand updates a running PowerShell command with more data. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). session - the sessionId from the user. pssession - the PowerShell sessionId from the user.

func (PowerShellClient) UpdateCommandPreparer 

func (client PowerShellClient) UpdateCommandPreparer(ctx context.Context, resourceGroupName string, nodeName string, session string, pssession string) (*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) (future PowerShellUpdateCommandFuture, err 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 the parameters to a PowerShell script execution command.

func (PowerShellCommandParameters) MarshalJSON 

func (pscp PowerShellCommandParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PowerShellCommandParameters.

func (*PowerShellCommandParameters) UnmarshalJSON 

func (pscp *PowerShellCommandParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PowerShellCommandParameters struct.

type PowerShellCommandParametersProperties 

type PowerShellCommandParametersProperties struct {
	// Command - Script to execute.
	Command *string `json:"command,omitempty"`
}

PowerShellCommandParametersProperties ...

type PowerShellCommandResult 

type PowerShellCommandResult struct {
	// MessageType - The type of message.
	MessageType *int32 `json:"messageType,omitempty"`
	// ForegroundColor - The HTML color string representing the foreground color.
	ForegroundColor *string `json:"foregroundColor,omitempty"`
	// BackgroundColor - The HTML color string representing the background color.
	BackgroundColor *string `json:"backgroundColor,omitempty"`
	// Value - Actual result text from the PowerShell Command.
	Value *string `json:"value,omitempty"`
	// Prompt - The interactive prompt message.
	Prompt *string `json:"prompt,omitempty"`
	// ExitCode - The exit code from a executable that was called from PowerShell.
	ExitCode *int32 `json:"exitCode,omitempty"`
	// ID - ID of the prompt message.
	ID *int32 `json:"id,omitempty"`
	// Caption - Text that precedes the prompt.
	Caption *string `json:"caption,omitempty"`
	// Message - Text of the prompt.
	Message *string `json:"message,omitempty"`
	// Descriptions - Collection of PromptFieldDescription objects that contains the user input
	Descriptions *[]PromptFieldDescription `json:"descriptions,omitempty"`
}

PowerShellCommandResult ...

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 a collection of results from a PowerShell command.

type PowerShellCommandStatus 

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

PowerShellCommandStatus ...

func (PowerShellCommandStatus) MarshalJSON 

func (pscs PowerShellCommandStatus) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PowerShellCommandStatus.

func (*PowerShellCommandStatus) UnmarshalJSON 

func (pscs *PowerShellCommandStatus) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PowerShellCommandStatus struct.

type PowerShellCreateSessionFuture 

type PowerShellCreateSessionFuture struct {
	azure.Future
}

PowerShellCreateSessionFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PowerShellCreateSessionFuture) Result 

func (future *PowerShellCreateSessionFuture) Result(client PowerShellClient) (pssr PowerShellSessionResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PowerShellExpandOption 

type PowerShellExpandOption string

PowerShellExpandOption enumerates the values for power shell expand option. 

const (
	// Output ...
	Output PowerShellExpandOption = "output"
)

func PossiblePowerShellExpandOptionValues 

func PossiblePowerShellExpandOptionValues() []PowerShellExpandOption

PossiblePowerShellExpandOptionValues returns an array of possible values for the PowerShellExpandOption const type.

type PowerShellInvokeCommandFuture 

type PowerShellInvokeCommandFuture struct {
	azure.Future
}

PowerShellInvokeCommandFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PowerShellInvokeCommandFuture) Result 

func (future *PowerShellInvokeCommandFuture) Result(client PowerShellClient) (pscr PowerShellCommandResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PowerShellSessionResource 

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

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

func (PowerShellSessionResource) MarshalJSON 

func (pssr PowerShellSessionResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PowerShellSessionResource.

func (*PowerShellSessionResource) UnmarshalJSON 

func (pssr *PowerShellSessionResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PowerShellSessionResource struct.

type PowerShellSessionResourceProperties 

type PowerShellSessionResourceProperties struct {
	// SessionID - The PowerShell Session ID.
	SessionID *string `json:"sessionId,omitempty"`
	// State - The runspace state.
	State *string `json:"state,omitempty"`
	// RunspaceAvailability - The availability of the runspace.
	RunspaceAvailability *string `json:"runspaceAvailability,omitempty"`
	// DisconnectedOn - Timestamp of last time the service disconnected from the runspace.
	DisconnectedOn *date.Time `json:"disconnectedOn,omitempty"`
	// ExpiresOn - Timestamp when the runspace expires.
	ExpiresOn *date.Time               `json:"expiresOn,omitempty"`
	Version   *VersionServermanagement `json:"version,omitempty"`
	// Name - Name of the runspace.
	Name *string `json:"name,omitempty"`
}

PowerShellSessionResourceProperties ...

type PowerShellSessionResources 

type PowerShellSessionResources struct {
	autorest.Response `json:"-"`
	// Value - Collection of PowerShell session resources.
	Value *[]PowerShellSessionResource `json:"value,omitempty"`
	// NextLink - The URL to the next set of resources.
	NextLink *string `json:"nextLink,omitempty"`
}

PowerShellSessionResources a collection of PowerShell session resources.

type PowerShellTabCompletionParameters 

type PowerShellTabCompletionParameters struct {
	// Command - Command to get tab completion for.
	Command *string `json:"command,omitempty"`
}

PowerShellTabCompletionParameters ...

type PowerShellTabCompletionResults 

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

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

type PowerShellUpdateCommandFuture 

type PowerShellUpdateCommandFuture struct {
	azure.Future
}

PowerShellUpdateCommandFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*PowerShellUpdateCommandFuture) Result 

func (future *PowerShellUpdateCommandFuture) Result(client PowerShellClient) (pscr PowerShellCommandResults, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PromptFieldDescription 

type PromptFieldDescription struct {
	// Name - The name of the prompt.
	Name *string `json:"name,omitempty"`
	// Label - The label text of the prompt.
	Label *string `json:"label,omitempty"`
	// HelpMessage - The help message of the prompt.
	HelpMessage *string `json:"helpMessage,omitempty"`
	// PromptFieldTypeIsList - When set to 'true' the prompt field type is a list of values.
	PromptFieldTypeIsList *bool `json:"promptFieldTypeIsList,omitempty"`
	// PromptFieldType - Possible values include: 'String', 'SecureString', 'Credential'
	PromptFieldType PromptFieldType `json:"promptFieldType,omitempty"`
}

PromptFieldDescription field description for the implementation of PSHostUserInterface.Prompt.

type PromptFieldType 

type PromptFieldType string

PromptFieldType enumerates the values for prompt field type. 

const (
	// Credential ...
	Credential PromptFieldType = "Credential"
	// SecureString ...
	SecureString PromptFieldType = "SecureString"
	// String ...
	String PromptFieldType = "String"
)

func PossiblePromptFieldTypeValues 

func PossiblePromptFieldTypeValues() []PromptFieldType

PossiblePromptFieldTypeValues returns an array of possible values for the PromptFieldType const type.

type PromptMessageResponse 

type PromptMessageResponse struct {
	// Response - The list of responses a cmdlet expects.
	Response *[]string `json:"response,omitempty"`
}

PromptMessageResponse the response to a prompt message.

type Resource 

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

Resource resource Manager Resource Information.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type SessionClient 

type SessionClient struct {
	BaseClient
}

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(ctx context.Context, resourceGroupName string, nodeName string, session string, sessionParameters SessionParameters) (result SessionCreateFuture, err error)

Create creates a session for a node. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). session - the sessionId from the user. sessionParameters - parameters supplied to the CreateOrUpdate operation.

func (SessionClient) CreatePreparer 

func (client SessionClient) CreatePreparer(ctx context.Context, resourceGroupName string, nodeName string, session string, sessionParameters SessionParameters) (*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) (future SessionCreateFuture, err 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(ctx context.Context, resourceGroupName string, nodeName string, session string) (result autorest.Response, err error)

Delete deletes a session for a node. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). session - the sessionId from the user.

func (SessionClient) DeletePreparer 

func (client SessionClient) DeletePreparer(ctx context.Context, 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(ctx context.Context, resourceGroupName string, nodeName string, session string) (result SessionResource, err error)

Get gets a session for a node. Parameters: resourceGroupName - the resource group name uniquely identifies the resource group within the user subscriptionId. nodeName - the node name (256 characters maximum). session - the sessionId from the user.

func (SessionClient) GetPreparer 

func (client SessionClient) GetPreparer(ctx context.Context, 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 SessionCreateFuture 

type SessionCreateFuture struct {
	azure.Future
}

SessionCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*SessionCreateFuture) Result 

func (future *SessionCreateFuture) Result(client SessionClient) (sr SessionResource, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type SessionParameters 

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

SessionParameters ...

func (SessionParameters) MarshalJSON 

func (sp SessionParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SessionParameters.

func (*SessionParameters) UnmarshalJSON 

func (sp *SessionParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SessionParameters struct.

type SessionParametersProperties 

type SessionParametersProperties struct {
	// UserName - User name to be used to connect to node.
	UserName *string `json:"userName,omitempty"`
	// Password - Password associated with user name.
	Password *string `json:"password,omitempty"`
}

SessionParametersProperties ...

type SessionResource 

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

SessionResource the session object.

func (SessionResource) MarshalJSON 

func (sr SessionResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SessionResource.

func (*SessionResource) UnmarshalJSON 

func (sr *SessionResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SessionResource struct.

type SessionResourceProperties 

type SessionResourceProperties struct {
	// UserName - The username connecting to the session.
	UserName *string `json:"userName,omitempty"`
	// Created - UTC date and time when node was first added to management service.
	Created *date.Time `json:"created,omitempty"`
	// Updated - UTC date and time when node was last updated.
	Updated *date.Time `json:"updated,omitempty"`
}

SessionResourceProperties ...

type VersionServermanagement 

type VersionServermanagement struct {
	// Major - The leftmost number of the version.
	Major *int32 `json:"major,omitempty"`
	// Minor - The second leftmost number of the version.
	Minor *int32 `json:"minor,omitempty"`
	// Build - The third number of the version.
	Build *int32 `json:"build,omitempty"`
	// Revision - The fourth number of the version.
	Revision *int32 `json:"revision,omitempty"`
	// MajorRevision - The MSW of the fourth part.
	MajorRevision *int32 `json:"majorRevision,omitempty"`
	// MinorRevision - The LSW of the fourth part.
	MinorRevision *int32 `json:"minorRevision,omitempty"`
}

VersionServermanagement a multipart-numeric version number.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.