compute

package
Version: v32.6.0 Latest Latest
Warning

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

Go to latest
Published: Aug 27, 2019 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package compute implements the Azure ARM Compute service API version .

Compute Client

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Compute
	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 APIEntityReference

type APIEntityReference struct {
	// ID - The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
	ID *string `json:"id,omitempty"`
}

APIEntityReference the API entity reference.

type APIError

type APIError struct {
	// Details - The Api error details
	Details *[]APIErrorBase `json:"details,omitempty"`
	// Innererror - The Api inner error
	Innererror *InnerError `json:"innererror,omitempty"`
	// Code - The error code.
	Code *string `json:"code,omitempty"`
	// Target - The target of the particular error.
	Target *string `json:"target,omitempty"`
	// Message - The error message.
	Message *string `json:"message,omitempty"`
}

APIError api error.

type APIErrorBase

type APIErrorBase struct {
	// Code - The error code.
	Code *string `json:"code,omitempty"`
	// Target - The target of the particular error.
	Target *string `json:"target,omitempty"`
	// Message - The error message.
	Message *string `json:"message,omitempty"`
}

APIErrorBase api error base.

type AccessLevel

type AccessLevel string

AccessLevel enumerates the values for access level.

const (
	// None ...
	None AccessLevel = "None"
	// Read ...
	Read AccessLevel = "Read"
)

func PossibleAccessLevelValues

func PossibleAccessLevelValues() []AccessLevel

PossibleAccessLevelValues returns an array of possible values for the AccessLevel const type.

type AccessURI

type AccessURI struct {
	autorest.Response `json:"-"`
	// AccessSAS - READ-ONLY; A SAS uri for accessing a disk.
	AccessSAS *string `json:"accessSAS,omitempty"`
}

AccessURI a disk access SAS uri.

type AdditionalCapabilities

type AdditionalCapabilities struct {
	// UltraSSDEnabled - The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.
	UltraSSDEnabled *bool `json:"ultraSSDEnabled,omitempty"`
}

AdditionalCapabilities enables or disables a capability on the virtual machine or virtual machine scale set.

type AdditionalUnattendContent

type AdditionalUnattendContent struct {
	// PassName - The pass name. Currently, the only allowable value is OobeSystem. Possible values include: 'OobeSystem'
	PassName PassNames `json:"passName,omitempty"`
	// ComponentName - The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. Possible values include: 'MicrosoftWindowsShellSetup'
	ComponentName ComponentNames `json:"componentName,omitempty"`
	// SettingName - Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Possible values include: 'AutoLogon', 'FirstLogonCommands'
	SettingName SettingNames `json:"settingName,omitempty"`
	// Content - Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
	Content *string `json:"content,omitempty"`
}

AdditionalUnattendContent specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

type AggregatedReplicationState

type AggregatedReplicationState string

AggregatedReplicationState enumerates the values for aggregated replication state.

const (
	// Completed ...
	Completed AggregatedReplicationState = "Completed"
	// Failed ...
	Failed AggregatedReplicationState = "Failed"
	// InProgress ...
	InProgress AggregatedReplicationState = "InProgress"
	// Unknown ...
	Unknown AggregatedReplicationState = "Unknown"
)

func PossibleAggregatedReplicationStateValues

func PossibleAggregatedReplicationStateValues() []AggregatedReplicationState

PossibleAggregatedReplicationStateValues returns an array of possible values for the AggregatedReplicationState const type.

type AutomaticOSUpgradePolicy

type AutomaticOSUpgradePolicy struct {
	// EnableAutomaticOSUpgrade - Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, recommendation is to set [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) to false.
	EnableAutomaticOSUpgrade *bool `json:"enableAutomaticOSUpgrade,omitempty"`
	// DisableAutomaticRollback - Whether OS image rollback feature should be disabled. Default value is false.
	DisableAutomaticRollback *bool `json:"disableAutomaticRollback,omitempty"`
}

AutomaticOSUpgradePolicy the configuration parameters used for performing automatic OS upgrade.

type AutomaticOSUpgradeProperties

type AutomaticOSUpgradeProperties struct {
	// AutomaticOSUpgradeSupported - Specifies whether automatic OS upgrade is supported on the image.
	AutomaticOSUpgradeSupported *bool `json:"automaticOSUpgradeSupported,omitempty"`
}

AutomaticOSUpgradeProperties describes automatic OS upgrade properties on the image.

type AvailabilitySet

