compute

package
v68.0.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 19, 2023 License: MIT Imports: 10 Imported by: 253

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

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"
	// Write ...
	Write AccessLevel = "Write"
)

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.

func (AccessURI) MarshalJSON 

func (au AccessURI) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccessURI.

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. <br><br> If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true.
	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 AutomaticRepairsPolicy 

type AutomaticRepairsPolicy struct {
	// Enabled - Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.
	Enabled *bool `json:"enabled,omitempty"`
	// GracePeriod - The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).
	GracePeriod *string `json:"gracePeriod,omitempty"`
}

AutomaticRepairsPolicy specifies the configuration parameters for automatic repairs on the virtual machine scale set.

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 

func (iter *AvailabilitySetListResultIterator) 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. 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 

func (iter AvailabilitySetListResultIterator) Response() AvailabilitySetListResult

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

func (AvailabilitySetListResultIterator) Value 

func (iter AvailabilitySetListResultIterator) Value() AvailabilitySet

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(cur AvailabilitySetListResult, getNextPage func(context.Context, AvailabilitySetListResult) (AvailabilitySetListResult, error)) AvailabilitySetListResultPage

Creates a new instance of the AvailabilitySetListResultPage type.

func (*AvailabilitySetListResultPage) Next 

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 

func (page AvailabilitySetListResultPage) Response() AvailabilitySetListResult

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

func (AvailabilitySetListResultPage) Values