import "github.com/Azure/azure-sdk-for-go/services/compute/mgmt/2018-06-01/compute"
Package compute implements the Azure ARM Compute service API version .
Compute Client
availabilitysets.go client.go containerservices.go disks.go enums.go galleries.go galleryimages.go galleryimageversions.go images.go loganalytics.go models.go operations.go proximityplacementgroups.go resourceskus.go snapshots.go usage.go version.go virtualmachineextensionimages.go virtualmachineextensions.go virtualmachineimages.go virtualmachineruncommands.go virtualmachines.go virtualmachinescalesetextensions.go virtualmachinescalesetrollingupgrades.go virtualmachinescalesets.go virtualmachinescalesetvms.go virtualmachinesizes.go
const (
// DefaultBaseURI is the default URI used for the service Compute
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
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 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 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.
AccessLevel enumerates the values for access level.
const (
// None ...
None AccessLevel = "None"
// Read ...
Read AccessLevel = "Read"
)func PossibleAccessLevelValues() []AccessLevel
PossibleAccessLevelValues returns an array of possible values for the AccessLevel const type.
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 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 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.
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() []AggregatedReplicationState
PossibleAggregatedReplicationStateValues returns an array of possible values for the AggregatedReplicationState const type.
type AutoOSUpgradePolicy struct {
// DisableAutoRollback - Whether OS image rollback feature should be disabled. Default value is false.
DisableAutoRollback *bool `json:"disableAutoRollback,omitempty"`
}AutoOSUpgradePolicy the configuration parameters used for performing automatic OS upgrade.
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 (as AvailabilitySet) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailabilitySet.
func (as *AvailabilitySet) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AvailabilitySet struct.
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 (aslr AvailabilitySetListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type AvailabilitySetListResultIterator struct {
// contains filtered or unexported fields
}AvailabilitySetListResultIterator provides access to a complete listing of AvailabilitySet values.
func NewAvailabilitySetListResultIterator(page AvailabilitySetListResultPage) AvailabilitySetListResultIterator
Creates a new instance of the AvailabilitySetListResultIterator type.
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 (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 (iter AvailabilitySetListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter AvailabilitySetListResultIterator) Response() AvailabilitySetListResult
Response returns the raw server response from the last page request.
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 struct {
// contains filtered or unexported fields
}AvailabilitySetListResultPage contains a page of AvailabilitySet values.
func NewAvailabilitySetListResultPage(cur AvailabilitySetListResult, getNextPage func(context.Context, AvailabilitySetListResult) (AvailabilitySetListResult, error)) AvailabilitySetListResultPage
Creates a new instance of the AvailabilitySetListResultPage type.
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 (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 (page AvailabilitySetListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page AvailabilitySetListResultPage) Response() AvailabilitySetListResult
Response returns the raw server response from the last page request.
func (page AvailabilitySetListResultPage) Values() []AvailabilitySet
Values returns the slice of values for the current page or nil if there are no values.
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.
func (asp AvailabilitySetProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailabilitySetProperties.
AvailabilitySetSkuTypes enumerates the values for availability set sku types.
const (
// Aligned ...
Aligned AvailabilitySetSkuTypes = "Aligned"
// Classic ...
Classic AvailabilitySetSkuTypes = "Classic"
)func PossibleAvailabilitySetSkuTypesValues() []AvailabilitySetSkuTypes
PossibleAvailabilitySetSkuTypesValues returns an array of possible values for the AvailabilitySetSkuTypes const type.
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 (asu AvailabilitySetUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AvailabilitySetUpdate.
func (asu *AvailabilitySetUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for AvailabilitySetUpdate struct.
type AvailabilitySetsClient struct {
BaseClient
}AvailabilitySetsClient is the compute Client
func NewAvailabilitySetsClient(subscriptionID string) AvailabilitySetsClient
NewAvailabilitySetsClient creates an instance of the AvailabilitySetsClient client.
func NewAvailabilitySetsClientWithBaseURI(baseURI string, subscriptionID string) AvailabilitySetsClient
NewAvailabilitySetsClientWithBaseURI creates an instance of the AvailabilitySetsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client 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 (client AvailabilitySetsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySet) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client AvailabilitySetsClient) DeletePreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
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 (client AvailabilitySetsClient) GetPreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)
GetPreparer prepares the Get request.
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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (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 (client AvailabilitySetsClient) ListAvailableSizesPreparer(ctx context.Context, resourceGroupName string, availabilitySetName string) (*http.Request, error)
ListAvailableSizesPreparer prepares the ListAvailableSizes request.
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 (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 (client AvailabilitySetsClient) ListBySubscription(ctx context.Context, expand string) (result AvailabilitySetListResultPage, err error)
ListBySubscription lists all availability sets in a subscription. Parameters: expand - the expand expression to apply to the operation. Allowed values are 'instanceView'.
func (client AvailabilitySetsClient) ListBySubscriptionComplete(ctx context.Context, expand string) (result AvailabilitySetListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client AvailabilitySetsClient) ListBySubscriptionPreparer(ctx context.Context, expand string) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
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 (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 (client AvailabilitySetsClient) ListComplete(ctx context.Context, resourceGroupName string) (result AvailabilitySetListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client AvailabilitySetsClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
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 (client AvailabilitySetsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, availabilitySetName string, parameters AvailabilitySetUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
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.
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
BaseClient is the base client for Compute.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
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 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.
CachingTypes enumerates the values for caching types.
const (
// CachingTypesNone ...
CachingTypesNone CachingTypes = "None"
// CachingTypesReadOnly ...
CachingTypesReadOnly CachingTypes = "ReadOnly"
// CachingTypesReadWrite ...
CachingTypesReadWrite CachingTypes = "ReadWrite"
)func PossibleCachingTypesValues() []CachingTypes
PossibleCachingTypesValues returns an array of possible values for the CachingTypes const type.
CloudError an error response from the Gallery service.
ComponentNames enumerates the values for component names.
const (
// MicrosoftWindowsShellSetup ...
MicrosoftWindowsShellSetup ComponentNames = "Microsoft-Windows-Shell-Setup"
)func PossibleComponentNamesValues() []ComponentNames
PossibleComponentNamesValues returns an array of possible values for the ComponentNames const type.
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 (cs ContainerService) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerService.
func (cs *ContainerService) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ContainerService struct.
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.
func (csapp ContainerServiceAgentPoolProfile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerServiceAgentPoolProfile.
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 struct {
// VMDiagnostics - Profile for the container service VM diagnostic agent.
VMDiagnostics *ContainerServiceVMDiagnostics `json:"vmDiagnostics,omitempty"`
}ContainerServiceDiagnosticsProfile ...
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 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 (cslr ContainerServiceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ContainerServiceListResultIterator struct {
// contains filtered or unexported fields
}ContainerServiceListResultIterator provides access to a complete listing of ContainerService values.
func NewContainerServiceListResultIterator(page ContainerServiceListResultPage) ContainerServiceListResultIterator
Creates a new instance of the ContainerServiceListResultIterator type.
func (iter *ContainerServiceListResultIterator) 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 (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 (iter ContainerServiceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ContainerServiceListResultIterator) Response() ContainerServiceListResult
Response returns the raw server response from the last page request.
func (iter ContainerServiceListResultIterator) Value() ContainerService
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ContainerServiceListResultPage struct {
// contains filtered or unexported fields
}ContainerServiceListResultPage contains a page of ContainerService values.
func NewContainerServiceListResultPage(cur ContainerServiceListResult, getNextPage func(context.Context, ContainerServiceListResult) (ContainerServiceListResult, error)) ContainerServiceListResultPage
Creates a new instance of the ContainerServiceListResultPage type.
func (page *ContainerServiceListResultPage) 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 (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 (page ContainerServiceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ContainerServiceListResultPage) Response() ContainerServiceListResult
Response returns the raw server response from the last page request.
func (page ContainerServiceListResultPage) Values() []ContainerService
Values returns the slice of values for the current page or nil if there are no values.
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.
func (csmp ContainerServiceMasterProfile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerServiceMasterProfile.
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.
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() []ContainerServiceOrchestratorTypes
PossibleContainerServiceOrchestratorTypesValues returns an array of possible values for the ContainerServiceOrchestratorTypes const type.
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.
func (csp ContainerServiceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerServiceProperties.
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 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 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 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.
func (csvd ContainerServiceVMDiagnostics) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerServiceVMDiagnostics.
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() []ContainerServiceVMSizeTypes
PossibleContainerServiceVMSizeTypesValues returns an array of possible values for the ContainerServiceVMSizeTypes const type.
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 struct {
BaseClient
}ContainerServicesClient is the compute Client
func NewContainerServicesClient(subscriptionID string) ContainerServicesClient
NewContainerServicesClient creates an instance of the ContainerServicesClient client.
func NewContainerServicesClientWithBaseURI(baseURI string, subscriptionID string) ContainerServicesClient
NewContainerServicesClientWithBaseURI creates an instance of the ContainerServicesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client 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 (client ContainerServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, containerServiceName string, parameters ContainerService) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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. Parameters: resourceGroupName - the name of the resource group. containerServiceName - the name of the container service in the specified subscription and resource group.
func (client ContainerServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, containerServiceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ContainerServicesClient) 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 (client ContainerServicesClient) DeleteSender(req *http.Request) (future ContainerServicesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ContainerServicesClient) Get(ctx context.Context, resourceGroupName string, containerServiceName string) (result ContainerService, err error)
Get gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of 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.
func (client ContainerServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, containerServiceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client ContainerServicesClient) GetResponder(resp *http.Response) (result ContainerService, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ContainerServicesClient) List(ctx context.Context) (result ContainerServiceListResultPage, err error)
List gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.
func (client ContainerServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ContainerServiceListResultPage, err error)
ListByResourceGroup gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. Parameters: resourceGroupName - the name of the resource group.
func (client ContainerServicesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ContainerServiceListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ContainerServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client ContainerServicesClient) ListByResourceGroupResponder(resp *http.Response) (result ContainerServiceListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (client ContainerServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client ContainerServicesClient) ListComplete(ctx context.Context) (result ContainerServiceListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client ContainerServicesClient) ListResponder(resp *http.Response) (result ContainerServiceListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ContainerServicesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ContainerServicesClient) (ContainerService, error)
}ContainerServicesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ContainerServicesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ContainerServicesClient) (autorest.Response, error)
}ContainerServicesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CreationData struct {
// CreateOption - This enumerates the possible sources of a disk's creation. Possible values include: 'Empty', 'Attach', 'FromImage', 'Import', 'Copy', 'Restore'
CreateOption DiskCreateOption `json:"createOption,omitempty"`
// StorageAccountID - If createOption is Import, the Azure Resource Manager identifier of the storage account containing the blob to import as a disk. Required only if the blob is in a different subscription
StorageAccountID *string `json:"storageAccountId,omitempty"`
// ImageReference - Disk source information.
ImageReference *ImageDiskReference `json:"imageReference,omitempty"`
// SourceURI - If createOption is Import, this is the URI of a blob to be imported into a managed disk.
SourceURI *string `json:"sourceUri,omitempty"`
// SourceResourceID - If createOption is Copy, this is the ARM id of the source snapshot or disk.
SourceResourceID *string `json:"sourceResourceId,omitempty"`
}CreationData data used when creating a disk.
type DataDisk struct {
// Lun - Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
Lun *int32 `json:"lun,omitempty"`
// Name - The disk name.
Name *string `json:"name,omitempty"`
// Vhd - The virtual hard disk.
Vhd *VirtualHardDisk `json:"vhd,omitempty"`
// Image - The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
Image *VirtualHardDisk `json:"image,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// WriteAcceleratorEnabled - Specifies whether writeAccelerator should be enabled or disabled on the disk.
WriteAcceleratorEnabled *bool `json:"writeAcceleratorEnabled,omitempty"`
// CreateOption - Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'DiskCreateOptionTypesFromImage', 'DiskCreateOptionTypesEmpty', 'DiskCreateOptionTypesAttach'
CreateOption DiskCreateOptionTypes `json:"createOption,omitempty"`
// DiskSizeGB - Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// ManagedDisk - The managed disk parameters.
ManagedDisk *ManagedDiskParameters `json:"managedDisk,omitempty"`
}DataDisk describes a data disk.
type DataDiskImage struct {
// Lun - READ-ONLY; Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
Lun *int32 `json:"lun,omitempty"`
}DataDiskImage contains the data disk images information.
type DiagnosticsProfile struct {
// 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.
BootDiagnostics *BootDiagnostics `json:"bootDiagnostics,omitempty"`
}DiagnosticsProfile specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.
DiffDiskOptions enumerates the values for diff disk options.
const (
// Local ...
Local DiffDiskOptions = "Local"
)func PossibleDiffDiskOptionsValues() []DiffDiskOptions
PossibleDiffDiskOptionsValues returns an array of possible values for the DiffDiskOptions const type.
type DiffDiskSettings struct {
// Option - Specifies the ephemeral disk settings for operating system disk. Possible values include: 'Local'
Option DiffDiskOptions `json:"option,omitempty"`
}DiffDiskSettings describes the parameters of ephemeral disk settings that can be specified for operating system disk. <br><br> NOTE: The ephemeral disk settings can only be specified for managed disk.
type Disallowed struct {
// DiskTypes - A list of disk types.
DiskTypes *[]string `json:"diskTypes,omitempty"`
}Disallowed describes the disallowed disk types.
type Disk struct {
autorest.Response `json:"-"`
// ManagedBy - READ-ONLY; A relative URI containing the ID of the VM that has the disk attached.
ManagedBy *string `json:"managedBy,omitempty"`
Sku *DiskSku `json:"sku,omitempty"`
// Zones - The Logical zone list for Disk.
Zones *[]string `json:"zones,omitempty"`
*DiskProperties `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"`
}Disk disk resource.
MarshalJSON is the custom marshaler for Disk.
UnmarshalJSON is the custom unmarshaler for Disk struct.
DiskCreateOption enumerates the values for disk create option.
const (
// Attach ...
Attach DiskCreateOption = "Attach"
// Copy ...
Copy DiskCreateOption = "Copy"
// Empty ...
Empty DiskCreateOption = "Empty"
// FromImage ...
FromImage DiskCreateOption = "FromImage"
// Import ...
Import DiskCreateOption = "Import"
// Restore ...
Restore DiskCreateOption = "Restore"
)func PossibleDiskCreateOptionValues() []DiskCreateOption
PossibleDiskCreateOptionValues returns an array of possible values for the DiskCreateOption const type.
DiskCreateOptionTypes enumerates the values for disk create option types.
const (
// DiskCreateOptionTypesAttach ...
DiskCreateOptionTypesAttach DiskCreateOptionTypes = "Attach"
// DiskCreateOptionTypesEmpty ...
DiskCreateOptionTypesEmpty DiskCreateOptionTypes = "Empty"
// DiskCreateOptionTypesFromImage ...
DiskCreateOptionTypesFromImage DiskCreateOptionTypes = "FromImage"
)func PossibleDiskCreateOptionTypesValues() []DiskCreateOptionTypes
PossibleDiskCreateOptionTypesValues returns an array of possible values for the DiskCreateOptionTypes const type.
type DiskEncryptionSettings struct {
// DiskEncryptionKey - Specifies the location of the disk encryption key, which is a Key Vault Secret.
DiskEncryptionKey *KeyVaultSecretReference `json:"diskEncryptionKey,omitempty"`
// KeyEncryptionKey - Specifies the location of the key encryption key in Key Vault.
KeyEncryptionKey *KeyVaultKeyReference `json:"keyEncryptionKey,omitempty"`
// Enabled - Specifies whether disk encryption should be enabled on the virtual machine.
Enabled *bool `json:"enabled,omitempty"`
}DiskEncryptionSettings describes a Encryption Settings for a Disk
type DiskInstanceView struct {
// Name - The disk name.
Name *string `json:"name,omitempty"`
// EncryptionSettings - Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15
EncryptionSettings *[]DiskEncryptionSettings `json:"encryptionSettings,omitempty"`
// Statuses - The resource status information.
Statuses *[]InstanceViewStatus `json:"statuses,omitempty"`
}DiskInstanceView the instance view of the disk.
type DiskList struct {
autorest.Response `json:"-"`
// Value - A list of disks.
Value *[]Disk `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks.
NextLink *string `json:"nextLink,omitempty"`
}DiskList the List Disks operation response.
IsEmpty returns true if the ListResult contains no values.
type DiskListIterator struct {
// contains filtered or unexported fields
}DiskListIterator provides access to a complete listing of Disk values.
func NewDiskListIterator(page DiskListPage) DiskListIterator
Creates a new instance of the DiskListIterator type.
func (iter *DiskListIterator) 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 (iter *DiskListIterator) 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 (iter DiskListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter DiskListIterator) Response() DiskList
Response returns the raw server response from the last page request.
func (iter DiskListIterator) Value() Disk
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type DiskListPage struct {
// contains filtered or unexported fields
}DiskListPage contains a page of Disk values.
func NewDiskListPage(cur DiskList, getNextPage func(context.Context, DiskList) (DiskList, error)) DiskListPage
Creates a new instance of the DiskListPage type.
func (page *DiskListPage) 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 (page *DiskListPage) 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 (page DiskListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page DiskListPage) Response() DiskList
Response returns the raw server response from the last page request.
func (page DiskListPage) Values() []Disk
Values returns the slice of values for the current page or nil if there are no values.
type DiskProperties struct {
// TimeCreated - READ-ONLY; The time when the disk was created.
TimeCreated *date.Time `json:"timeCreated,omitempty"`
// OsType - The Operating System type. Possible values include: 'Windows', 'Linux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// CreationData - Disk source information. CreationData information cannot be changed after the disk has been created.
CreationData *CreationData `json:"creationData,omitempty"`
// DiskSizeGB - If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// EncryptionSettings - Encryption settings for disk or snapshot
EncryptionSettings *EncryptionSettings `json:"encryptionSettings,omitempty"`
// ProvisioningState - READ-ONLY; The disk provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
// DiskIOPSReadWrite - The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. For a description of the range of values you can set, see [Ultra SSD Managed Disk Offerings](https://docs.microsoft.com/azure/virtual-machines/windows/disks-ultra-ssd#ultra-ssd-managed-disk-offerings).
DiskIOPSReadWrite *int64 `json:"diskIOPSReadWrite,omitempty"`
// DiskMBpsReadWrite - The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. For a description of the range of values you can set, see [Ultra SSD Managed Disk Offerings](https://docs.microsoft.com/azure/virtual-machines/windows/disks-ultra-ssd#ultra-ssd-managed-disk-offerings).
DiskMBpsReadWrite *int32 `json:"diskMBpsReadWrite,omitempty"`
}DiskProperties disk resource properties.
func (dp DiskProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskProperties.
type DiskSku struct {
// Name - The sku name. Possible values include: 'StandardLRS', 'PremiumLRS', 'StandardSSDLRS', 'UltraSSDLRS'
Name DiskStorageAccountTypes `json:"name,omitempty"`
// Tier - READ-ONLY; The sku tier.
Tier *string `json:"tier,omitempty"`
}DiskSku the disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.
MarshalJSON is the custom marshaler for DiskSku.
DiskStorageAccountTypes enumerates the values for disk storage account types.
const (
// PremiumLRS ...
PremiumLRS DiskStorageAccountTypes = "Premium_LRS"
// StandardLRS ...
StandardLRS DiskStorageAccountTypes = "Standard_LRS"
// StandardSSDLRS ...
StandardSSDLRS DiskStorageAccountTypes = "StandardSSD_LRS"
// UltraSSDLRS ...
UltraSSDLRS DiskStorageAccountTypes = "UltraSSD_LRS"
)func PossibleDiskStorageAccountTypesValues() []DiskStorageAccountTypes
PossibleDiskStorageAccountTypesValues returns an array of possible values for the DiskStorageAccountTypes const type.
type DiskUpdate struct {
*DiskUpdateProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
Sku *DiskSku `json:"sku,omitempty"`
}DiskUpdate disk update resource.
func (du DiskUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DiskUpdate.
func (du *DiskUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DiskUpdate struct.
type DiskUpdateProperties struct {
// OsType - the Operating System type. Possible values include: 'Windows', 'Linux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// DiskSizeGB - If creationData.createOption is Empty, this field is mandatory and it indicates the size of the VHD to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// EncryptionSettings - Encryption settings for disk or snapshot
EncryptionSettings *EncryptionSettings `json:"encryptionSettings,omitempty"`
// DiskIOPSReadWrite - The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
DiskIOPSReadWrite *int64 `json:"diskIOPSReadWrite,omitempty"`
// DiskMBpsReadWrite - The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.
DiskMBpsReadWrite *int32 `json:"diskMBpsReadWrite,omitempty"`
}DiskUpdateProperties disk resource update properties.
type DisksClient struct {
BaseClient
}DisksClient is the compute Client
func NewDisksClient(subscriptionID string) DisksClient
NewDisksClient creates an instance of the DisksClient client.
func NewDisksClientWithBaseURI(baseURI string, subscriptionID string) DisksClient
NewDisksClientWithBaseURI creates an instance of the DisksClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client DisksClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, diskName string, disk Disk) (result DisksCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. disk - disk object supplied in the body of the Put disk operation.
func (client DisksClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, diskName string, disk Disk) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client DisksClient) CreateOrUpdateSender(req *http.Request) (future DisksCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Delete(ctx context.Context, resourceGroupName string, diskName string) (result DisksDeleteFuture, err error)
Delete deletes a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.
func (client DisksClient) DeletePreparer(ctx context.Context, resourceGroupName string, diskName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client DisksClient) 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 (client DisksClient) DeleteSender(req *http.Request) (future DisksDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Get(ctx context.Context, resourceGroupName string, diskName string) (result Disk, err error)
Get gets information about a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.
func (client DisksClient) GetPreparer(ctx context.Context, resourceGroupName string, diskName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) GrantAccess(ctx context.Context, resourceGroupName string, diskName string, grantAccessData GrantAccessData) (result DisksGrantAccessFuture, err error)
GrantAccess grants access to a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. grantAccessData - access data object supplied in the body of the get disk access operation.
func (client DisksClient) GrantAccessPreparer(ctx context.Context, resourceGroupName string, diskName string, grantAccessData GrantAccessData) (*http.Request, error)
GrantAccessPreparer prepares the GrantAccess request.
GrantAccessResponder handles the response to the GrantAccess request. The method always closes the http.Response Body.
func (client DisksClient) GrantAccessSender(req *http.Request) (future DisksGrantAccessFuture, err error)
GrantAccessSender sends the GrantAccess request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) List(ctx context.Context) (result DiskListPage, err error)
List lists all the disks under a subscription.
func (client DisksClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DiskListPage, err error)
ListByResourceGroup lists all the disks under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client DisksClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result DiskListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client DisksClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client DisksClient) ListByResourceGroupResponder(resp *http.Response) (result DiskList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) ListComplete(ctx context.Context) (result DiskListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) RevokeAccess(ctx context.Context, resourceGroupName string, diskName string) (result DisksRevokeAccessFuture, err error)
RevokeAccess revokes access to a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.
func (client DisksClient) RevokeAccessPreparer(ctx context.Context, resourceGroupName string, diskName string) (*http.Request, error)
RevokeAccessPreparer prepares the RevokeAccess request.
func (client DisksClient) RevokeAccessResponder(resp *http.Response) (result autorest.Response, err error)
RevokeAccessResponder handles the response to the RevokeAccess request. The method always closes the http.Response Body.
func (client DisksClient) RevokeAccessSender(req *http.Request) (future DisksRevokeAccessFuture, err error)
RevokeAccessSender sends the RevokeAccess request. The method will close the http.Response Body if it receives an error.
func (client DisksClient) Update(ctx context.Context, resourceGroupName string, diskName string, disk DiskUpdate) (result DisksUpdateFuture, err error)
Update updates (patches) a disk. Parameters: resourceGroupName - the name of the resource group. diskName - the name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters. disk - disk object supplied in the body of the Patch disk operation.
func (client DisksClient) UpdatePreparer(ctx context.Context, resourceGroupName string, diskName string, disk DiskUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client DisksClient) UpdateSender(req *http.Request) (future DisksUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type DisksCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (Disk, error)
}DisksCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (autorest.Response, error)
}DisksDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksGrantAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (AccessURI, error)
}DisksGrantAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksRevokeAccessFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (autorest.Response, error)
}DisksRevokeAccessFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DisksUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(DisksClient) (Disk, error)
}DisksUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EncryptionSettings struct {
// Enabled - Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
Enabled *bool `json:"enabled,omitempty"`
// DiskEncryptionKey - Key Vault Secret Url and vault id of the disk encryption key
DiskEncryptionKey *KeyVaultAndSecretReference `json:"diskEncryptionKey,omitempty"`
// KeyEncryptionKey - Key Vault Key Url and vault id of the key encryption key
KeyEncryptionKey *KeyVaultAndKeyReference `json:"keyEncryptionKey,omitempty"`
}EncryptionSettings encryption settings for disk or snapshot
type GalleriesClient struct {
BaseClient
}GalleriesClient is the compute Client
func NewGalleriesClient(subscriptionID string) GalleriesClient
NewGalleriesClient creates an instance of the GalleriesClient client.
func NewGalleriesClientWithBaseURI(baseURI string, subscriptionID string) GalleriesClient
NewGalleriesClientWithBaseURI creates an instance of the GalleriesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client GalleriesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, galleryName string, gallery Gallery) (result GalleriesCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a Shared Image Gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. gallery - parameters supplied to the create or update Shared Image Gallery operation.
func (client GalleriesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, gallery Gallery) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GalleriesClient) CreateOrUpdateResponder(resp *http.Response) (result Gallery, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GalleriesClient) CreateOrUpdateSender(req *http.Request) (future GalleriesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GalleriesClient) Delete(ctx context.Context, resourceGroupName string, galleryName string) (result GalleriesDeleteFuture, err error)
Delete delete a Shared Image Gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery to be deleted.
func (client GalleriesClient) DeletePreparer(ctx context.Context, resourceGroupName string, galleryName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GalleriesClient) 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 (client GalleriesClient) DeleteSender(req *http.Request) (future GalleriesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GalleriesClient) Get(ctx context.Context, resourceGroupName string, galleryName string) (result Gallery, err error)
Get retrieves information about a Shared Image Gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery.
func (client GalleriesClient) GetPreparer(ctx context.Context, resourceGroupName string, galleryName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GalleriesClient) List(ctx context.Context) (result GalleryListPage, err error)
List list galleries under a subscription.
func (client GalleriesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result GalleryListPage, err error)
ListByResourceGroup list galleries under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client GalleriesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result GalleryListIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client GalleriesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client GalleriesClient) ListByResourceGroupResponder(resp *http.Response) (result GalleryList, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client GalleriesClient) ListComplete(ctx context.Context) (result GalleryListIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client GalleriesClient) ListResponder(resp *http.Response) (result GalleryList, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type GalleriesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleriesClient) (Gallery, error)
}GalleriesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleriesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleriesClient) (autorest.Response, error)
}GalleriesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type Gallery struct {
autorest.Response `json:"-"`
*GalleryProperties `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"`
}Gallery specifies information about the Shared Image Gallery that you want to create or update.
MarshalJSON is the custom marshaler for Gallery.
UnmarshalJSON is the custom unmarshaler for Gallery struct.
type GalleryArtifactPublishingProfileBase struct {
// TargetRegions - The target regions where the Image Version is going to be replicated to. This property is updatable.
TargetRegions *[]TargetRegion `json:"targetRegions,omitempty"`
Source *GalleryArtifactSource `json:"source,omitempty"`
}GalleryArtifactPublishingProfileBase describes the basic gallery artifact publishing profile.
type GalleryArtifactSource struct {
ManagedImage *ManagedArtifact `json:"managedImage,omitempty"`
}GalleryArtifactSource the source image from which the Image Version is going to be created.
type GalleryDataDiskImage struct {
// Lun - READ-ONLY; This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine.
Lun *int32 `json:"lun,omitempty"`
// SizeInGB - READ-ONLY; This property indicates the size of the VHD to be created.
SizeInGB *int32 `json:"sizeInGB,omitempty"`
// HostCaching - READ-ONLY; The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'. Possible values include: 'HostCachingNone', 'HostCachingReadOnly', 'HostCachingReadWrite'
HostCaching HostCaching `json:"hostCaching,omitempty"`
}GalleryDataDiskImage this is the data disk image.
type GalleryDiskImage struct {
// SizeInGB - READ-ONLY; This property indicates the size of the VHD to be created.
SizeInGB *int32 `json:"sizeInGB,omitempty"`
// HostCaching - READ-ONLY; The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'. Possible values include: 'HostCachingNone', 'HostCachingReadOnly', 'HostCachingReadWrite'
HostCaching HostCaching `json:"hostCaching,omitempty"`
}GalleryDiskImage this is the disk image base class.
type GalleryIdentifier struct {
// UniqueName - READ-ONLY; The unique name of the Shared Image Gallery. This name is generated automatically by Azure.
UniqueName *string `json:"uniqueName,omitempty"`
}GalleryIdentifier describes the gallery unique name.
type GalleryImage struct {
autorest.Response `json:"-"`
*GalleryImageProperties `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"`
}GalleryImage specifies information about the gallery Image Definition that you want to create or update.
func (gi GalleryImage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImage.
func (gi *GalleryImage) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryImage struct.
type GalleryImageIdentifier struct {
// Publisher - The name of the gallery Image Definition publisher.
Publisher *string `json:"publisher,omitempty"`
// Offer - The name of the gallery Image Definition offer.
Offer *string `json:"offer,omitempty"`
// Sku - The name of the gallery Image Definition SKU.
Sku *string `json:"sku,omitempty"`
}GalleryImageIdentifier this is the gallery Image Definition identifier.
type GalleryImageList struct {
autorest.Response `json:"-"`
// Value - A list of Shared Image Gallery images.
Value *[]GalleryImage `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery Image Definitions.
NextLink *string `json:"nextLink,omitempty"`
}GalleryImageList the List Gallery Images operation response.
func (gil GalleryImageList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type GalleryImageListIterator struct {
// contains filtered or unexported fields
}GalleryImageListIterator provides access to a complete listing of GalleryImage values.
func NewGalleryImageListIterator(page GalleryImageListPage) GalleryImageListIterator
Creates a new instance of the GalleryImageListIterator type.
func (iter *GalleryImageListIterator) 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 (iter *GalleryImageListIterator) 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 (iter GalleryImageListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GalleryImageListIterator) Response() GalleryImageList
Response returns the raw server response from the last page request.
func (iter GalleryImageListIterator) Value() GalleryImage
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type GalleryImageListPage struct {
// contains filtered or unexported fields
}GalleryImageListPage contains a page of GalleryImage values.
func NewGalleryImageListPage(cur GalleryImageList, getNextPage func(context.Context, GalleryImageList) (GalleryImageList, error)) GalleryImageListPage
Creates a new instance of the GalleryImageListPage type.
func (page *GalleryImageListPage) 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 (page *GalleryImageListPage) 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 (page GalleryImageListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GalleryImageListPage) Response() GalleryImageList
Response returns the raw server response from the last page request.
func (page GalleryImageListPage) Values() []GalleryImage
Values returns the slice of values for the current page or nil if there are no values.
type GalleryImageProperties struct {
// Description - The description of this gallery Image Definition resource. This property is updatable.
Description *string `json:"description,omitempty"`
// Eula - The Eula agreement for the gallery Image Definition.
Eula *string `json:"eula,omitempty"`
// PrivacyStatementURI - The privacy statement uri.
PrivacyStatementURI *string `json:"privacyStatementUri,omitempty"`
// ReleaseNoteURI - The release note uri.
ReleaseNoteURI *string `json:"releaseNoteUri,omitempty"`
// OsType - This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. Possible values include: 'Windows', 'Linux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// OsState - The allowed values for OS State are 'Generalized'. Possible values include: 'Generalized', 'Specialized'
OsState OperatingSystemStateTypes `json:"osState,omitempty"`
// EndOfLifeDate - The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable.
EndOfLifeDate *date.Time `json:"endOfLifeDate,omitempty"`
Identifier *GalleryImageIdentifier `json:"identifier,omitempty"`
Recommended *RecommendedMachineConfiguration `json:"recommended,omitempty"`
Disallowed *Disallowed `json:"disallowed,omitempty"`
PurchasePlan *ImagePurchasePlan `json:"purchasePlan,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response. Possible values include: 'ProvisioningState1Creating', 'ProvisioningState1Updating', 'ProvisioningState1Failed', 'ProvisioningState1Succeeded', 'ProvisioningState1Deleting', 'ProvisioningState1Migrating'
ProvisioningState ProvisioningState1 `json:"provisioningState,omitempty"`
}GalleryImageProperties describes the properties of a gallery Image Definition.
func (gip GalleryImageProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageProperties.
type GalleryImageVersion struct {
autorest.Response `json:"-"`
*GalleryImageVersionProperties `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"`
}GalleryImageVersion specifies information about the gallery Image Version that you want to create or update.
func (giv GalleryImageVersion) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageVersion.
func (giv *GalleryImageVersion) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for GalleryImageVersion struct.
type GalleryImageVersionList struct {
autorest.Response `json:"-"`
// Value - A list of gallery Image Versions.
Value *[]GalleryImageVersion `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of gallery Image Versions. Call ListNext() with this to fetch the next page of gallery Image Versions.
NextLink *string `json:"nextLink,omitempty"`
}GalleryImageVersionList the List Gallery Image version operation response.
func (givl GalleryImageVersionList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type GalleryImageVersionListIterator struct {
// contains filtered or unexported fields
}GalleryImageVersionListIterator provides access to a complete listing of GalleryImageVersion values.
func NewGalleryImageVersionListIterator(page GalleryImageVersionListPage) GalleryImageVersionListIterator
Creates a new instance of the GalleryImageVersionListIterator type.
func (iter *GalleryImageVersionListIterator) 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 (iter *GalleryImageVersionListIterator) 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 (iter GalleryImageVersionListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GalleryImageVersionListIterator) Response() GalleryImageVersionList
Response returns the raw server response from the last page request.
func (iter GalleryImageVersionListIterator) Value() GalleryImageVersion
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type GalleryImageVersionListPage struct {
// contains filtered or unexported fields
}GalleryImageVersionListPage contains a page of GalleryImageVersion values.
func NewGalleryImageVersionListPage(cur GalleryImageVersionList, getNextPage func(context.Context, GalleryImageVersionList) (GalleryImageVersionList, error)) GalleryImageVersionListPage
Creates a new instance of the GalleryImageVersionListPage type.
func (page *GalleryImageVersionListPage) 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 (page *GalleryImageVersionListPage) 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 (page GalleryImageVersionListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GalleryImageVersionListPage) Response() GalleryImageVersionList
Response returns the raw server response from the last page request.
func (page GalleryImageVersionListPage) Values() []GalleryImageVersion
Values returns the slice of values for the current page or nil if there are no values.
type GalleryImageVersionProperties struct {
PublishingProfile *GalleryImageVersionPublishingProfile `json:"publishingProfile,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response. Possible values include: 'ProvisioningState2Creating', 'ProvisioningState2Updating', 'ProvisioningState2Failed', 'ProvisioningState2Succeeded', 'ProvisioningState2Deleting', 'ProvisioningState2Migrating'
ProvisioningState ProvisioningState2 `json:"provisioningState,omitempty"`
// StorageProfile - READ-ONLY
StorageProfile *GalleryImageVersionStorageProfile `json:"storageProfile,omitempty"`
// ReplicationStatus - READ-ONLY
ReplicationStatus *ReplicationStatus `json:"replicationStatus,omitempty"`
}GalleryImageVersionProperties describes the properties of a gallery Image Version.
func (givp GalleryImageVersionProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageVersionProperties.
type GalleryImageVersionPublishingProfile struct {
// ReplicaCount - The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable.
ReplicaCount *int32 `json:"replicaCount,omitempty"`
// ExcludeFromLatest - If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.
ExcludeFromLatest *bool `json:"excludeFromLatest,omitempty"`
// PublishedDate - READ-ONLY; The timestamp for when the gallery Image Version is published.
PublishedDate *date.Time `json:"publishedDate,omitempty"`
// EndOfLifeDate - The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable.
EndOfLifeDate *date.Time `json:"endOfLifeDate,omitempty"`
// TargetRegions - The target regions where the Image Version is going to be replicated to. This property is updatable.
TargetRegions *[]TargetRegion `json:"targetRegions,omitempty"`
Source *GalleryArtifactSource `json:"source,omitempty"`
}GalleryImageVersionPublishingProfile the publishing profile of a gallery Image Version.
func (givpp GalleryImageVersionPublishingProfile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryImageVersionPublishingProfile.
type GalleryImageVersionStorageProfile struct {
// OsDiskImage - READ-ONLY
OsDiskImage *GalleryOSDiskImage `json:"osDiskImage,omitempty"`
// DataDiskImages - READ-ONLY; A list of data disk images.
DataDiskImages *[]GalleryDataDiskImage `json:"dataDiskImages,omitempty"`
}GalleryImageVersionStorageProfile this is the storage profile of a gallery Image Version.
type GalleryImageVersionsClient struct {
BaseClient
}GalleryImageVersionsClient is the compute Client
func NewGalleryImageVersionsClient(subscriptionID string) GalleryImageVersionsClient
NewGalleryImageVersionsClient creates an instance of the GalleryImageVersionsClient client.
func NewGalleryImageVersionsClientWithBaseURI(baseURI string, subscriptionID string) GalleryImageVersionsClient
NewGalleryImageVersionsClientWithBaseURI creates an instance of the GalleryImageVersionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client GalleryImageVersionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string, galleryImageVersion GalleryImageVersion) (result GalleryImageVersionsCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a gallery Image Version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition resides. galleryImageName - the name of the gallery Image Definition in which the Image Version is to be created. galleryImageVersionName - the name of the gallery Image Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: <MajorVersion>.<MinorVersion>.<Patch> galleryImageVersion - parameters supplied to the create or update gallery Image Version operation.
func (client GalleryImageVersionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string, galleryImageVersion GalleryImageVersion) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GalleryImageVersionsClient) CreateOrUpdateResponder(resp *http.Response) (result GalleryImageVersion, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GalleryImageVersionsClient) CreateOrUpdateSender(req *http.Request) (future GalleryImageVersionsCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GalleryImageVersionsClient) Delete(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string) (result GalleryImageVersionsDeleteFuture, err error)
Delete delete a gallery Image Version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition resides. galleryImageName - the name of the gallery Image Definition in which the Image Version resides. galleryImageVersionName - the name of the gallery Image Version to be deleted.
func (client GalleryImageVersionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GalleryImageVersionsClient) 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 (client GalleryImageVersionsClient) DeleteSender(req *http.Request) (future GalleryImageVersionsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GalleryImageVersionsClient) Get(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string, expand ReplicationStatusTypes) (result GalleryImageVersion, err error)
Get retrieves information about a gallery Image Version. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition resides. galleryImageName - the name of the gallery Image Definition in which the Image Version resides. galleryImageVersionName - the name of the gallery Image Version to be retrieved. expand - the expand expression to apply on the operation.
func (client GalleryImageVersionsClient) GetPreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImageVersionName string, expand ReplicationStatusTypes) (*http.Request, error)
GetPreparer prepares the Get request.
func (client GalleryImageVersionsClient) GetResponder(resp *http.Response) (result GalleryImageVersion, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GalleryImageVersionsClient) ListByGalleryImage(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (result GalleryImageVersionListPage, err error)
ListByGalleryImage list gallery Image Versions in a gallery Image Definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition resides. galleryImageName - the name of the Shared Image Gallery Image Definition from which the Image Versions are to be listed.
func (client GalleryImageVersionsClient) ListByGalleryImageComplete(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (result GalleryImageVersionListIterator, err error)
ListByGalleryImageComplete enumerates all values, automatically crossing page boundaries as required.
func (client GalleryImageVersionsClient) ListByGalleryImagePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (*http.Request, error)
ListByGalleryImagePreparer prepares the ListByGalleryImage request.
func (client GalleryImageVersionsClient) ListByGalleryImageResponder(resp *http.Response) (result GalleryImageVersionList, err error)
ListByGalleryImageResponder handles the response to the ListByGalleryImage request. The method always closes the http.Response Body.
func (client GalleryImageVersionsClient) ListByGalleryImageSender(req *http.Request) (*http.Response, error)
ListByGalleryImageSender sends the ListByGalleryImage request. The method will close the http.Response Body if it receives an error.
type GalleryImageVersionsCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryImageVersionsClient) (GalleryImageVersion, error)
}GalleryImageVersionsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryImageVersionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryImageVersionsClient) (autorest.Response, error)
}GalleryImageVersionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryImagesClient struct {
BaseClient
}GalleryImagesClient is the compute Client
func NewGalleryImagesClient(subscriptionID string) GalleryImagesClient
NewGalleryImagesClient creates an instance of the GalleryImagesClient client.
func NewGalleryImagesClientWithBaseURI(baseURI string, subscriptionID string) GalleryImagesClient
NewGalleryImagesClientWithBaseURI creates an instance of the GalleryImagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client GalleryImagesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImage GalleryImage) (result GalleryImagesCreateOrUpdateFuture, err error)
CreateOrUpdate create or update a gallery Image Definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition is to be created. galleryImageName - the name of the gallery Image Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. galleryImage - parameters supplied to the create or update gallery image operation.
func (client GalleryImagesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string, galleryImage GalleryImage) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client GalleryImagesClient) CreateOrUpdateResponder(resp *http.Response) (result GalleryImage, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client GalleryImagesClient) CreateOrUpdateSender(req *http.Request) (future GalleryImagesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client GalleryImagesClient) Delete(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (result GalleryImagesDeleteFuture, err error)
Delete delete a gallery image. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery in which the Image Definition is to be deleted. galleryImageName - the name of the gallery Image Definition to be deleted.
func (client GalleryImagesClient) DeletePreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client GalleryImagesClient) 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 (client GalleryImagesClient) DeleteSender(req *http.Request) (future GalleryImagesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client GalleryImagesClient) Get(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (result GalleryImage, err error)
Get retrieves information about a gallery Image Definition. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery from which the Image Definitions are to be retrieved. galleryImageName - the name of the gallery Image Definition to be retrieved.
func (client GalleryImagesClient) GetPreparer(ctx context.Context, resourceGroupName string, galleryName string, galleryImageName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client GalleryImagesClient) GetResponder(resp *http.Response) (result GalleryImage, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client GalleryImagesClient) ListByGallery(ctx context.Context, resourceGroupName string, galleryName string) (result GalleryImageListPage, err error)
ListByGallery list gallery Image Definitions in a gallery. Parameters: resourceGroupName - the name of the resource group. galleryName - the name of the Shared Image Gallery from which Image Definitions are to be listed.
func (client GalleryImagesClient) ListByGalleryComplete(ctx context.Context, resourceGroupName string, galleryName string) (result GalleryImageListIterator, err error)
ListByGalleryComplete enumerates all values, automatically crossing page boundaries as required.
func (client GalleryImagesClient) ListByGalleryPreparer(ctx context.Context, resourceGroupName string, galleryName string) (*http.Request, error)
ListByGalleryPreparer prepares the ListByGallery request.
func (client GalleryImagesClient) ListByGalleryResponder(resp *http.Response) (result GalleryImageList, err error)
ListByGalleryResponder handles the response to the ListByGallery request. The method always closes the http.Response Body.
ListByGallerySender sends the ListByGallery request. The method will close the http.Response Body if it receives an error.
type GalleryImagesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryImagesClient) (GalleryImage, error)
}GalleryImagesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryImagesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(GalleryImagesClient) (autorest.Response, error)
}GalleryImagesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type GalleryList struct {
autorest.Response `json:"-"`
// Value - A list of galleries.
Value *[]Gallery `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries.
NextLink *string `json:"nextLink,omitempty"`
}GalleryList the List Galleries operation response.
func (gl GalleryList) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type GalleryListIterator struct {
// contains filtered or unexported fields
}GalleryListIterator provides access to a complete listing of Gallery values.
func NewGalleryListIterator(page GalleryListPage) GalleryListIterator
Creates a new instance of the GalleryListIterator type.
func (iter *GalleryListIterator) 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 (iter *GalleryListIterator) 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 (iter GalleryListIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter GalleryListIterator) Response() GalleryList
Response returns the raw server response from the last page request.
func (iter GalleryListIterator) Value() Gallery
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type GalleryListPage struct {
// contains filtered or unexported fields
}GalleryListPage contains a page of Gallery values.
func NewGalleryListPage(cur GalleryList, getNextPage func(context.Context, GalleryList) (GalleryList, error)) GalleryListPage
Creates a new instance of the GalleryListPage type.
func (page *GalleryListPage) 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 (page *GalleryListPage) 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 (page GalleryListPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page GalleryListPage) Response() GalleryList
Response returns the raw server response from the last page request.
func (page GalleryListPage) Values() []Gallery
Values returns the slice of values for the current page or nil if there are no values.
type GalleryOSDiskImage struct {
// SizeInGB - READ-ONLY; This property indicates the size of the VHD to be created.
SizeInGB *int32 `json:"sizeInGB,omitempty"`
// HostCaching - READ-ONLY; The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'. Possible values include: 'HostCachingNone', 'HostCachingReadOnly', 'HostCachingReadWrite'
HostCaching HostCaching `json:"hostCaching,omitempty"`
}GalleryOSDiskImage this is the OS disk image.
type GalleryProperties struct {
// Description - The description of this Shared Image Gallery resource. This property is updatable.
Description *string `json:"description,omitempty"`
Identifier *GalleryIdentifier `json:"identifier,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state, which only appears in the response. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateUpdating', 'ProvisioningStateFailed', 'ProvisioningStateSucceeded', 'ProvisioningStateDeleting', 'ProvisioningStateMigrating'
ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}GalleryProperties describes the properties of a Shared Image Gallery.
func (gp GalleryProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for GalleryProperties.
type GrantAccessData struct {
// Access - Possible values include: 'None', 'Read'
Access AccessLevel `json:"access,omitempty"`
// DurationInSeconds - Time duration in seconds until the SAS access expires.
DurationInSeconds *int32 `json:"durationInSeconds,omitempty"`
}GrantAccessData data used for requesting a SAS.
type HardwareProfile struct {
// VMSize - Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> The available VM sizes depend on region and availability set. For a list of available sizes use these APIs: <br><br> [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes) <br><br> [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list) <br><br> [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). Possible values include: 'VirtualMachineSizeTypesBasicA0', 'VirtualMachineSizeTypesBasicA1', 'VirtualMachineSizeTypesBasicA2', 'VirtualMachineSizeTypesBasicA3', 'VirtualMachineSizeTypesBasicA4', 'VirtualMachineSizeTypesStandardA0', 'VirtualMachineSizeTypesStandardA1', 'VirtualMachineSizeTypesStandardA2', 'VirtualMachineSizeTypesStandardA3', 'VirtualMachineSizeTypesStandardA4', 'VirtualMachineSizeTypesStandardA5', 'VirtualMachineSizeTypesStandardA6', 'VirtualMachineSizeTypesStandardA7', 'VirtualMachineSizeTypesStandardA8', 'VirtualMachineSizeTypesStandardA9', 'VirtualMachineSizeTypesStandardA10', 'VirtualMachineSizeTypesStandardA11', 'VirtualMachineSizeTypesStandardA1V2', 'VirtualMachineSizeTypesStandardA2V2', 'VirtualMachineSizeTypesStandardA4V2', 'VirtualMachineSizeTypesStandardA8V2', 'VirtualMachineSizeTypesStandardA2mV2', 'VirtualMachineSizeTypesStandardA4mV2', 'VirtualMachineSizeTypesStandardA8mV2', 'VirtualMachineSizeTypesStandardB1s', 'VirtualMachineSizeTypesStandardB1ms', 'VirtualMachineSizeTypesStandardB2s', 'VirtualMachineSizeTypesStandardB2ms', 'VirtualMachineSizeTypesStandardB4ms', 'VirtualMachineSizeTypesStandardB8ms', 'VirtualMachineSizeTypesStandardD1', 'VirtualMachineSizeTypesStandardD2', 'VirtualMachineSizeTypesStandardD3', 'VirtualMachineSizeTypesStandardD4', 'VirtualMachineSizeTypesStandardD11', 'VirtualMachineSizeTypesStandardD12', 'VirtualMachineSizeTypesStandardD13', 'VirtualMachineSizeTypesStandardD14', 'VirtualMachineSizeTypesStandardD1V2', 'VirtualMachineSizeTypesStandardD2V2', 'VirtualMachineSizeTypesStandardD3V2', 'VirtualMachineSizeTypesStandardD4V2', 'VirtualMachineSizeTypesStandardD5V2', 'VirtualMachineSizeTypesStandardD2V3', 'VirtualMachineSizeTypesStandardD4V3', 'VirtualMachineSizeTypesStandardD8V3', 'VirtualMachineSizeTypesStandardD16V3', 'VirtualMachineSizeTypesStandardD32V3', 'VirtualMachineSizeTypesStandardD64V3', 'VirtualMachineSizeTypesStandardD2sV3', 'VirtualMachineSizeTypesStandardD4sV3', 'VirtualMachineSizeTypesStandardD8sV3', 'VirtualMachineSizeTypesStandardD16sV3', 'VirtualMachineSizeTypesStandardD32sV3', 'VirtualMachineSizeTypesStandardD64sV3', 'VirtualMachineSizeTypesStandardD11V2', 'VirtualMachineSizeTypesStandardD12V2', 'VirtualMachineSizeTypesStandardD13V2', 'VirtualMachineSizeTypesStandardD14V2', 'VirtualMachineSizeTypesStandardD15V2', 'VirtualMachineSizeTypesStandardDS1', 'VirtualMachineSizeTypesStandardDS2', 'VirtualMachineSizeTypesStandardDS3', 'VirtualMachineSizeTypesStandardDS4', 'VirtualMachineSizeTypesStandardDS11', 'VirtualMachineSizeTypesStandardDS12', 'VirtualMachineSizeTypesStandardDS13', 'VirtualMachineSizeTypesStandardDS14', 'VirtualMachineSizeTypesStandardDS1V2', 'VirtualMachineSizeTypesStandardDS2V2', 'VirtualMachineSizeTypesStandardDS3V2', 'VirtualMachineSizeTypesStandardDS4V2', 'VirtualMachineSizeTypesStandardDS5V2', 'VirtualMachineSizeTypesStandardDS11V2', 'VirtualMachineSizeTypesStandardDS12V2', 'VirtualMachineSizeTypesStandardDS13V2', 'VirtualMachineSizeTypesStandardDS14V2', 'VirtualMachineSizeTypesStandardDS15V2', 'VirtualMachineSizeTypesStandardDS134V2', 'VirtualMachineSizeTypesStandardDS132V2', 'VirtualMachineSizeTypesStandardDS148V2', 'VirtualMachineSizeTypesStandardDS144V2', 'VirtualMachineSizeTypesStandardE2V3', 'VirtualMachineSizeTypesStandardE4V3', 'VirtualMachineSizeTypesStandardE8V3', 'VirtualMachineSizeTypesStandardE16V3', 'VirtualMachineSizeTypesStandardE32V3', 'VirtualMachineSizeTypesStandardE64V3', 'VirtualMachineSizeTypesStandardE2sV3', 'VirtualMachineSizeTypesStandardE4sV3', 'VirtualMachineSizeTypesStandardE8sV3', 'VirtualMachineSizeTypesStandardE16sV3', 'VirtualMachineSizeTypesStandardE32sV3', 'VirtualMachineSizeTypesStandardE64sV3', 'VirtualMachineSizeTypesStandardE3216V3', 'VirtualMachineSizeTypesStandardE328sV3', 'VirtualMachineSizeTypesStandardE6432sV3', 'VirtualMachineSizeTypesStandardE6416sV3', 'VirtualMachineSizeTypesStandardF1', 'VirtualMachineSizeTypesStandardF2', 'VirtualMachineSizeTypesStandardF4', 'VirtualMachineSizeTypesStandardF8', 'VirtualMachineSizeTypesStandardF16', 'VirtualMachineSizeTypesStandardF1s', 'VirtualMachineSizeTypesStandardF2s', 'VirtualMachineSizeTypesStandardF4s', 'VirtualMachineSizeTypesStandardF8s', 'VirtualMachineSizeTypesStandardF16s', 'VirtualMachineSizeTypesStandardF2sV2', 'VirtualMachineSizeTypesStandardF4sV2', 'VirtualMachineSizeTypesStandardF8sV2', 'VirtualMachineSizeTypesStandardF16sV2', 'VirtualMachineSizeTypesStandardF32sV2', 'VirtualMachineSizeTypesStandardF64sV2', 'VirtualMachineSizeTypesStandardF72sV2', 'VirtualMachineSizeTypesStandardG1', 'VirtualMachineSizeTypesStandardG2', 'VirtualMachineSizeTypesStandardG3', 'VirtualMachineSizeTypesStandardG4', 'VirtualMachineSizeTypesStandardG5', 'VirtualMachineSizeTypesStandardGS1', 'VirtualMachineSizeTypesStandardGS2', 'VirtualMachineSizeTypesStandardGS3', 'VirtualMachineSizeTypesStandardGS4', 'VirtualMachineSizeTypesStandardGS5', 'VirtualMachineSizeTypesStandardGS48', 'VirtualMachineSizeTypesStandardGS44', 'VirtualMachineSizeTypesStandardGS516', 'VirtualMachineSizeTypesStandardGS58', 'VirtualMachineSizeTypesStandardH8', 'VirtualMachineSizeTypesStandardH16', 'VirtualMachineSizeTypesStandardH8m', 'VirtualMachineSizeTypesStandardH16m', 'VirtualMachineSizeTypesStandardH16r', 'VirtualMachineSizeTypesStandardH16mr', 'VirtualMachineSizeTypesStandardL4s', 'VirtualMachineSizeTypesStandardL8s', 'VirtualMachineSizeTypesStandardL16s', 'VirtualMachineSizeTypesStandardL32s', 'VirtualMachineSizeTypesStandardM64s', 'VirtualMachineSizeTypesStandardM64ms', 'VirtualMachineSizeTypesStandardM128s', 'VirtualMachineSizeTypesStandardM128ms', 'VirtualMachineSizeTypesStandardM6432ms', 'VirtualMachineSizeTypesStandardM6416ms', 'VirtualMachineSizeTypesStandardM12864ms', 'VirtualMachineSizeTypesStandardM12832ms', 'VirtualMachineSizeTypesStandardNC6', 'VirtualMachineSizeTypesStandardNC12', 'VirtualMachineSizeTypesStandardNC24', 'VirtualMachineSizeTypesStandardNC24r', 'VirtualMachineSizeTypesStandardNC6sV2', 'VirtualMachineSizeTypesStandardNC12sV2', 'VirtualMachineSizeTypesStandardNC24sV2', 'VirtualMachineSizeTypesStandardNC24rsV2', 'VirtualMachineSizeTypesStandardNC6sV3', 'VirtualMachineSizeTypesStandardNC12sV3', 'VirtualMachineSizeTypesStandardNC24sV3', 'VirtualMachineSizeTypesStandardNC24rsV3', 'VirtualMachineSizeTypesStandardND6s', 'VirtualMachineSizeTypesStandardND12s', 'VirtualMachineSizeTypesStandardND24s', 'VirtualMachineSizeTypesStandardND24rs', 'VirtualMachineSizeTypesStandardNV6', 'VirtualMachineSizeTypesStandardNV12', 'VirtualMachineSizeTypesStandardNV24'
VMSize VirtualMachineSizeTypes `json:"vmSize,omitempty"`
}HardwareProfile specifies the hardware settings for the virtual machine.
HostCaching enumerates the values for host caching.
const (
// HostCachingNone ...
HostCachingNone HostCaching = "None"
// HostCachingReadOnly ...
HostCachingReadOnly HostCaching = "ReadOnly"
// HostCachingReadWrite ...
HostCachingReadWrite HostCaching = "ReadWrite"
)func PossibleHostCachingValues() []HostCaching
PossibleHostCachingValues returns an array of possible values for the HostCaching const type.
IPVersion enumerates the values for ip version.
PossibleIPVersionValues returns an array of possible values for the IPVersion const type.
type Image struct {
autorest.Response `json:"-"`
*ImageProperties `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"`
}Image the source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
MarshalJSON is the custom marshaler for Image.
UnmarshalJSON is the custom unmarshaler for Image struct.
type ImageDataDisk struct {
// Lun - Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
Lun *int32 `json:"lun,omitempty"`
// Snapshot - The snapshot.
Snapshot *SubResource `json:"snapshot,omitempty"`
// ManagedDisk - The managedDisk.
ManagedDisk *SubResource `json:"managedDisk,omitempty"`
// BlobURI - The Virtual Hard Disk.
BlobURI *string `json:"blobUri,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// DiskSizeGB - Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// StorageAccountType - Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS', 'StorageAccountTypesUltraSSDLRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
}ImageDataDisk describes a data disk.
type ImageDiskReference struct {
// ID - A relative uri containing either a Platform Image Repository or user image reference.
ID *string `json:"id,omitempty"`
// Lun - If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
Lun *int32 `json:"lun,omitempty"`
}ImageDiskReference the source image used for creating the disk.
type ImageListResult struct {
autorest.Response `json:"-"`
// Value - The list of Images.
Value *[]Image `json:"value,omitempty"`
// NextLink - The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images.
NextLink *string `json:"nextLink,omitempty"`
}ImageListResult the List Image operation response.
func (ilr ImageListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ImageListResultIterator struct {
// contains filtered or unexported fields
}ImageListResultIterator provides access to a complete listing of Image values.
func NewImageListResultIterator(page ImageListResultPage) ImageListResultIterator
Creates a new instance of the ImageListResultIterator type.
func (iter *ImageListResultIterator) 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 (iter *ImageListResultIterator) 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 (iter ImageListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ImageListResultIterator) Response() ImageListResult
Response returns the raw server response from the last page request.
func (iter ImageListResultIterator) Value() Image
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ImageListResultPage struct {
// contains filtered or unexported fields
}ImageListResultPage contains a page of Image values.
func NewImageListResultPage(cur ImageListResult, getNextPage func(context.Context, ImageListResult) (ImageListResult, error)) ImageListResultPage
Creates a new instance of the ImageListResultPage type.
func (page *ImageListResultPage) 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 (page *ImageListResultPage) 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 (page ImageListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ImageListResultPage) Response() ImageListResult
Response returns the raw server response from the last page request.
func (page ImageListResultPage) Values() []Image
Values returns the slice of values for the current page or nil if there are no values.
type ImageOSDisk struct {
// OsType - This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. Possible values include: 'Windows', 'Linux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// OsState - The OS State. Possible values include: 'Generalized', 'Specialized'
OsState OperatingSystemStateTypes `json:"osState,omitempty"`
// Snapshot - The snapshot.
Snapshot *SubResource `json:"snapshot,omitempty"`
// ManagedDisk - The managedDisk.
ManagedDisk *SubResource `json:"managedDisk,omitempty"`
// BlobURI - The Virtual Hard Disk.
BlobURI *string `json:"blobUri,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// DiskSizeGB - Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// StorageAccountType - Specifies the storage account type for the managed disk. UltraSSD_LRS cannot be used with OS Disk. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS', 'StorageAccountTypesUltraSSDLRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
}ImageOSDisk describes an Operating System disk.
type ImageProperties struct {
// SourceVirtualMachine - The source virtual machine from which Image is created.
SourceVirtualMachine *SubResource `json:"sourceVirtualMachine,omitempty"`
// StorageProfile - Specifies the storage settings for the virtual machine disks.
StorageProfile *ImageStorageProfile `json:"storageProfile,omitempty"`
// ProvisioningState - READ-ONLY; The provisioning state.
ProvisioningState *string `json:"provisioningState,omitempty"`
}ImageProperties describes the properties of an Image.
func (IP ImageProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageProperties.
type ImagePurchasePlan struct {
// Name - The plan ID.
Name *string `json:"name,omitempty"`
// Publisher - The publisher ID.
Publisher *string `json:"publisher,omitempty"`
// Product - The product ID.
Product *string `json:"product,omitempty"`
}ImagePurchasePlan describes the gallery Image Definition purchase plan. This is used by marketplace images.
type ImageReference struct {
// Publisher - The image publisher.
Publisher *string `json:"publisher,omitempty"`
// Offer - Specifies the offer of the platform image or marketplace image used to create the virtual machine.
Offer *string `json:"offer,omitempty"`
// Sku - The image SKU.
Sku *string `json:"sku,omitempty"`
// Version - Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available.
Version *string `json:"version,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}ImageReference specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.
type ImageStorageProfile struct {
// OsDisk - Specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
OsDisk *ImageOSDisk `json:"osDisk,omitempty"`
// DataDisks - Specifies the parameters that are used to add a data disk to a virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
DataDisks *[]ImageDataDisk `json:"dataDisks,omitempty"`
// ZoneResilient - Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).
ZoneResilient *bool `json:"zoneResilient,omitempty"`
}ImageStorageProfile describes a storage profile.
type ImageUpdate struct {
*ImageProperties `json:"properties,omitempty"`
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}ImageUpdate the source user image virtual hard disk. Only tags may be updated.
func (iu ImageUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ImageUpdate.
func (iu *ImageUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ImageUpdate struct.
type ImagesClient struct {
BaseClient
}ImagesClient is the compute Client
func NewImagesClient(subscriptionID string) ImagesClient
NewImagesClient creates an instance of the ImagesClient client.
func NewImagesClientWithBaseURI(baseURI string, subscriptionID string) ImagesClient
NewImagesClientWithBaseURI creates an instance of the ImagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ImagesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, imageName string, parameters Image) (result ImagesCreateOrUpdateFuture, err error)
CreateOrUpdate create or update an image. Parameters: resourceGroupName - the name of the resource group. imageName - the name of the image. parameters - parameters supplied to the Create Image operation.
func (client ImagesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, imageName string, parameters Image) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ImagesClient) CreateOrUpdateSender(req *http.Request) (future ImagesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) Delete(ctx context.Context, resourceGroupName string, imageName string) (result ImagesDeleteFuture, err error)
Delete deletes an Image. Parameters: resourceGroupName - the name of the resource group. imageName - the name of the image.
func (client ImagesClient) DeletePreparer(ctx context.Context, resourceGroupName string, imageName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ImagesClient) 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 (client ImagesClient) DeleteSender(req *http.Request) (future ImagesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) Get(ctx context.Context, resourceGroupName string, imageName string, expand string) (result Image, err error)
Get gets an image. Parameters: resourceGroupName - the name of the resource group. imageName - the name of the image. expand - the expand expression to apply on the operation.
func (client ImagesClient) GetPreparer(ctx context.Context, resourceGroupName string, imageName string, expand string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) List(ctx context.Context) (result ImageListResultPage, err error)
List gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.
func (client ImagesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ImageListResultPage, err error)
ListByResourceGroup gets the list of images under a resource group. Parameters: resourceGroupName - the name of the resource group.
func (client ImagesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ImageListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ImagesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (client ImagesClient) ListByResourceGroupResponder(resp *http.Response) (result ImageListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) ListComplete(ctx context.Context) (result ImageListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
func (client ImagesClient) ListResponder(resp *http.Response) (result ImageListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (client ImagesClient) Update(ctx context.Context, resourceGroupName string, imageName string, parameters ImageUpdate) (result ImagesUpdateFuture, err error)
Update update an image. Parameters: resourceGroupName - the name of the resource group. imageName - the name of the image. parameters - parameters supplied to the Update Image operation.
func (client ImagesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, imageName string, parameters ImageUpdate) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ImagesClient) UpdateSender(req *http.Request) (future ImagesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type ImagesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ImagesClient) (Image, error)
}ImagesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ImagesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ImagesClient) (autorest.Response, error)
}ImagesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ImagesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ImagesClient) (Image, error)
}ImagesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type InnerError struct {
// Exceptiontype - The exception type.
Exceptiontype *string `json:"exceptiontype,omitempty"`
// Errordetail - The internal error message or exception dump.
Errordetail *string `json:"errordetail,omitempty"`
}InnerError inner error details.
type InstanceViewStatus struct {
// Code - The status code.
Code *string `json:"code,omitempty"`
// Level - The level code. Possible values include: 'Info', 'Warning', 'Error'
Level StatusLevelTypes `json:"level,omitempty"`
// DisplayStatus - The short localizable label for the status.
DisplayStatus *string `json:"displayStatus,omitempty"`
// Message - The detailed status message, including for alerts and error messages.
Message *string `json:"message,omitempty"`
// Time - The time of the status.
Time *date.Time `json:"time,omitempty"`
}InstanceViewStatus instance view status.
InstanceViewTypes enumerates the values for instance view types.
const (
// InstanceView ...
InstanceView InstanceViewTypes = "instanceView"
)func PossibleInstanceViewTypesValues() []InstanceViewTypes
PossibleInstanceViewTypesValues returns an array of possible values for the InstanceViewTypes const type.
IntervalInMins enumerates the values for interval in mins.
const (
// FiveMins ...
FiveMins IntervalInMins = "FiveMins"
// SixtyMins ...
SixtyMins IntervalInMins = "SixtyMins"
// ThirtyMins ...
ThirtyMins IntervalInMins = "ThirtyMins"
// ThreeMins ...
ThreeMins IntervalInMins = "ThreeMins"
)func PossibleIntervalInMinsValues() []IntervalInMins
PossibleIntervalInMinsValues returns an array of possible values for the IntervalInMins const type.
type KeyVaultAndKeyReference struct {
// SourceVault - Resource id of the KeyVault containing the key or secret
SourceVault *SourceVault `json:"sourceVault,omitempty"`
// KeyURL - Url pointing to a key or secret in KeyVault
KeyURL *string `json:"keyUrl,omitempty"`
}KeyVaultAndKeyReference key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey
type KeyVaultAndSecretReference struct {
// SourceVault - Resource id of the KeyVault containing the key or secret
SourceVault *SourceVault `json:"sourceVault,omitempty"`
// SecretURL - Url pointing to a key or secret in KeyVault
SecretURL *string `json:"secretUrl,omitempty"`
}KeyVaultAndSecretReference key Vault Secret Url and vault id of the encryption key
type KeyVaultKeyReference struct {
// KeyURL - The URL referencing a key encryption key in Key Vault.
KeyURL *string `json:"keyUrl,omitempty"`
// SourceVault - The relative URL of the Key Vault containing the key.
SourceVault *SubResource `json:"sourceVault,omitempty"`
}KeyVaultKeyReference describes a reference to Key Vault Key
type KeyVaultSecretReference struct {
// SecretURL - The URL referencing a secret in a Key Vault.
SecretURL *string `json:"secretUrl,omitempty"`
// SourceVault - The relative URL of the Key Vault containing the secret.
SourceVault *SubResource `json:"sourceVault,omitempty"`
}KeyVaultSecretReference describes a reference to Key Vault Secret
type LinuxConfiguration struct {
// DisablePasswordAuthentication - Specifies whether password authentication should be disabled.
DisablePasswordAuthentication *bool `json:"disablePasswordAuthentication,omitempty"`
// SSH - Specifies the ssh key configuration for a Linux OS.
SSH *SSHConfiguration `json:"ssh,omitempty"`
// ProvisionVMAgent - Indicates whether virtual machine agent should be provisioned on the virtual machine. <br><br> When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
ProvisionVMAgent *bool `json:"provisionVMAgent,omitempty"`
}LinuxConfiguration specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) <br><br> For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
type ListUsagesResult struct {
autorest.Response `json:"-"`
// Value - The list of compute resource usages.
Value *[]Usage `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information.
NextLink *string `json:"nextLink,omitempty"`
}ListUsagesResult the List Usages operation response.
func (lur ListUsagesResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ListUsagesResultIterator struct {
// contains filtered or unexported fields
}ListUsagesResultIterator provides access to a complete listing of Usage values.
func NewListUsagesResultIterator(page ListUsagesResultPage) ListUsagesResultIterator
Creates a new instance of the ListUsagesResultIterator type.
func (iter *ListUsagesResultIterator) 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 (iter *ListUsagesResultIterator) 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 (iter ListUsagesResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListUsagesResultIterator) Response() ListUsagesResult
Response returns the raw server response from the last page request.
func (iter ListUsagesResultIterator) Value() Usage
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ListUsagesResultPage struct {
// contains filtered or unexported fields
}ListUsagesResultPage contains a page of Usage values.
func NewListUsagesResultPage(cur ListUsagesResult, getNextPage func(context.Context, ListUsagesResult) (ListUsagesResult, error)) ListUsagesResultPage
Creates a new instance of the ListUsagesResultPage type.
func (page *ListUsagesResultPage) 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 (page *ListUsagesResultPage) 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 (page ListUsagesResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListUsagesResultPage) Response() ListUsagesResult
Response returns the raw server response from the last page request.
func (page ListUsagesResultPage) Values() []Usage
Values returns the slice of values for the current page or nil if there are no values.
type ListVirtualMachineExtensionImage struct {
autorest.Response `json:"-"`
Value *[]VirtualMachineExtensionImage `json:"value,omitempty"`
}ListVirtualMachineExtensionImage ...
type ListVirtualMachineImageResource struct {
autorest.Response `json:"-"`
Value *[]VirtualMachineImageResource `json:"value,omitempty"`
}ListVirtualMachineImageResource ...
type LogAnalyticsClient struct {
BaseClient
}LogAnalyticsClient is the compute Client
func NewLogAnalyticsClient(subscriptionID string) LogAnalyticsClient
NewLogAnalyticsClient creates an instance of the LogAnalyticsClient client.
func NewLogAnalyticsClientWithBaseURI(baseURI string, subscriptionID string) LogAnalyticsClient
NewLogAnalyticsClientWithBaseURI creates an instance of the LogAnalyticsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client LogAnalyticsClient) ExportRequestRateByInterval(ctx context.Context, parameters RequestRateByIntervalInput, location string) (result LogAnalyticsExportRequestRateByIntervalFuture, err error)
ExportRequestRateByInterval export logs that show Api requests made by this subscription in the given time window to show throttling activities. Parameters: parameters - parameters supplied to the LogAnalytics getRequestRateByInterval Api. location - the location upon which virtual-machine-sizes is queried.
func (client LogAnalyticsClient) ExportRequestRateByIntervalPreparer(ctx context.Context, parameters RequestRateByIntervalInput, location string) (*http.Request, error)
ExportRequestRateByIntervalPreparer prepares the ExportRequestRateByInterval request.
func (client LogAnalyticsClient) ExportRequestRateByIntervalResponder(resp *http.Response) (result LogAnalyticsOperationResult, err error)
ExportRequestRateByIntervalResponder handles the response to the ExportRequestRateByInterval request. The method always closes the http.Response Body.
func (client LogAnalyticsClient) ExportRequestRateByIntervalSender(req *http.Request) (future LogAnalyticsExportRequestRateByIntervalFuture, err error)
ExportRequestRateByIntervalSender sends the ExportRequestRateByInterval request. The method will close the http.Response Body if it receives an error.
func (client LogAnalyticsClient) ExportThrottledRequests(ctx context.Context, parameters ThrottledRequestsInput, location string) (result LogAnalyticsExportThrottledRequestsFuture, err error)
ExportThrottledRequests export logs that show total throttled Api requests for this subscription in the given time window. Parameters: parameters - parameters supplied to the LogAnalytics getThrottledRequests Api. location - the location upon which virtual-machine-sizes is queried.
func (client LogAnalyticsClient) ExportThrottledRequestsPreparer(ctx context.Context, parameters ThrottledRequestsInput, location string) (*http.Request, error)
ExportThrottledRequestsPreparer prepares the ExportThrottledRequests request.
func (client LogAnalyticsClient) ExportThrottledRequestsResponder(resp *http.Response) (result LogAnalyticsOperationResult, err error)
ExportThrottledRequestsResponder handles the response to the ExportThrottledRequests request. The method always closes the http.Response Body.
func (client LogAnalyticsClient) ExportThrottledRequestsSender(req *http.Request) (future LogAnalyticsExportThrottledRequestsFuture, err error)
ExportThrottledRequestsSender sends the ExportThrottledRequests request. The method will close the http.Response Body if it receives an error.
type LogAnalyticsExportRequestRateByIntervalFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LogAnalyticsClient) (LogAnalyticsOperationResult, error)
}LogAnalyticsExportRequestRateByIntervalFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LogAnalyticsExportThrottledRequestsFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(LogAnalyticsClient) (LogAnalyticsOperationResult, error)
}LogAnalyticsExportThrottledRequestsFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type LogAnalyticsInputBase struct {
// BlobContainerSasURI - SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
BlobContainerSasURI *string `json:"blobContainerSasUri,omitempty"`
// FromTime - From time of the query
FromTime *date.Time `json:"fromTime,omitempty"`
// ToTime - To time of the query
ToTime *date.Time `json:"toTime,omitempty"`
// GroupByThrottlePolicy - Group query result by Throttle Policy applied.
GroupByThrottlePolicy *bool `json:"groupByThrottlePolicy,omitempty"`
// GroupByOperationName - Group query result by Operation Name.
GroupByOperationName *bool `json:"groupByOperationName,omitempty"`
// GroupByResourceName - Group query result by Resource Name.
GroupByResourceName *bool `json:"groupByResourceName,omitempty"`
}LogAnalyticsInputBase api input base class for LogAnalytics Api.
type LogAnalyticsOperationResult struct {
autorest.Response `json:"-"`
// Properties - READ-ONLY; LogAnalyticsOutput
Properties *LogAnalyticsOutput `json:"properties,omitempty"`
}LogAnalyticsOperationResult logAnalytics operation status response
type LogAnalyticsOutput struct {
// Output - READ-ONLY; Output file Uri path to blob container.
Output *string `json:"output,omitempty"`
}LogAnalyticsOutput logAnalytics output properties
MaintenanceOperationResultCodeTypes enumerates the values for maintenance operation result code types.
const (
// MaintenanceOperationResultCodeTypesMaintenanceAborted ...
MaintenanceOperationResultCodeTypesMaintenanceAborted MaintenanceOperationResultCodeTypes = "MaintenanceAborted"
// MaintenanceOperationResultCodeTypesMaintenanceCompleted ...
MaintenanceOperationResultCodeTypesMaintenanceCompleted MaintenanceOperationResultCodeTypes = "MaintenanceCompleted"
// MaintenanceOperationResultCodeTypesNone ...
MaintenanceOperationResultCodeTypesNone MaintenanceOperationResultCodeTypes = "None"
// MaintenanceOperationResultCodeTypesRetryLater ...
MaintenanceOperationResultCodeTypesRetryLater MaintenanceOperationResultCodeTypes = "RetryLater"
)func PossibleMaintenanceOperationResultCodeTypesValues() []MaintenanceOperationResultCodeTypes
PossibleMaintenanceOperationResultCodeTypesValues returns an array of possible values for the MaintenanceOperationResultCodeTypes const type.
type MaintenanceRedeployStatus struct {
// IsCustomerInitiatedMaintenanceAllowed - True, if customer is allowed to perform Maintenance.
IsCustomerInitiatedMaintenanceAllowed *bool `json:"isCustomerInitiatedMaintenanceAllowed,omitempty"`
// PreMaintenanceWindowStartTime - Start Time for the Pre Maintenance Window.
PreMaintenanceWindowStartTime *date.Time `json:"preMaintenanceWindowStartTime,omitempty"`
// PreMaintenanceWindowEndTime - End Time for the Pre Maintenance Window.
PreMaintenanceWindowEndTime *date.Time `json:"preMaintenanceWindowEndTime,omitempty"`
// MaintenanceWindowStartTime - Start Time for the Maintenance Window.
MaintenanceWindowStartTime *date.Time `json:"maintenanceWindowStartTime,omitempty"`
// MaintenanceWindowEndTime - End Time for the Maintenance Window.
MaintenanceWindowEndTime *date.Time `json:"maintenanceWindowEndTime,omitempty"`
// LastOperationResultCode - The Last Maintenance Operation Result Code. Possible values include: 'MaintenanceOperationResultCodeTypesNone', 'MaintenanceOperationResultCodeTypesRetryLater', 'MaintenanceOperationResultCodeTypesMaintenanceAborted', 'MaintenanceOperationResultCodeTypesMaintenanceCompleted'
LastOperationResultCode MaintenanceOperationResultCodeTypes `json:"lastOperationResultCode,omitempty"`
// LastOperationMessage - Message returned for the last Maintenance Operation.
LastOperationMessage *string `json:"lastOperationMessage,omitempty"`
}MaintenanceRedeployStatus maintenance Operation Status.
ManagedArtifact the managed artifact.
type ManagedDiskParameters struct {
// StorageAccountType - Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. Possible values include: 'StorageAccountTypesStandardLRS', 'StorageAccountTypesPremiumLRS', 'StorageAccountTypesStandardSSDLRS', 'StorageAccountTypesUltraSSDLRS'
StorageAccountType StorageAccountTypes `json:"storageAccountType,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}ManagedDiskParameters the parameters of a managed disk.
type NetworkInterfaceReference struct {
*NetworkInterfaceReferenceProperties `json:"properties,omitempty"`
// ID - Resource Id
ID *string `json:"id,omitempty"`
}NetworkInterfaceReference describes a network interface reference.
func (nir NetworkInterfaceReference) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for NetworkInterfaceReference.
func (nir *NetworkInterfaceReference) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for NetworkInterfaceReference struct.
type NetworkInterfaceReferenceProperties struct {
// Primary - Specifies the primary network interface in case the virtual machine has more than 1 network interface.
Primary *bool `json:"primary,omitempty"`
}NetworkInterfaceReferenceProperties describes a network interface reference properties.
type NetworkProfile struct {
// NetworkInterfaces - Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
NetworkInterfaces *[]NetworkInterfaceReference `json:"networkInterfaces,omitempty"`
}NetworkProfile specifies the network interfaces of the virtual machine.
type OSDisk struct {
// OsType - This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. <br><br> Possible values are: <br><br> **Windows** <br><br> **Linux**. Possible values include: 'Windows', 'Linux'
OsType OperatingSystemTypes `json:"osType,omitempty"`
// EncryptionSettings - Specifies the encryption settings for the OS Disk. <br><br> Minimum api-version: 2015-06-15
EncryptionSettings *DiskEncryptionSettings `json:"encryptionSettings,omitempty"`
// Name - The disk name.
Name *string `json:"name,omitempty"`
// Vhd - The virtual hard disk.
Vhd *VirtualHardDisk `json:"vhd,omitempty"`
// Image - The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
Image *VirtualHardDisk `json:"image,omitempty"`
// Caching - Specifies the caching requirements. <br><br> Possible values are: <br><br> **None** <br><br> **ReadOnly** <br><br> **ReadWrite** <br><br> Default: **None for Standard storage. ReadOnly for Premium storage**. Possible values include: 'CachingTypesNone', 'CachingTypesReadOnly', 'CachingTypesReadWrite'
Caching CachingTypes `json:"caching,omitempty"`
// WriteAcceleratorEnabled - Specifies whether writeAccelerator should be enabled or disabled on the disk.
WriteAcceleratorEnabled *bool `json:"writeAcceleratorEnabled,omitempty"`
// DiffDiskSettings - Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
DiffDiskSettings *DiffDiskSettings `json:"diffDiskSettings,omitempty"`
// CreateOption - Specifies how the virtual machine should be created.<br><br> Possible values are:<br><br> **Attach** \u2013 This value is used when you are using a specialized disk to create the virtual machine.<br><br> **FromImage** \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. Possible values include: 'DiskCreateOptionTypesFromImage', 'DiskCreateOptionTypesEmpty', 'DiskCreateOptionTypesAttach'
CreateOption DiskCreateOptionTypes `json:"createOption,omitempty"`
// DiskSizeGB - Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. <br><br> This value cannot be larger than 1023 GB
DiskSizeGB *int32 `json:"diskSizeGB,omitempty"`
// ManagedDisk - The managed disk parameters.
ManagedDisk *ManagedDiskParameters `json:"managedDisk,omitempty"`
}OSDisk specifies information about the operating system disk used by the virtual machine. <br><br> For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).
type OSDiskImage struct {
// OperatingSystem - The operating system of the osDiskImage. Possible values include: 'Windows', 'Linux'
OperatingSystem OperatingSystemTypes `json:"operatingSystem,omitempty"`
}OSDiskImage contains the os disk image information.
type OSProfile struct {
// ComputerName - Specifies the host OS name of the virtual machine. <br><br> This name cannot be updated after the VM is created. <br><br> **Max-length (Windows):** 15 characters <br><br> **Max-length (Linux):** 64 characters. <br><br> For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions).
ComputerName *string `json:"computerName,omitempty"`
// AdminUsername - Specifies the name of the administrator account. <br><br> **Windows-only restriction:** Cannot end in "." <br><br> **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". <br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters <br><br><li> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)<br><li> For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
AdminUsername *string `json:"adminUsername,omitempty"`
// AdminPassword - Specifies the password of the administrator account. <br><br> **Minimum-length (Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters <br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length (Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled <br> Has lower characters <br>Has upper characters <br> Has a digit <br> Has a special character (Regex match [\W_]) <br><br> **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" <br><br> For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)
AdminPassword *string `json:"adminPassword,omitempty"`
// CustomData - Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. <br><br> For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
CustomData *string `json:"customData,omitempty"`
// WindowsConfiguration - Specifies Windows operating system settings on the virtual machine.
WindowsConfiguration *WindowsConfiguration `json:"windowsConfiguration,omitempty"`
// LinuxConfiguration - Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) <br><br> For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json).
LinuxConfiguration *LinuxConfiguration `json:"linuxConfiguration,omitempty"`
// Secrets - Specifies set of certificates that should be installed onto the virtual machine.
Secrets *[]VaultSecretGroup `json:"secrets,omitempty"`
// AllowExtensionOperations - Specifies whether extension operations should be allowed on the virtual machine. <br><br>This may only be set to False when no extensions are present on the virtual machine.
AllowExtensionOperations *bool `json:"allowExtensionOperations,omitempty"`
}OSProfile specifies the operating system settings for the virtual machine.
OperatingSystemStateTypes enumerates the values for operating system state types.
const (
// Generalized ...
Generalized OperatingSystemStateTypes = "Generalized"
// Specialized ...
Specialized OperatingSystemStateTypes = "Specialized"
)func PossibleOperatingSystemStateTypesValues() []OperatingSystemStateTypes
PossibleOperatingSystemStateTypesValues returns an array of possible values for the OperatingSystemStateTypes const type.
OperatingSystemTypes enumerates the values for operating system types.
const (
// Linux ...
Linux OperatingSystemTypes = "Linux"
// Windows ...
Windows OperatingSystemTypes = "Windows"
)func PossibleOperatingSystemTypesValues() []OperatingSystemTypes
PossibleOperatingSystemTypesValues returns an array of possible values for the OperatingSystemTypes const type.
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of compute operations
Value *[]OperationValue `json:"value,omitempty"`
}OperationListResult the List Compute Operation operation response.
type OperationValue struct {
// Origin - READ-ONLY; The origin of the compute operation.
Origin *string `json:"origin,omitempty"`
// Name - READ-ONLY; The name of the compute operation.
Name *string `json:"name,omitempty"`
*OperationValueDisplay `json:"display,omitempty"`
}OperationValue describes the properties of a Compute Operation value.
func (ov OperationValue) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationValue.
func (ov *OperationValue) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OperationValue struct.
type OperationValueDisplay struct {
// Operation - READ-ONLY; The display name of the compute operation.
Operation *string `json:"operation,omitempty"`
// Resource - READ-ONLY; The display name of the resource the operation applies to.
Resource *string `json:"resource,omitempty"`
// Description - READ-ONLY; The description of the operation.
Description *string `json:"description,omitempty"`
// Provider - READ-ONLY; The resource provider for the operation.
Provider *string `json:"provider,omitempty"`
}OperationValueDisplay describes the properties of a Compute Operation Value Display.
type OperationsClient struct {
BaseClient
}OperationsClient is the compute Client
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
List gets a list of compute operations.
ListPreparer prepares the List request.
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
PassNames enumerates the values for pass names.
PossiblePassNamesValues returns an array of possible values for the PassNames const type.
type Plan struct {
// Name - The plan ID.
Name *string `json:"name,omitempty"`
// Publisher - The publisher ID.
Publisher *string `json:"publisher,omitempty"`
// Product - Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
Product *string `json:"product,omitempty"`
// PromotionCode - The promotion code.
PromotionCode *string `json:"promotionCode,omitempty"`
}Plan specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.
ProtocolTypes enumerates the values for protocol types.
const (
// HTTP ...
HTTP ProtocolTypes = "Http"
// HTTPS ...
HTTPS ProtocolTypes = "Https"
)func PossibleProtocolTypesValues() []ProtocolTypes
PossibleProtocolTypesValues returns an array of possible values for the ProtocolTypes const type.
ProvisioningState enumerates the values for provisioning state.
const (
// ProvisioningStateCreating ...
ProvisioningStateCreating ProvisioningState = "Creating"
// ProvisioningStateDeleting ...
ProvisioningStateDeleting ProvisioningState = "Deleting"
// ProvisioningStateFailed ...
ProvisioningStateFailed ProvisioningState = "Failed"
// ProvisioningStateMigrating ...
ProvisioningStateMigrating ProvisioningState = "Migrating"
// ProvisioningStateSucceeded ...
ProvisioningStateSucceeded ProvisioningState = "Succeeded"
// ProvisioningStateUpdating ...
ProvisioningStateUpdating ProvisioningState = "Updating"
)func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
ProvisioningState1 enumerates the values for provisioning state 1.
const (
// ProvisioningState1Creating ...
ProvisioningState1Creating ProvisioningState1 = "Creating"
// ProvisioningState1Deleting ...
ProvisioningState1Deleting ProvisioningState1 = "Deleting"
// ProvisioningState1Failed ...
ProvisioningState1Failed ProvisioningState1 = "Failed"
// ProvisioningState1Migrating ...
ProvisioningState1Migrating ProvisioningState1 = "Migrating"
// ProvisioningState1Succeeded ...
ProvisioningState1Succeeded ProvisioningState1 = "Succeeded"
// ProvisioningState1Updating ...
ProvisioningState1Updating ProvisioningState1 = "Updating"
)func PossibleProvisioningState1Values() []ProvisioningState1
PossibleProvisioningState1Values returns an array of possible values for the ProvisioningState1 const type.
ProvisioningState2 enumerates the values for provisioning state 2.
const (
// ProvisioningState2Creating ...
ProvisioningState2Creating ProvisioningState2 = "Creating"
// ProvisioningState2Deleting ...
ProvisioningState2Deleting ProvisioningState2 = "Deleting"
// ProvisioningState2Failed ...
ProvisioningState2Failed ProvisioningState2 = "Failed"
// ProvisioningState2Migrating ...
ProvisioningState2Migrating ProvisioningState2 = "Migrating"
// ProvisioningState2Succeeded ...
ProvisioningState2Succeeded ProvisioningState2 = "Succeeded"
// ProvisioningState2Updating ...
ProvisioningState2Updating ProvisioningState2 = "Updating"
)func PossibleProvisioningState2Values() []ProvisioningState2
PossibleProvisioningState2Values returns an array of possible values for the ProvisioningState2 const type.
type ProximityPlacementGroup struct {
autorest.Response `json:"-"`
// ProximityPlacementGroupProperties - Describes the properties of a Proximity Placement Group.
*ProximityPlacementGroupProperties `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"`
}ProximityPlacementGroup specifies information about the proximity placement group.
func (ppg ProximityPlacementGroup) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProximityPlacementGroup.
func (ppg *ProximityPlacementGroup) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ProximityPlacementGroup struct.
type ProximityPlacementGroupListResult struct {
autorest.Response `json:"-"`
// Value - The list of proximity placement groups
Value *[]ProximityPlacementGroup `json:"value,omitempty"`
// NextLink - The URI to fetch the next page of proximity placement groups.
NextLink *string `json:"nextLink,omitempty"`
}ProximityPlacementGroupListResult the List Proximity Placement Group operation response.
func (ppglr ProximityPlacementGroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ProximityPlacementGroupListResultIterator struct {
// contains filtered or unexported fields
}ProximityPlacementGroupListResultIterator provides access to a complete listing of ProximityPlacementGroup values.
func NewProximityPlacementGroupListResultIterator(page ProximityPlacementGroupListResultPage) ProximityPlacementGroupListResultIterator
Creates a new instance of the ProximityPlacementGroupListResultIterator type.
func (iter *ProximityPlacementGroupListResultIterator) 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 (iter *ProximityPlacementGroupListResultIterator) 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 (iter ProximityPlacementGroupListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ProximityPlacementGroupListResultIterator) Response() ProximityPlacementGroupListResult
Response returns the raw server response from the last page request.
func (iter ProximityPlacementGroupListResultIterator) Value() ProximityPlacementGroup
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ProximityPlacementGroupListResultPage struct {
// contains filtered or unexported fields
}ProximityPlacementGroupListResultPage contains a page of ProximityPlacementGroup values.
func NewProximityPlacementGroupListResultPage(cur ProximityPlacementGroupListResult, getNextPage func(context.Context, ProximityPlacementGroupListResult) (ProximityPlacementGroupListResult, error)) ProximityPlacementGroupListResultPage
Creates a new instance of the ProximityPlacementGroupListResultPage type.
func (page *ProximityPlacementGroupListResultPage) 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 (page *ProximityPlacementGroupListResultPage) 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 (page ProximityPlacementGroupListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ProximityPlacementGroupListResultPage) Response() ProximityPlacementGroupListResult
Response returns the raw server response from the last page request.
func (page ProximityPlacementGroupListResultPage) Values() []ProximityPlacementGroup
Values returns the slice of values for the current page or nil if there are no values.
type ProximityPlacementGroupProperties struct {
// ProximityPlacementGroupType - Specifies the type of the proximity placement group. <br><br> Possible values are: <br><br> **Standard** : Co-locate resources within an Azure region or Availability Zone. <br><br> **Ultra** : For future use. Possible values include: 'Standard', 'Ultra'
ProximityPlacementGroupType ProximityPlacementGroupType `json:"proximityPlacementGroupType,omitempty"`
// VirtualMachines - READ-ONLY; A list of references to all virtual machines in the proximity placement group.
VirtualMachines *[]SubResource `json:"virtualMachines,omitempty"`
// VirtualMachineScaleSets - READ-ONLY; A list of references to all virtual machine scale sets in the proximity placement group.
VirtualMachineScaleSets *[]SubResource `json:"virtualMachineScaleSets,omitempty"`
// AvailabilitySets - READ-ONLY; A list of references to all availability sets in the proximity placement group.
AvailabilitySets *[]SubResource `json:"availabilitySets,omitempty"`
}ProximityPlacementGroupProperties describes the properties of a Proximity Placement Group.
func (ppgp ProximityPlacementGroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProximityPlacementGroupProperties.
ProximityPlacementGroupType enumerates the values for proximity placement group type.
const (
// Standard ...
Standard ProximityPlacementGroupType = "Standard"
// Ultra ...
Ultra ProximityPlacementGroupType = "Ultra"
)func PossibleProximityPlacementGroupTypeValues() []ProximityPlacementGroupType
PossibleProximityPlacementGroupTypeValues returns an array of possible values for the ProximityPlacementGroupType const type.
type ProximityPlacementGroupUpdate struct {
// Tags - Resource tags
Tags map[string]*string `json:"tags"`
}ProximityPlacementGroupUpdate specifies information about the proximity placement group.
func (ppgu ProximityPlacementGroupUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProximityPlacementGroupUpdate.
type ProximityPlacementGroupsClient struct {
BaseClient
}ProximityPlacementGroupsClient is the compute Client
func NewProximityPlacementGroupsClient(subscriptionID string) ProximityPlacementGroupsClient
NewProximityPlacementGroupsClient creates an instance of the ProximityPlacementGroupsClient client.
func NewProximityPlacementGroupsClientWithBaseURI(baseURI string, subscriptionID string) ProximityPlacementGroupsClient
NewProximityPlacementGroupsClientWithBaseURI creates an instance of the ProximityPlacementGroupsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ProximityPlacementGroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string, parameters ProximityPlacementGroup) (result ProximityPlacementGroup, err error)
CreateOrUpdate create or update a proximity placement group. Parameters: resourceGroupName - the name of the resource group. proximityPlacementGroupName - the name of the proximity placement group. parameters - parameters supplied to the Create Proximity Placement Group operation.
func (client ProximityPlacementGroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, proximityPlacementGroupName string, parameters ProximityPlacementGroup) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ProximityPlacementGroupsClient) CreateOrUpdateResponder(resp *http.Response) (result ProximityPlacementGroup, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (client ProximityPlacementGroupsClient) 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 (client ProximityPlacementGroupsClient) Delete(ctx context.Context, resourceGroupName string, proximityPlacementGroupName