type AvailabilitySet struct {
	autorest.Response          `json:"-"`
	*AvailabilitySetProperties `json:"properties,omitempty"`
	// Sku - Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.
	Sku *Sku `json:"sku,omitempty"`
	// ID - READ-ONLY; Resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

AvailabilitySet specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

func (AvailabilitySet) MarshalJSON

func (as AvailabilitySet) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AvailabilitySet.

func (*AvailabilitySet) UnmarshalJSON

func (as *AvailabilitySet) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AvailabilitySet struct.

type AvailabilitySetListResult

type AvailabilitySetListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of availability sets
	Value *[]AvailabilitySet `json:"value,omitempty"`
	// NextLink - The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets.
	NextLink *string `json:"nextLink,omitempty"`
}

AvailabilitySetListResult the List Availability Set operation response.

func (AvailabilitySetListResult) IsEmpty

func (aslr AvailabilitySetListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AvailabilitySetListResultIterator

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

AvailabilitySetListResultIterator provides access to a complete listing of AvailabilitySet values.

func NewAvailabilitySetListResultIterator

func NewAvailabilitySetListResultIterator(page AvailabilitySetListResultPage) AvailabilitySetListResultIterator

Creates a new instance of the AvailabilitySetListResultIterator type.

func (*AvailabilitySetListResultIterator) Next deprecated

This method has been deprecated.

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AvailabilitySetListResultIterator) NextWithContext

func (iter *AvailabilitySetListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (AvailabilitySetListResultIterator) NotDone

func (iter AvailabilitySetListResultIterator) NotDone() bool

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

func (AvailabilitySetListResultIterator) Response

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

func (AvailabilitySetListResultIterator) Value

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

type AvailabilitySetListResultPage

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

AvailabilitySetListResultPage contains a page of AvailabilitySet values.

func NewAvailabilitySetListResultPage

func NewAvailabilitySetListResultPage(getNextPage func(context.Context, AvailabilitySetListResult) (AvailabilitySetListResult, error)) AvailabilitySetListResultPage

Creates a new instance of the AvailabilitySetListResultPage type.

func (*AvailabilitySetListResultPage) Next deprecated

This method has been deprecated.
func (page *AvailabilitySetListResultPage) 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. Deprecated: Use NextWithContext() instead.

func (*AvailabilitySetListResultPage) NextWithContext

func (page *AvailabilitySetListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (AvailabilitySetListResultPage) NotDone

func (page AvailabilitySetListResultPage) NotDone() bool

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

func (AvailabilitySetListResultPage) Response

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

func (AvailabilitySetListResultPage) Values

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

type AvailabilitySetProperties

type AvailabilitySetProperties struct {
	// PlatformUpdateDomainCount - Update Domain count.
	PlatformUpdateDomainCount *int32 `json:"platformUpdateDomainCount,omitempty"`
	// PlatformFaultDomainCount - Fault Domain count.
	PlatformFaultDomainCount *int32 `json:"platformFaultDomainCount,omitempty"`
	// VirtualMachines - A list of references to all virtual machines in the availability set.
	VirtualMachines *[]SubResource `json:"virtualMachines,omitempty"`
	// ProximityPlacementGroup - Specifies information about the proximity placement group that the availability set should be assigned to. <br><br>Minimum api-version: 2018-04-01.
	ProximityPlacementGroup *SubResource `json:"proximityPlacementGroup,omitempty"`
	// Statuses - READ-ONLY; The resource status information.
	Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}

AvailabilitySetProperties the instance view of a resource.

type AvailabilitySetSkuTypes

type AvailabilitySetSkuTypes string

AvailabilitySetSkuTypes enumerates the values for availability set sku types.

const (
	// Aligned ...
	Aligned AvailabilitySetSkuTypes = "Aligned"
	// Classic ...
	Classic AvailabilitySetSkuTypes = "Classic"
)

func PossibleAvailabilitySetSkuTypesValues

func PossibleAvailabilitySetSkuTypesValues() []AvailabilitySetSkuTypes

PossibleAvailabilitySetSkuTypesValues returns an array of possible values for the AvailabilitySetSkuTypes const type.

type AvailabilitySetUpdate

type AvailabilitySetUpdate struct {
	*AvailabilitySetProperties `json:"properties,omitempty"`
	// Sku - Sku of the availability set
	Sku *Sku `json:"sku,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

AvailabilitySetUpdate specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated.

func (AvailabilitySetUpdate) MarshalJSON

func (asu AvailabilitySetUpdate) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AvailabilitySetUpdate.

func (*AvailabilitySetUpdate) UnmarshalJSON

func (asu *AvailabilitySetUpdate) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AvailabilitySetUpdate struct.

type AvailabilitySetsClient

type AvailabilitySetsClient struct {
	BaseClient
}

AvailabilitySetsClient is the compute Client

func NewAvailabilitySetsClient

func NewAvailabilitySetsClient(subscriptionID string) AvailabilitySetsClient

NewAvailabilitySetsClient creates an instance of the AvailabilitySetsClient client.

func NewAvailabilitySetsClientWithBaseURI

func NewAvailabilitySetsClientWithBaseURI(baseURI string, subscriptionID string) AvailabilitySetsClient

NewAvailabilitySetsClientWithBaseURI creates an instance of the AvailabilitySetsClient client.

func (AvailabilitySetsClient) CreateOrUpdate

func (client AvailabilitySetsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySet) (result AvailabilitySet, err error)

CreateOrUpdate create or update an availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set. parameters - parameters supplied to the Create Availability Set operation.

func (AvailabilitySetsClient) CreateOrUpdatePreparer

func (client AvailabilitySetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySet) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AvailabilitySetsClient) CreateOrUpdateResponder

func (client AvailabilitySetsClient) CreateOrUpdateResponder(resp *http.Response) (result AvailabilitySet, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (AvailabilitySetsClient) CreateOrUpdateSender

func (client AvailabilitySetsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (AvailabilitySetsClient) Delete

func (client AvailabilitySetsClient) Delete(ctx context.Context, resourceGroupName string, availabilitySetName string) (result autorest.Response, err error)

Delete delete an availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set.

func (AvailabilitySetsClient) DeletePreparer

func (client AvailabilitySetsClient) DeletePreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AvailabilitySetsClient) DeleteResponder

func (client AvailabilitySetsClient) 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 (AvailabilitySetsClient) DeleteSender

func (client AvailabilitySetsClient) 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 (AvailabilitySetsClient) Get

func (client AvailabilitySetsClient) Get(ctx context.Context, resourceGroupName string, availabilitySetName string) (result AvailabilitySet, err error)

Get retrieves information about an availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set.

func (AvailabilitySetsClient) GetPreparer

func (client AvailabilitySetsClient) GetPreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (AvailabilitySetsClient) GetResponder

func (client AvailabilitySetsClient) GetResponder(resp *http.Response) (result AvailabilitySet, err error)

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

func (AvailabilitySetsClient) GetSender

func (client AvailabilitySetsClient) 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 (AvailabilitySetsClient) List

func (client AvailabilitySetsClient) List(ctx context.Context, resourceGroupName string) (result AvailabilitySetListResultPage, err error)

List lists all availability sets in a resource group. Parameters: resourceGroupName - the name of the resource group.

func (AvailabilitySetsClient) ListAvailableSizes

func (client AvailabilitySetsClient) ListAvailableSizes(ctx context.Context, resourceGroupName string, availabilitySetName string) (result VirtualMachineSizeListResult, err error)

ListAvailableSizes lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set.

func (AvailabilitySetsClient) ListAvailableSizesPreparer

func (client AvailabilitySetsClient) ListAvailableSizesPreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)

ListAvailableSizesPreparer prepares the ListAvailableSizes request.

func (AvailabilitySetsClient) ListAvailableSizesResponder

func (client AvailabilitySetsClient) ListAvailableSizesResponder(resp *http.Response) (result VirtualMachineSizeListResult, err error)

ListAvailableSizesResponder handles the response to the ListAvailableSizes request. The method always closes the http.Response Body.

func (AvailabilitySetsClient) ListAvailableSizesSender

func (client AvailabilitySetsClient) ListAvailableSizesSender(req *http.Request) (*http.Response, error)

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

func (AvailabilitySetsClient) ListBySubscription

func (client AvailabilitySetsClient) ListBySubscription(ctx context.Context) (result AvailabilitySetListResultPage, err error)

ListBySubscription lists all availability sets in a subscription.

func (AvailabilitySetsClient) ListBySubscriptionComplete

func (client AvailabilitySetsClient) ListBySubscriptionComplete(ctx context.Context) (result AvailabilitySetListResultIterator, err error)

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

func (AvailabilitySetsClient) ListBySubscriptionPreparer

func (client AvailabilitySetsClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (AvailabilitySetsClient) ListBySubscriptionResponder

func (client AvailabilitySetsClient) ListBySubscriptionResponder(resp *http.Response) (result AvailabilitySetListResult, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (AvailabilitySetsClient) ListBySubscriptionSender

func (client AvailabilitySetsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

func (AvailabilitySetsClient) ListComplete

func (client AvailabilitySetsClient) ListComplete(ctx context.Context, resourceGroupName string) (result AvailabilitySetListResultIterator, err error)

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

func (AvailabilitySetsClient) ListPreparer

func (client AvailabilitySetsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListPreparer prepares the List request.

func (AvailabilitySetsClient) ListResponder

func (client AvailabilitySetsClient) ListResponder(resp *http.Response) (result AvailabilitySetListResult, err error)

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

func (AvailabilitySetsClient) ListSender

func (client AvailabilitySetsClient) 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 (AvailabilitySetsClient) Update

func (client AvailabilitySetsClient) Update(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySetUpdate) (result AvailabilitySet, err error)

Update update an availability set. Parameters: resourceGroupName - the name of the resource group. availabilitySetName - the name of the availability set. parameters - parameters supplied to the Update Availability Set operation.

func (AvailabilitySetsClient) UpdatePreparer

func (client AvailabilitySetsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySetUpdate) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AvailabilitySetsClient) UpdateResponder

func (client AvailabilitySetsClient) UpdateResponder(resp *http.Response) (result AvailabilitySet, err error)

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

func (AvailabilitySetsClient) UpdateSender

func (client AvailabilitySetsClient) 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 BaseClient

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

BaseClient is the base client for Compute.

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 BootDiagnostics

type BootDiagnostics struct {
	// Enabled - Whether boot diagnostics should be enabled on the Virtual Machine.
	Enabled *bool `json:"enabled,omitempty"`
	// StorageURI - Uri of the storage account to use for placing the console output and screenshot.
	StorageURI *string `json:"storageUri,omitempty"`
}

BootDiagnostics boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. <br><br> You can easily view the output of your console log. <br><br> Azure also enables you to see a screenshot of the VM from the hypervisor.

type BootDiagnosticsInstanceView

type BootDiagnosticsInstanceView struct {
	// ConsoleScreenshotBlobURI - READ-ONLY; The console screenshot blob URI.
	ConsoleScreenshotBlobURI *string `json:"consoleScreenshotBlobUri,omitempty"`
	// SerialConsoleLogBlobURI - READ-ONLY; The Linux serial console log blob Uri.
	SerialConsoleLogBlobURI *string `json:"serialConsoleLogBlobUri,omitempty"`
	// Status - READ-ONLY; The boot diagnostics status information for the VM. <br><br> NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.
	Status *InstanceViewStatus `json:"status,omitempty"`
}

BootDiagnosticsInstanceView the instance view of a virtual machine boot diagnostics.

type CachingTypes

type CachingTypes string

CachingTypes enumerates the values for caching types.

const (
	// CachingTypesNone ...
	CachingTypesNone CachingTypes = "None"
	// CachingTypesReadOnly ...
	CachingTypesReadOnly CachingTypes = "ReadOnly"
	// CachingTypesReadWrite ...
	CachingTypesReadWrite CachingTypes = "ReadWrite"
)

func PossibleCachingTypesValues

func PossibleCachingTypesValues() []CachingTypes

PossibleCachingTypesValues returns an array of possible values for the CachingTypes const type.

type CloudError

type CloudError struct {
	Error *APIError `json:"error,omitempty"`
}

CloudError an error response from the Gallery service.

type ComponentNames

type ComponentNames string

ComponentNames enumerates the values for component names.

const (
	// MicrosoftWindowsShellSetup ...
	MicrosoftWindowsShellSetup ComponentNames = "Microsoft-Windows-Shell-Setup"
)

func PossibleComponentNamesValues

func PossibleComponentNamesValues() []ComponentNames

PossibleComponentNamesValues returns an array of possible values for the ComponentNames const type.

type ContainerService

type ContainerService struct {
	autorest.Response           `json:"-"`
	*ContainerServiceProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
}

ContainerService container service.

func (ContainerService) MarshalJSON

func (cs ContainerService) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ContainerService.

func (*ContainerService) UnmarshalJSON

func (cs *ContainerService) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ContainerService struct.

type ContainerServiceAgentPoolProfile

type ContainerServiceAgentPoolProfile struct {
	// Name - Unique name of the agent pool profile in the context of the subscription and resource group.
	Name *string `json:"name,omitempty"`
	// Count - Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.
	Count *int32 `json:"count,omitempty"`
	// VMSize - Size of agent VMs. Possible values include: 'StandardA0', 'StandardA1', 'StandardA2', 'StandardA3', 'StandardA4', 'StandardA5', 'StandardA6', 'StandardA7', 'StandardA8', 'StandardA9', 'StandardA10', 'StandardA11', 'StandardD1', 'StandardD2', 'StandardD3', 'StandardD4', 'StandardD11', 'StandardD12', 'StandardD13', 'StandardD14', 'StandardD1V2', 'StandardD2V2', 'StandardD3V2', 'StandardD4V2', 'StandardD5V2', 'StandardD11V2', 'StandardD12V2', 'StandardD13V2', 'StandardD14V2', 'StandardG1', 'StandardG2', 'StandardG3', 'StandardG4', 'StandardG5', 'StandardDS1', 'StandardDS2', 'StandardDS3', 'StandardDS4', 'StandardDS11', 'StandardDS12', 'StandardDS13', 'StandardDS14', 'StandardGS1', 'StandardGS2', 'StandardGS3', 'StandardGS4', 'StandardGS5'
	VMSize ContainerServiceVMSizeTypes `json:"vmSize,omitempty"`
	// DNSPrefix - DNS prefix to be used to create the FQDN for the agent pool.
	DNSPrefix *string `json:"dnsPrefix,omitempty"`
	// Fqdn - READ-ONLY; FQDN for the agent pool.
	Fqdn *string `json:"fqdn,omitempty"`
}

ContainerServiceAgentPoolProfile profile for the container service agent pool.

type ContainerServiceCustomProfile

type ContainerServiceCustomProfile struct {
	// Orchestrator - The name of the custom orchestrator to use.
	Orchestrator *string `json:"orchestrator,omitempty"`
}

ContainerServiceCustomProfile properties to configure a custom container service cluster.

type ContainerServiceDiagnosticsProfile

type ContainerServiceDiagnosticsProfile struct {
	// VMDiagnostics - Profile for the container service VM diagnostic agent.
	VMDiagnostics *ContainerServiceVMDiagnostics `json:"vmDiagnostics,omitempty"`
}

ContainerServiceDiagnosticsProfile ...

type ContainerServiceLinuxProfile

type ContainerServiceLinuxProfile struct {
	// AdminUsername - The administrator username to use for Linux VMs.
	AdminUsername *string `json:"adminUsername,omitempty"`
	// SSH - The ssh key configuration for Linux VMs.
	SSH *ContainerServiceSSHConfiguration `json:"ssh,omitempty"`
}

ContainerServiceLinuxProfile profile for Linux VMs in the container service cluster.

type ContainerServiceListResult

type ContainerServiceListResult struct {
	autorest.Response `json:"-"`
	// Value - the list of container services.
	Value *[]ContainerService `json:"value,omitempty"`
	// NextLink - The URL to get the next set of container service results.
	NextLink *string `json:"nextLink,omitempty"`
}

ContainerServiceListResult the response from the List Container Services operation.

func (ContainerServiceListResult) IsEmpty

func (cslr ContainerServiceListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ContainerServiceListResultIterator

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

ContainerServiceListResultIterator provides access to a complete listing of ContainerService values.

func NewContainerServiceListResultIterator

func NewContainerServiceListResultIterator(page ContainerServiceListResultPage) ContainerServiceListResultIterator

Creates a new instance of the ContainerServiceListResultIterator type.

func (*ContainerServiceListResultIterator) Next deprecated

This method has been deprecated.

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ContainerServiceListResultIterator) NextWithContext

func (iter *ContainerServiceListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (ContainerServiceListResultIterator) NotDone

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

func (ContainerServiceListResultIterator) Response

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

func (ContainerServiceListResultIterator) Value

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

type ContainerServiceListResultPage

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

ContainerServiceListResultPage contains a page of ContainerService values.

func NewContainerServiceListResultPage

func NewContainerServiceListResultPage(getNextPage func(context.Context, ContainerServiceListResult) (ContainerServiceListResult, error)) ContainerServiceListResultPage

Creates a new instance of the ContainerServiceListResultPage type.

func (*ContainerServiceListResultPage) Next deprecated

This method has been deprecated.

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. Deprecated: Use NextWithContext() instead.

func (*ContainerServiceListResultPage) NextWithContext

func (page *ContainerServiceListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (ContainerServiceListResultPage) NotDone

func (page ContainerServiceListResultPage) NotDone() bool

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

func (ContainerServiceListResultPage) Response

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

func (ContainerServiceListResultPage) Values

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

type ContainerServiceMasterProfile

type ContainerServiceMasterProfile struct {
	// Count - Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.
	Count *int32 `json:"count,omitempty"`
	// DNSPrefix - DNS prefix to be used to create the FQDN for master.
	DNSPrefix *string `json:"dnsPrefix,omitempty"`
	// Fqdn - READ-ONLY; FQDN for the master.
	Fqdn *string `json:"fqdn,omitempty"`
}

ContainerServiceMasterProfile profile for the container service master.

type ContainerServiceOrchestratorProfile

type ContainerServiceOrchestratorProfile struct {
	// OrchestratorType - The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom. Possible values include: 'Swarm', 'DCOS', 'Custom', 'Kubernetes'
	OrchestratorType ContainerServiceOrchestratorTypes `json:"orchestratorType,omitempty"`
}

ContainerServiceOrchestratorProfile profile for the container service orchestrator.

type ContainerServiceOrchestratorTypes

type ContainerServiceOrchestratorTypes string

ContainerServiceOrchestratorTypes enumerates the values for container service orchestrator types.

const (
	// Custom ...
	Custom ContainerServiceOrchestratorTypes = "Custom"
	// DCOS ...
	DCOS ContainerServiceOrchestratorTypes = "DCOS"
	// Kubernetes ...
	Kubernetes ContainerServiceOrchestratorTypes = "Kubernetes"
	// Swarm ...
	Swarm ContainerServiceOrchestratorTypes = "Swarm"
)

func PossibleContainerServiceOrchestratorTypesValues

func PossibleContainerServiceOrchestratorTypesValues() []ContainerServiceOrchestratorTypes

PossibleContainerServiceOrchestratorTypesValues returns an array of possible values for the ContainerServiceOrchestratorTypes const type.

type ContainerServiceProperties

type ContainerServiceProperties struct {
	// ProvisioningState - READ-ONLY; the current deployment or provisioning state, which only appears in the response.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// OrchestratorProfile - Properties of the orchestrator.
	OrchestratorProfile *ContainerServiceOrchestratorProfile `json:"orchestratorProfile,omitempty"`
	// CustomProfile - Properties for custom clusters.
	CustomProfile *ContainerServiceCustomProfile `json:"customProfile,omitempty"`
	// ServicePrincipalProfile - Properties for cluster service principals.
	ServicePrincipalProfile *ContainerServiceServicePrincipalProfile `json:"servicePrincipalProfile,omitempty"`
	// MasterProfile - Properties of master agents.
	MasterProfile *ContainerServiceMasterProfile `json:"masterProfile,omitempty"`
	// AgentPoolProfiles - Properties of the agent pool.
	AgentPoolProfiles *[]ContainerServiceAgentPoolProfile `json:"agentPoolProfiles,omitempty"`
	// WindowsProfile - Properties of Windows VMs.
	WindowsProfile *ContainerServiceWindowsProfile `json:"windowsProfile,omitempty"`
	// LinuxProfile - Properties of Linux VMs.
	LinuxProfile *ContainerServiceLinuxProfile `json:"linuxProfile,omitempty"`
	// DiagnosticsProfile - Properties of the diagnostic agent.
	DiagnosticsProfile *ContainerServiceDiagnosticsProfile `json:"diagnosticsProfile,omitempty"`
}

ContainerServiceProperties properties of the container service.

type ContainerServiceSSHConfiguration

type ContainerServiceSSHConfiguration struct {
	// PublicKeys - the list of SSH public keys used to authenticate with Linux-based VMs.
	PublicKeys *[]ContainerServiceSSHPublicKey `json:"publicKeys,omitempty"`
}

ContainerServiceSSHConfiguration SSH configuration for Linux-based VMs running on Azure.

type ContainerServiceSSHPublicKey

type ContainerServiceSSHPublicKey struct {
	// KeyData - Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.
	KeyData *string `json:"keyData,omitempty"`
}

ContainerServiceSSHPublicKey contains information about SSH certificate public key data.

type ContainerServiceServicePrincipalProfile

type ContainerServiceServicePrincipalProfile struct {
	// ClientID - The ID for the service principal.
	ClientID *string `json:"clientId,omitempty"`
	// Secret - The secret password associated with the service principal.
	Secret *string `json:"secret,omitempty"`
}

ContainerServiceServicePrincipalProfile information about a service principal identity for the cluster to use for manipulating Azure APIs.

type ContainerServiceVMDiagnostics

type ContainerServiceVMDiagnostics struct {
	// Enabled - Whether the VM diagnostic agent is provisioned on the VM.
	Enabled *bool `json:"enabled,omitempty"`
	// StorageURI - READ-ONLY; The URI of the storage account where diagnostics are stored.
	StorageURI *string `json:"storageUri,omitempty"`
}

ContainerServiceVMDiagnostics profile for diagnostics on the container service VMs.

type ContainerServiceVMSizeTypes

type ContainerServiceVMSizeTypes string

ContainerServiceVMSizeTypes enumerates the values for container service vm size types.

const (
	// StandardA0 ...
	StandardA0 ContainerServiceVMSizeTypes = "Standard_A0"
	// StandardA1 ...
	StandardA1 ContainerServiceVMSizeTypes = "Standard_A1"
	// StandardA10 ...
	StandardA10 ContainerServiceVMSizeTypes = "Standard_A10"
	// StandardA11 ...
	StandardA11 ContainerServiceVMSizeTypes = "Standard_A11"
	// StandardA2 ...
	StandardA2 ContainerServiceVMSizeTypes = "Standard_A2"
	// StandardA3 ...
	StandardA3 ContainerServiceVMSizeTypes = "Standard_A3"
	// StandardA4 ...
	StandardA4 ContainerServiceVMSizeTypes = "Standard_A4"
	// StandardA5 ...
	StandardA5 ContainerServiceVMSizeTypes = "Standard_A5"
	// StandardA6 ...
	StandardA6 ContainerServiceVMSizeTypes = "Standard_A6"
	// StandardA7 ...
	StandardA7 ContainerServiceVMSizeTypes = "Standard_A7"
	// StandardA8 ...
	StandardA8 ContainerServiceVMSizeTypes = "Standard_A8"
	// StandardA9 ...
	StandardA9 ContainerServiceVMSizeTypes = "Standard_A9"
	// StandardD1 ...
	StandardD1 ContainerServiceVMSizeTypes = "Standard_D1"
	// StandardD11 ...
	StandardD11 ContainerServiceVMSizeTypes = "Standard_D11"
	// StandardD11V2 ...
	StandardD11V2 ContainerServiceVMSizeTypes = "Standard_D11_v2"
	// StandardD12 ...
	StandardD12 ContainerServiceVMSizeTypes = "Standard_D12"
	// StandardD12V2 ...
	StandardD12V2 ContainerServiceVMSizeTypes = "Standard_D12_v2"
	// StandardD13 ...
	StandardD13 ContainerServiceVMSizeTypes = "Standard_D13"
	// StandardD13V2 ...
	StandardD13V2 ContainerServiceVMSizeTypes = "Standard_D13_v2"
	// StandardD14 ...
	StandardD14 ContainerServiceVMSizeTypes = "Standard_D14"
	// StandardD14V2 ...
	StandardD14V2 ContainerServiceVMSizeTypes = "Standard_D14_v2"
	// StandardD1V2 ...
	StandardD1V2 ContainerServiceVMSizeTypes = "Standard_D1_v2"
	// StandardD2 ...
	StandardD2 ContainerServiceVMSizeTypes = "Standard_D2"
	// StandardD2V2 ...
	StandardD2V2 ContainerServiceVMSizeTypes = "Standard_D2_v2"
	// StandardD3 ...
	StandardD3 ContainerServiceVMSizeTypes = "Standard_D3"
	// StandardD3V2 ...
	StandardD3V2 ContainerServiceVMSizeTypes = "Standard_D3_v2"
	// StandardD4 ...
	StandardD4 ContainerServiceVMSizeTypes = "Standard_D4"
	// StandardD4V2 ...
	StandardD4V2 ContainerServiceVMSizeTypes = "Standard_D4_v2"
	// StandardD5V2 ...
	StandardD5V2 ContainerServiceVMSizeTypes = "Standard_D5_v2"
	// StandardDS1 ...
	StandardDS1 ContainerServiceVMSizeTypes = "Standard_DS1"
	// StandardDS11 ...
	StandardDS11 ContainerServiceVMSizeTypes = "Standard_DS11"
	// StandardDS12 ...
	StandardDS12 ContainerServiceVMSizeTypes = "Standard_DS12"
	// StandardDS13 ...
	StandardDS13 ContainerServiceVMSizeTypes = "Standard_DS13"
	// StandardDS14 ...
	StandardDS14 ContainerServiceVMSizeTypes = "Standard_DS14"
	// StandardDS2 ...
	StandardDS2 ContainerServiceVMSizeTypes = "Standard_DS2"
	// StandardDS3 ...
	StandardDS3 ContainerServiceVMSizeTypes = "Standard_DS3"
	// StandardDS4 ...
	StandardDS4 ContainerServiceVMSizeTypes = "Standard_DS4"
	// StandardG1 ...
	StandardG1 ContainerServiceVMSizeTypes = "Standard_G1"
	// StandardG2 ...
	StandardG2 ContainerServiceVMSizeTypes = "Standard_G2"
	// StandardG3 ...
	StandardG3 ContainerServiceVMSizeTypes = "Standard_G3"
	// StandardG4 ...
	StandardG4 ContainerServiceVMSizeTypes = "Standard_G4"
	// StandardG5 ...
	StandardG5 ContainerServiceVMSizeTypes = "Standard_G5"
	// StandardGS1 ...
	StandardGS1 ContainerServiceVMSizeTypes = "Standard_GS1"
	// StandardGS2 ...
	StandardGS2 ContainerServiceVMSizeTypes = "Standard_GS2"
	// StandardGS3 ...
	StandardGS3 ContainerServiceVMSizeTypes = "Standard_GS3"
	// StandardGS4 ...
	StandardGS4 ContainerServiceVMSizeTypes = "Standard_GS4"
	// StandardGS5 ...
	StandardGS5 ContainerServiceVMSizeTypes = "Standard_GS5"
)

func PossibleContainerServiceVMSizeTypesValues

func PossibleContainerServiceVMSizeTypesValues() []ContainerServiceVMSizeTypes

PossibleContainerServiceVMSizeTypesValues returns an array of possible values for the ContainerServiceVMSizeTypes const type.

type ContainerServiceWindowsProfile

type ContainerServiceWindowsProfile struct {
	// AdminUsername - The administrator username to use for Windows VMs.
	AdminUsername *string `json:"adminUsername,omitempty"`
	// AdminPassword - The administrator password to use for Windows VMs.
	AdminPassword *string `json:"adminPassword,omitempty"`
}

ContainerServiceWindowsProfile profile for Windows VMs in the container service cluster.

type ContainerServicesClient

type ContainerServicesClient struct {
	BaseClient
}

ContainerServicesClient is the compute Client

func NewContainerServicesClient

func NewContainerServicesClient(subscriptionID string) ContainerServicesClient

NewContainerServicesClient creates an instance of the ContainerServicesClient client.

func NewContainerServicesClientWithBaseURI

func NewContainerServicesClientWithBaseURI(baseURI string, subscriptionID string) ContainerServicesClient

NewContainerServicesClientWithBaseURI creates an instance of the ContainerServicesClient client.

func (ContainerServicesClient) CreateOrUpdate

func (client ContainerServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, containerServiceName string, parameters ContainerService) (result ContainerServicesCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates a container service with the specified configuration of orchestrator, masters, and agents. Parameters: resourceGroupName - the name of the resource group. containerServiceName - the name of the container service in the specified subscription and resource group. parameters - parameters supplied to the Create or Update a Container Service operation.

func (ContainerServicesClient) CreateOrUpdatePreparer

func (client ContainerServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, containerServiceName string, parameters ContainerService) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ContainerServicesClient) CreateOrUpdateResponder

func (client ContainerServicesClient) CreateOrUpdateResponder(resp *http.Response) (result ContainerService, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ContainerServicesClient) CreateOrUpdateSender

func (client ContainerServicesClient) CreateOrUpdateSender(req *http.Request) (future ContainerServicesCreateOrUpdateFuture, err error)

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

func (ContainerServicesClient) Delete

func (client ContainerServicesClient) Delete(ctx context.Context, resourceGroupName string, containerServiceName string) (result ContainerServicesDeleteFuture, err error)

Delete deletes the specified container service in the specified subscription and resource group. The operation does not delete other resources created as part of creating a container service, including storage accounts, VMs, and availability sets. All the other resources created with the container service are part of the same resource group and can be deleted individually.